Interface NeptuneAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
Amazon Neptune is a fast, reliable, fully-managed graph database service that makes it easy to build and run applications that work with highly connected datasets. The core of Amazon Neptune is a purpose-built, high-performance graph database engine optimized for storing billions of relationships and querying the graph with milliseconds latency. Amazon Neptune supports popular graph models Property Graph and W3C's RDF, and their respective query languages Apache TinkerPop Gremlin and SPARQL, allowing you to easily build queries that efficiently navigate highly connected datasets. Neptune powers graph use cases such as recommendation engines, fraud detection, knowledge graphs, drug discovery, and network security.
This interface reference for Amazon Neptune contains documentation for a programming or command line interface you can use to manage Amazon Neptune. Note that Amazon Neptune is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionaddRoleToDBCluster
(Consumer<AddRoleToDbClusterRequest.Builder> addRoleToDbClusterRequest) Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.addRoleToDBCluster
(AddRoleToDbClusterRequest addRoleToDbClusterRequest) Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.addSourceIdentifierToSubscription
(Consumer<AddSourceIdentifierToSubscriptionRequest.Builder> addSourceIdentifierToSubscriptionRequest) Adds a source identifier to an existing event notification subscription.addSourceIdentifierToSubscription
(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) Adds a source identifier to an existing event notification subscription.addTagsToResource
(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) Adds metadata tags to an Amazon Neptune resource.addTagsToResource
(AddTagsToResourceRequest addTagsToResourceRequest) Adds metadata tags to an Amazon Neptune resource.applyPendingMaintenanceAction
(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest) Applies a pending maintenance action to a resource (for example, to a DB instance).applyPendingMaintenanceAction
(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) Applies a pending maintenance action to a resource (for example, to a DB instance).static NeptuneAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aNeptuneAsyncClient
.copyDBClusterParameterGroup
(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest) Copies the specified DB cluster parameter group.copyDBClusterParameterGroup
(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest) Copies the specified DB cluster parameter group.copyDBClusterSnapshot
(Consumer<CopyDbClusterSnapshotRequest.Builder> copyDbClusterSnapshotRequest) Copies a snapshot of a DB cluster.copyDBClusterSnapshot
(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest) Copies a snapshot of a DB cluster.copyDBParameterGroup
(Consumer<CopyDbParameterGroupRequest.Builder> copyDbParameterGroupRequest) Copies the specified DB parameter group.copyDBParameterGroup
(CopyDbParameterGroupRequest copyDbParameterGroupRequest) Copies the specified DB parameter group.static NeptuneAsyncClient
create()
Create aNeptuneAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateDbClusterResponse> createDBCluster
(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest) Creates a new Amazon Neptune DB cluster.default CompletableFuture
<CreateDbClusterResponse> createDBCluster
(CreateDbClusterRequest createDbClusterRequest) Creates a new Amazon Neptune DB cluster.createDBClusterEndpoint
(Consumer<CreateDbClusterEndpointRequest.Builder> createDbClusterEndpointRequest) Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.createDBClusterEndpoint
(CreateDbClusterEndpointRequest createDbClusterEndpointRequest) Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.createDBClusterParameterGroup
(Consumer<CreateDbClusterParameterGroupRequest.Builder> createDbClusterParameterGroupRequest) Creates a new DB cluster parameter group.createDBClusterParameterGroup
(CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest) Creates a new DB cluster parameter group.createDBClusterSnapshot
(Consumer<CreateDbClusterSnapshotRequest.Builder> createDbClusterSnapshotRequest) Creates a snapshot of a DB cluster.createDBClusterSnapshot
(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest) Creates a snapshot of a DB cluster.createDBInstance
(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest) Creates a new DB instance.createDBInstance
(CreateDbInstanceRequest createDbInstanceRequest) Creates a new DB instance.createDBParameterGroup
(Consumer<CreateDbParameterGroupRequest.Builder> createDbParameterGroupRequest) Creates a new DB parameter group.createDBParameterGroup
(CreateDbParameterGroupRequest createDbParameterGroupRequest) Creates a new DB parameter group.createDBSubnetGroup
(Consumer<CreateDbSubnetGroupRequest.Builder> createDbSubnetGroupRequest) Creates a new DB subnet group.createDBSubnetGroup
(CreateDbSubnetGroupRequest createDbSubnetGroupRequest) Creates a new DB subnet group.createEventSubscription
(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest) Creates an event notification subscription.createEventSubscription
(CreateEventSubscriptionRequest createEventSubscriptionRequest) Creates an event notification subscription.createGlobalCluster
(Consumer<CreateGlobalClusterRequest.Builder> createGlobalClusterRequest) Creates a Neptune global database spread across multiple Amazon Regions.createGlobalCluster
(CreateGlobalClusterRequest createGlobalClusterRequest) Creates a Neptune global database spread across multiple Amazon Regions.default CompletableFuture
<DeleteDbClusterResponse> deleteDBCluster
(Consumer<DeleteDbClusterRequest.Builder> deleteDbClusterRequest) The DeleteDBCluster action deletes a previously provisioned DB cluster.default CompletableFuture
<DeleteDbClusterResponse> deleteDBCluster
(DeleteDbClusterRequest deleteDbClusterRequest) The DeleteDBCluster action deletes a previously provisioned DB cluster.deleteDBClusterEndpoint
(Consumer<DeleteDbClusterEndpointRequest.Builder> deleteDbClusterEndpointRequest) Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.deleteDBClusterEndpoint
(DeleteDbClusterEndpointRequest deleteDbClusterEndpointRequest) Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.deleteDBClusterParameterGroup
(Consumer<DeleteDbClusterParameterGroupRequest.Builder> deleteDbClusterParameterGroupRequest) Deletes a specified DB cluster parameter group.deleteDBClusterParameterGroup
(DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest) Deletes a specified DB cluster parameter group.deleteDBClusterSnapshot
(Consumer<DeleteDbClusterSnapshotRequest.Builder> deleteDbClusterSnapshotRequest) Deletes a DB cluster snapshot.deleteDBClusterSnapshot
(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest) Deletes a DB cluster snapshot.deleteDBInstance
(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest) The DeleteDBInstance action deletes a previously provisioned DB instance.deleteDBInstance
(DeleteDbInstanceRequest deleteDbInstanceRequest) The DeleteDBInstance action deletes a previously provisioned DB instance.deleteDBParameterGroup
(Consumer<DeleteDbParameterGroupRequest.Builder> deleteDbParameterGroupRequest) Deletes a specified DBParameterGroup.deleteDBParameterGroup
(DeleteDbParameterGroupRequest deleteDbParameterGroupRequest) Deletes a specified DBParameterGroup.deleteDBSubnetGroup
(Consumer<DeleteDbSubnetGroupRequest.Builder> deleteDbSubnetGroupRequest) Deletes a DB subnet group.deleteDBSubnetGroup
(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest) Deletes a DB subnet group.deleteEventSubscription
(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest) Deletes an event notification subscription.deleteEventSubscription
(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) Deletes an event notification subscription.deleteGlobalCluster
(Consumer<DeleteGlobalClusterRequest.Builder> deleteGlobalClusterRequest) Deletes a global database.deleteGlobalCluster
(DeleteGlobalClusterRequest deleteGlobalClusterRequest) Deletes a global database.describeDBClusterEndpoints
(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest) Returns information about endpoints for an Amazon Neptune DB cluster.describeDBClusterEndpoints
(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest) Returns information about endpoints for an Amazon Neptune DB cluster.describeDBClusterEndpointsPaginator
(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest) This is a variant ofdescribeDBClusterEndpoints(software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsRequest)
operation.describeDBClusterEndpointsPaginator
(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest) This is a variant ofdescribeDBClusterEndpoints(software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsRequest)
operation.Returns a list ofDBClusterParameterGroup
descriptions.describeDBClusterParameterGroups
(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) Returns a list ofDBClusterParameterGroup
descriptions.describeDBClusterParameterGroups
(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) Returns a list ofDBClusterParameterGroup
descriptions.This is a variant ofdescribeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)
operation.describeDBClusterParameterGroupsPaginator
(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) This is a variant ofdescribeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)
operation.describeDBClusterParameterGroupsPaginator
(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) This is a variant ofdescribeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)
operation.describeDBClusterParameters
(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) Returns the detailed parameter list for a particular DB cluster parameter group.describeDBClusterParameters
(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) Returns the detailed parameter list for a particular DB cluster parameter group.describeDBClusterParametersPaginator
(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) This is a variant ofdescribeDBClusterParameters(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersRequest)
operation.describeDBClusterParametersPaginator
(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) This is a variant ofdescribeDBClusterParameters(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersRequest)
operation.Returns information about provisioned DB clusters, and supports pagination.describeDBClusters
(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) Returns information about provisioned DB clusters, and supports pagination.describeDBClusters
(DescribeDbClustersRequest describeDbClustersRequest) Returns information about provisioned DB clusters, and supports pagination.describeDBClusterSnapshotAttributes
(Consumer<DescribeDbClusterSnapshotAttributesRequest.Builder> describeDbClusterSnapshotAttributesRequest) Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.describeDBClusterSnapshotAttributes
(DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest) Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.Returns information about DB cluster snapshots.describeDBClusterSnapshots
(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) Returns information about DB cluster snapshots.describeDBClusterSnapshots
(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) Returns information about DB cluster snapshots.This is a variant ofdescribeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)
operation.describeDBClusterSnapshotsPaginator
(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) This is a variant ofdescribeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)
operation.describeDBClusterSnapshotsPaginator
(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) This is a variant ofdescribeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)
operation.default DescribeDBClustersPublisher
This is a variant ofdescribeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)
operation.default DescribeDBClustersPublisher
describeDBClustersPaginator
(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) This is a variant ofdescribeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)
operation.default DescribeDBClustersPublisher
describeDBClustersPaginator
(DescribeDbClustersRequest describeDbClustersRequest) This is a variant ofdescribeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)
operation.Returns a list of the available DB engines.describeDBEngineVersions
(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) Returns a list of the available DB engines.describeDBEngineVersions
(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) Returns a list of the available DB engines.This is a variant ofdescribeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation.describeDBEngineVersionsPaginator
(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) This is a variant ofdescribeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation.describeDBEngineVersionsPaginator
(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) This is a variant ofdescribeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation.Returns information about provisioned instances, and supports pagination.describeDBInstances
(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) Returns information about provisioned instances, and supports pagination.describeDBInstances
(DescribeDbInstancesRequest describeDbInstancesRequest) Returns information about provisioned instances, and supports pagination.default DescribeDBInstancesPublisher
This is a variant ofdescribeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation.default DescribeDBInstancesPublisher
describeDBInstancesPaginator
(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) This is a variant ofdescribeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation.default DescribeDBInstancesPublisher
describeDBInstancesPaginator
(DescribeDbInstancesRequest describeDbInstancesRequest) This is a variant ofdescribeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation.Returns a list ofDBParameterGroup
descriptions.describeDBParameterGroups
(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) Returns a list ofDBParameterGroup
descriptions.describeDBParameterGroups
(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) Returns a list ofDBParameterGroup
descriptions.This is a variant ofdescribeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation.describeDBParameterGroupsPaginator
(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) This is a variant ofdescribeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation.describeDBParameterGroupsPaginator
(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) This is a variant ofdescribeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation.describeDBParameters
(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) Returns the detailed parameter list for a particular DB parameter group.describeDBParameters
(DescribeDbParametersRequest describeDbParametersRequest) Returns the detailed parameter list for a particular DB parameter group.default DescribeDBParametersPublisher
describeDBParametersPaginator
(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) This is a variant ofdescribeDBParameters(software.amazon.awssdk.services.neptune.model.DescribeDbParametersRequest)
operation.default DescribeDBParametersPublisher
describeDBParametersPaginator
(DescribeDbParametersRequest describeDbParametersRequest) This is a variant ofdescribeDBParameters(software.amazon.awssdk.services.neptune.model.DescribeDbParametersRequest)
operation.Returns a list of DBSubnetGroup descriptions.describeDBSubnetGroups
(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions.describeDBSubnetGroups
(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions.default DescribeDBSubnetGroupsPublisher
This is a variant ofdescribeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation.default DescribeDBSubnetGroupsPublisher
describeDBSubnetGroupsPaginator
(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) This is a variant ofdescribeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation.default DescribeDBSubnetGroupsPublisher
describeDBSubnetGroupsPaginator
(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) This is a variant ofdescribeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation.describeEngineDefaultClusterParameters
(Consumer<DescribeEngineDefaultClusterParametersRequest.Builder> describeEngineDefaultClusterParametersRequest) Returns the default engine and system parameter information for the cluster database engine.describeEngineDefaultClusterParameters
(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) Returns the default engine and system parameter information for the cluster database engine.describeEngineDefaultParameters
(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) Returns the default engine and system parameter information for the specified database engine.describeEngineDefaultParameters
(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) Returns the default engine and system parameter information for the specified database engine.describeEngineDefaultParametersPaginator
(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) This is a variant ofdescribeEngineDefaultParameters(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersRequest)
operation.describeEngineDefaultParametersPaginator
(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) This is a variant ofdescribeEngineDefaultParameters(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersRequest)
operation.Displays a list of categories for all event source types, or, if specified, for a specified source type.describeEventCategories
(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest) Displays a list of categories for all event source types, or, if specified, for a specified source type.describeEventCategories
(DescribeEventCategoriesRequest describeEventCategoriesRequest) Displays a list of categories for all event source types, or, if specified, for a specified source type.default CompletableFuture
<DescribeEventsResponse> Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days.default CompletableFuture
<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 CompletableFuture
<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 DescribeEventsPublisher
This is a variant ofdescribeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation.default DescribeEventsPublisher
describeEventsPaginator
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation.default DescribeEventsPublisher
describeEventsPaginator
(DescribeEventsRequest describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation.Lists all the subscription descriptions for a customer account.describeEventSubscriptions
(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) Lists all the subscription descriptions for a customer account.describeEventSubscriptions
(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) Lists all the subscription descriptions for a customer account.This is a variant ofdescribeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation.describeEventSubscriptionsPaginator
(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) This is a variant ofdescribeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation.describeEventSubscriptionsPaginator
(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) This is a variant ofdescribeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation.describeGlobalClusters
(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) Returns information about Neptune global database clusters.describeGlobalClusters
(DescribeGlobalClustersRequest describeGlobalClustersRequest) Returns information about Neptune global database clusters.default DescribeGlobalClustersPublisher
describeGlobalClustersPaginator
(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) This is a variant ofdescribeGlobalClusters(software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersRequest)
operation.default DescribeGlobalClustersPublisher
describeGlobalClustersPaginator
(DescribeGlobalClustersRequest describeGlobalClustersRequest) This is a variant ofdescribeGlobalClusters(software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersRequest)
operation.describeOrderableDBInstanceOptions
(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) Returns a list of orderable DB instance options for the specified engine.describeOrderableDBInstanceOptions
(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) Returns a list of orderable DB instance options for the specified engine.describeOrderableDBInstanceOptionsPaginator
(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) This is a variant ofdescribeOrderableDBInstanceOptions(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsRequest)
operation.describeOrderableDBInstanceOptionsPaginator
(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) This is a variant ofdescribeOrderableDBInstanceOptions(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsRequest)
operation.Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.describePendingMaintenanceActions
(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.describePendingMaintenanceActions
(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.This is a variant ofdescribePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)
operation.describePendingMaintenanceActionsPaginator
(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) This is a variant ofdescribePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)
operation.describePendingMaintenanceActionsPaginator
(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) This is a variant ofdescribePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)
operation.describeValidDBInstanceModifications
(Consumer<DescribeValidDbInstanceModificationsRequest.Builder> describeValidDbInstanceModificationsRequest) You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance.describeValidDBInstanceModifications
(DescribeValidDbInstanceModificationsRequest describeValidDbInstanceModificationsRequest) You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance.failoverDBCluster
(Consumer<FailoverDbClusterRequest.Builder> failoverDbClusterRequest) Forces a failover for a DB cluster.failoverDBCluster
(FailoverDbClusterRequest failoverDbClusterRequest) Forces a failover for a DB cluster.failoverGlobalCluster
(Consumer<FailoverGlobalClusterRequest.Builder> failoverGlobalClusterRequest) Initiates the failover process for a Neptune global database.failoverGlobalCluster
(FailoverGlobalClusterRequest failoverGlobalClusterRequest) Initiates the failover process for a Neptune global database.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all tags on an Amazon Neptune resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags on an Amazon Neptune resource.default CompletableFuture
<ModifyDbClusterResponse> modifyDBCluster
(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest) Modify a setting for a DB cluster.default CompletableFuture
<ModifyDbClusterResponse> modifyDBCluster
(ModifyDbClusterRequest modifyDbClusterRequest) Modify a setting for a DB cluster.modifyDBClusterEndpoint
(Consumer<ModifyDbClusterEndpointRequest.Builder> modifyDbClusterEndpointRequest) Modifies the properties of an endpoint in an Amazon Neptune DB cluster.modifyDBClusterEndpoint
(ModifyDbClusterEndpointRequest modifyDbClusterEndpointRequest) Modifies the properties of an endpoint in an Amazon Neptune DB cluster.modifyDBClusterParameterGroup
(Consumer<ModifyDbClusterParameterGroupRequest.Builder> modifyDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group.modifyDBClusterParameterGroup
(ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group.modifyDBClusterSnapshotAttribute
(Consumer<ModifyDbClusterSnapshotAttributeRequest.Builder> modifyDbClusterSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.modifyDBClusterSnapshotAttribute
(ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.modifyDBInstance
(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest) Modifies settings for a DB instance.modifyDBInstance
(ModifyDbInstanceRequest modifyDbInstanceRequest) Modifies settings for a DB instance.modifyDBParameterGroup
(Consumer<ModifyDbParameterGroupRequest.Builder> modifyDbParameterGroupRequest) Modifies the parameters of a DB parameter group.modifyDBParameterGroup
(ModifyDbParameterGroupRequest modifyDbParameterGroupRequest) Modifies the parameters of a DB parameter group.modifyDBSubnetGroup
(Consumer<ModifyDbSubnetGroupRequest.Builder> modifyDbSubnetGroupRequest) Modifies an existing DB subnet group.modifyDBSubnetGroup
(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest) Modifies an existing DB subnet group.modifyEventSubscription
(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest) Modifies an existing event notification subscription.modifyEventSubscription
(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) Modifies an existing event notification subscription.modifyGlobalCluster
(Consumer<ModifyGlobalClusterRequest.Builder> modifyGlobalClusterRequest) Modify a setting for an Amazon Neptune global cluster.modifyGlobalCluster
(ModifyGlobalClusterRequest modifyGlobalClusterRequest) Modify a setting for an Amazon Neptune global cluster.promoteReadReplicaDBCluster
(Consumer<PromoteReadReplicaDbClusterRequest.Builder> promoteReadReplicaDbClusterRequest) Not supported.promoteReadReplicaDBCluster
(PromoteReadReplicaDbClusterRequest promoteReadReplicaDbClusterRequest) Not supported.rebootDBInstance
(Consumer<RebootDbInstanceRequest.Builder> rebootDbInstanceRequest) You might need to reboot your DB instance, usually for maintenance reasons.rebootDBInstance
(RebootDbInstanceRequest rebootDbInstanceRequest) You might need to reboot your DB instance, usually for maintenance reasons.removeFromGlobalCluster
(Consumer<RemoveFromGlobalClusterRequest.Builder> removeFromGlobalClusterRequest) Detaches a Neptune DB cluster from a Neptune global database.removeFromGlobalCluster
(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest) Detaches a Neptune DB cluster from a Neptune global database.removeRoleFromDBCluster
(Consumer<RemoveRoleFromDbClusterRequest.Builder> removeRoleFromDbClusterRequest) Disassociates an Identity and Access Management (IAM) role from a DB cluster.removeRoleFromDBCluster
(RemoveRoleFromDbClusterRequest removeRoleFromDbClusterRequest) Disassociates an Identity and Access Management (IAM) role from a DB cluster.removeSourceIdentifierFromSubscription
(Consumer<RemoveSourceIdentifierFromSubscriptionRequest.Builder> removeSourceIdentifierFromSubscriptionRequest) Removes a source identifier from an existing event notification subscription.removeSourceIdentifierFromSubscription
(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) Removes a source identifier from an existing event notification subscription.removeTagsFromResource
(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) Removes metadata tags from an Amazon Neptune resource.removeTagsFromResource
(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes metadata tags from an Amazon Neptune resource.resetDBClusterParameterGroup
(Consumer<ResetDbClusterParameterGroupRequest.Builder> resetDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group to the default value.resetDBClusterParameterGroup
(ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group to the default value.resetDBParameterGroup
(Consumer<ResetDbParameterGroupRequest.Builder> resetDbParameterGroupRequest) Modifies the parameters of a DB parameter group to the engine/system default value.resetDBParameterGroup
(ResetDbParameterGroupRequest resetDbParameterGroupRequest) Modifies the parameters of a DB parameter group to the engine/system default value.restoreDBClusterFromSnapshot
(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest) Creates a new DB cluster from a DB snapshot or DB cluster snapshot.restoreDBClusterFromSnapshot
(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest) Creates a new DB cluster from a DB snapshot or DB cluster snapshot.restoreDBClusterToPointInTime
(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest) Restores a DB cluster to an arbitrary point in time.restoreDBClusterToPointInTime
(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest) Restores a DB cluster to an arbitrary point in time.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<StartDbClusterResponse> startDBCluster
(Consumer<StartDbClusterRequest.Builder> startDbClusterRequest) Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.default CompletableFuture
<StartDbClusterResponse> startDBCluster
(StartDbClusterRequest startDbClusterRequest) Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.default CompletableFuture
<StopDbClusterResponse> stopDBCluster
(Consumer<StopDbClusterRequest.Builder> stopDbClusterRequest) Stops an Amazon Neptune DB cluster.default CompletableFuture
<StopDbClusterResponse> stopDBCluster
(StopDbClusterRequest stopDbClusterRequest) Stops an Amazon Neptune DB cluster.default NeptuneAsyncWaiter
waiter()
Create an instance ofNeptuneAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
addRoleToDBCluster
default CompletableFuture<AddRoleToDbClusterResponse> addRoleToDBCluster(AddRoleToDbClusterRequest addRoleToDbClusterRequest) Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.
- Parameters:
addRoleToDbClusterRequest
-- Returns:
- A Java Future containing the result of the AddRoleToDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
addRoleToDBCluster
default CompletableFuture<AddRoleToDbClusterResponse> addRoleToDBCluster(Consumer<AddRoleToDbClusterRequest.Builder> addRoleToDbClusterRequest) Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.
This is a convenience which creates an instance of the
AddRoleToDbClusterRequest.Builder
avoiding the need to create one manually viaAddRoleToDbClusterRequest.builder()
- Parameters:
addRoleToDbClusterRequest
- AConsumer
that will call methods onAddRoleToDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AddRoleToDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
addSourceIdentifierToSubscription
default CompletableFuture<AddSourceIdentifierToSubscriptionResponse> addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) Adds a source identifier to an existing event notification subscription.
- Parameters:
addSourceIdentifierToSubscriptionRequest
-- Returns:
- A Java Future containing the result of the AddSourceIdentifierToSubscription operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException The designated subscription could not be found.
- SourceNotFoundException The source could not be 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.
- See Also:
-
addSourceIdentifierToSubscription
default CompletableFuture<AddSourceIdentifierToSubscriptionResponse> addSourceIdentifierToSubscription(Consumer<AddSourceIdentifierToSubscriptionRequest.Builder> addSourceIdentifierToSubscriptionRequest) 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 viaAddSourceIdentifierToSubscriptionRequest.builder()
- Parameters:
addSourceIdentifierToSubscriptionRequest
- AConsumer
that will call methods onAddSourceIdentifierToSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AddSourceIdentifierToSubscription operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException The designated subscription could not be found.
- SourceNotFoundException The source could not be 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.
- See Also:
-
addTagsToResource
default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) Adds metadata tags to an Amazon Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune.
- Parameters:
addTagsToResourceRequest
-- Returns:
- A Java Future containing the result of the AddTagsToResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
addTagsToResource
default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) Adds metadata tags to an Amazon Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune.
This is a convenience which creates an instance of the
AddTagsToResourceRequest.Builder
avoiding the need to create one manually viaAddTagsToResourceRequest.builder()
- Parameters:
addTagsToResourceRequest
- AConsumer
that will call methods onAddTagsToResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AddTagsToResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
applyPendingMaintenanceAction
default CompletableFuture<ApplyPendingMaintenanceActionResponse> applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) Applies a pending maintenance action to a resource (for example, to a DB instance).
- Parameters:
applyPendingMaintenanceActionRequest
-- Returns:
- A Java Future containing the result of the ApplyPendingMaintenanceAction operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
applyPendingMaintenanceAction
default CompletableFuture<ApplyPendingMaintenanceActionResponse> applyPendingMaintenanceAction(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest) 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 viaApplyPendingMaintenanceActionRequest.builder()
- Parameters:
applyPendingMaintenanceActionRequest
- AConsumer
that will call methods onApplyPendingMaintenanceActionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ApplyPendingMaintenanceAction operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
copyDBClusterParameterGroup
default CompletableFuture<CopyDbClusterParameterGroupResponse> copyDBClusterParameterGroup(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest) Copies the specified DB cluster parameter group.
- Parameters:
copyDbClusterParameterGroupRequest
-- Returns:
- A Java Future containing the result of the CopyDBClusterParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
copyDBClusterParameterGroup
default CompletableFuture<CopyDbClusterParameterGroupResponse> copyDBClusterParameterGroup(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest) 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 viaCopyDbClusterParameterGroupRequest.builder()
- Parameters:
copyDbClusterParameterGroupRequest
- AConsumer
that will call methods onCopyDbClusterParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CopyDBClusterParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
copyDBClusterSnapshot
default CompletableFuture<CopyDbClusterSnapshotResponse> copyDBClusterSnapshot(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest) Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot,
SourceDBClusterSnapshotIdentifier
must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.- Parameters:
copyDbClusterSnapshotRequest
-- Returns:
- A Java Future containing the result of the CopyDBClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
copyDBClusterSnapshot
default CompletableFuture<CopyDbClusterSnapshotResponse> copyDBClusterSnapshot(Consumer<CopyDbClusterSnapshotRequest.Builder> copyDbClusterSnapshotRequest) Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot,
SourceDBClusterSnapshotIdentifier
must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
This is a convenience which creates an instance of the
CopyDbClusterSnapshotRequest.Builder
avoiding the need to create one manually viaCopyDbClusterSnapshotRequest.builder()
- Parameters:
copyDbClusterSnapshotRequest
- AConsumer
that will call methods onCopyDbClusterSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CopyDBClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
copyDBParameterGroup
default CompletableFuture<CopyDbParameterGroupResponse> copyDBParameterGroup(CopyDbParameterGroupRequest copyDbParameterGroupRequest) Copies the specified DB parameter group.
- Parameters:
copyDbParameterGroupRequest
-- Returns:
- A Java Future containing the result of the CopyDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
copyDBParameterGroup
default CompletableFuture<CopyDbParameterGroupResponse> copyDBParameterGroup(Consumer<CopyDbParameterGroupRequest.Builder> copyDbParameterGroupRequest) 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 viaCopyDbParameterGroupRequest.builder()
- Parameters:
copyDbParameterGroupRequest
- AConsumer
that will call methods onCopyDbParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CopyDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createDBCluster
default CompletableFuture<CreateDbClusterResponse> createDBCluster(CreateDbClusterRequest createDbClusterRequest) Creates a new Amazon Neptune DB cluster.
You can use the
ReplicationSourceIdentifier
parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance.Note that when you create a new cluster using
CreateDBCluster
directly, deletion protection is disabled by default (when you create a new production cluster in the console, deletion protection is enabled by default). You can only delete a DB cluster if itsDeletionProtection
field is set tofalse
.- Parameters:
createDbClusterRequest
-- Returns:
- A Java Future containing the result of the CreateDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested 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.
- See Also:
-
createDBCluster
default CompletableFuture<CreateDbClusterResponse> createDBCluster(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest) Creates a new Amazon Neptune DB cluster.
You can use the
ReplicationSourceIdentifier
parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance.Note that when you create a new cluster using
CreateDBCluster
directly, deletion protection is disabled by default (when you create a new production cluster in the console, deletion protection is enabled by default). You can only delete a DB cluster if itsDeletionProtection
field is set tofalse
.
This is a convenience which creates an instance of the
CreateDbClusterRequest.Builder
avoiding the need to create one manually viaCreateDbClusterRequest.builder()
- Parameters:
createDbClusterRequest
- AConsumer
that will call methods onCreateDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested 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.
- See Also:
-
createDBClusterEndpoint
default CompletableFuture<CreateDbClusterEndpointResponse> createDBClusterEndpoint(CreateDbClusterEndpointRequest createDbClusterEndpointRequest) Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.
- Parameters:
createDbClusterEndpointRequest
-- Returns:
- A Java Future containing the result of the CreateDBClusterEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterEndpointQuotaExceededException The cluster already has the maximum number of custom endpoints.
- DbClusterEndpointAlreadyExistsException The specified custom endpoint cannot be created because it already exists.
- DbClusterNotFoundException DBClusterIdentifier does not refer to an existing DB cluster.
- InvalidDbClusterStateException The DB cluster is not in a valid state.
- DbInstanceNotFoundException DBInstanceIdentifier does not refer to an existing DB instance.
- InvalidDbInstanceStateException The specified DB instance is not in the available state.
- 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.
- See Also:
-
createDBClusterEndpoint
default CompletableFuture<CreateDbClusterEndpointResponse> createDBClusterEndpoint(Consumer<CreateDbClusterEndpointRequest.Builder> createDbClusterEndpointRequest) Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.
This is a convenience which creates an instance of the
CreateDbClusterEndpointRequest.Builder
avoiding the need to create one manually viaCreateDbClusterEndpointRequest.builder()
- Parameters:
createDbClusterEndpointRequest
- AConsumer
that will call methods onCreateDbClusterEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBClusterEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterEndpointQuotaExceededException The cluster already has the maximum number of custom endpoints.
- DbClusterEndpointAlreadyExistsException The specified custom endpoint cannot be created because it already exists.
- DbClusterNotFoundException DBClusterIdentifier does not refer to an existing DB cluster.
- InvalidDbClusterStateException The DB cluster is not in a valid state.
- DbInstanceNotFoundException DBInstanceIdentifier does not refer to an existing DB instance.
- InvalidDbInstanceStateException The specified DB instance is not in the available state.
- 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.
- See Also:
-
createDBClusterParameterGroup
default CompletableFuture<CreateDbClusterParameterGroupResponse> createDBClusterParameterGroup(CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest) Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.- Parameters:
createDbClusterParameterGroupRequest
-- Returns:
- A Java Future containing the result of the CreateDBClusterParameterGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createDBClusterParameterGroup
default CompletableFuture<CreateDbClusterParameterGroupResponse> createDBClusterParameterGroup(Consumer<CreateDbClusterParameterGroupRequest.Builder> createDbClusterParameterGroupRequest) Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
This is a convenience which creates an instance of the
CreateDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually viaCreateDbClusterParameterGroupRequest.builder()
- Parameters:
createDbClusterParameterGroupRequest
- AConsumer
that will call methods onCreateDbClusterParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBClusterParameterGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createDBClusterSnapshot
default CompletableFuture<CreateDbClusterSnapshotResponse> createDBClusterSnapshot(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest) Creates a snapshot of a DB cluster.
- Parameters:
createDbClusterSnapshotRequest
-- Returns:
- A Java Future containing the result of the CreateDBClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createDBClusterSnapshot
default CompletableFuture<CreateDbClusterSnapshotResponse> createDBClusterSnapshot(Consumer<CreateDbClusterSnapshotRequest.Builder> createDbClusterSnapshotRequest) 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 viaCreateDbClusterSnapshotRequest.builder()
- Parameters:
createDbClusterSnapshotRequest
- AConsumer
that will call methods onCreateDbClusterSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createDBInstance
default CompletableFuture<CreateDbInstanceResponse> createDBInstance(CreateDbInstanceRequest createDbInstanceRequest) Creates a new DB instance.
- Parameters:
createDbInstanceRequest
-- Returns:
- A Java Future containing the result of the CreateDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceAlreadyExistsException User already has a DB instance with the given identifier.
- InsufficientDbInstanceCapacityException Specified DB instance class is not available in the specified Availability Zone.
- DbParameterGroupNotFoundException DBParameterGroupName does not refer to an existing DB parameter group.
- DbSecurityGroupNotFoundException DBSecurityGroupName does not refer to an existing DB security group.
- InstanceQuotaExceededException Request would result in user exceeding the allowed number of DB instances.
- StorageQuotaExceededException Request would result in user exceeding the allowed amount of storage available across all DB instances.
- DbSubnetGroupNotFoundException DBSubnetGroupName does not refer to an existing DB subnet group.
- DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidDbClusterStateException The DB cluster is not in a valid state.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVpcNetworkStateException DB subnet group does not cover all Availability Zones after it is created because users' change.
- ProvisionedIopsNotAvailableInAzException Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundException The designated option group could not be found.
- DbClusterNotFoundException DBClusterIdentifier does not refer to an existing DB cluster.
- StorageTypeNotSupportedException StorageType specified cannot be associated with the DB Instance.
- AuthorizationNotFoundException Specified CIDRIP or EC2 security group is not authorized for the
specified DB security group.
Neptune may not also be authorized via IAM to perform necessary actions on your behalf.
- KmsKeyNotAccessibleException Error accessing KMS key.
- DomainNotFoundException Domain does not refer to an existing Active Directory Domain.
- 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.
- See Also:
-
createDBInstance
default CompletableFuture<CreateDbInstanceResponse> createDBInstance(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest) Creates a new DB instance.
This is a convenience which creates an instance of the
CreateDbInstanceRequest.Builder
avoiding the need to create one manually viaCreateDbInstanceRequest.builder()
- Parameters:
createDbInstanceRequest
- AConsumer
that will call methods onCreateDbInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceAlreadyExistsException User already has a DB instance with the given identifier.
- InsufficientDbInstanceCapacityException Specified DB instance class is not available in the specified Availability Zone.
- DbParameterGroupNotFoundException DBParameterGroupName does not refer to an existing DB parameter group.
- DbSecurityGroupNotFoundException DBSecurityGroupName does not refer to an existing DB security group.
- InstanceQuotaExceededException Request would result in user exceeding the allowed number of DB instances.
- StorageQuotaExceededException Request would result in user exceeding the allowed amount of storage available across all DB instances.
- DbSubnetGroupNotFoundException DBSubnetGroupName does not refer to an existing DB subnet group.
- DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidDbClusterStateException The DB cluster is not in a valid state.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVpcNetworkStateException DB subnet group does not cover all Availability Zones after it is created because users' change.
- ProvisionedIopsNotAvailableInAzException Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundException The designated option group could not be found.
- DbClusterNotFoundException DBClusterIdentifier does not refer to an existing DB cluster.
- StorageTypeNotSupportedException StorageType specified cannot be associated with the DB Instance.
- AuthorizationNotFoundException Specified CIDRIP or EC2 security group is not authorized for the
specified DB security group.
Neptune may not also be authorized via IAM to perform necessary actions on your behalf.
- KmsKeyNotAccessibleException Error accessing KMS key.
- DomainNotFoundException Domain does not refer to an existing Active Directory Domain.
- 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.
- See Also:
-
createDBParameterGroup
default CompletableFuture<CreateDbParameterGroupResponse> createDBParameterGroup(CreateDbParameterGroupRequest createDbParameterGroupRequest) Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.- Parameters:
createDbParameterGroupRequest
-- Returns:
- A Java Future containing the result of the CreateDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createDBParameterGroup
default CompletableFuture<CreateDbParameterGroupResponse> createDBParameterGroup(Consumer<CreateDbParameterGroupRequest.Builder> createDbParameterGroupRequest) Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
This is a convenience which creates an instance of the
CreateDbParameterGroupRequest.Builder
avoiding the need to create one manually viaCreateDbParameterGroupRequest.builder()
- Parameters:
createDbParameterGroupRequest
- AConsumer
that will call methods onCreateDbParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createDBSubnetGroup
default CompletableFuture<CreateDbSubnetGroupResponse> createDBSubnetGroup(CreateDbSubnetGroupRequest createDbSubnetGroupRequest) Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.
- Parameters:
createDbSubnetGroupRequest
-- Returns:
- A Java Future containing the result of the CreateDBSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createDBSubnetGroup
default CompletableFuture<CreateDbSubnetGroupResponse> createDBSubnetGroup(Consumer<CreateDbSubnetGroupRequest.Builder> createDbSubnetGroupRequest) Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.
This is a convenience which creates an instance of the
CreateDbSubnetGroupRequest.Builder
avoiding the need to create one manually viaCreateDbSubnetGroupRequest.builder()
- Parameters:
createDbSubnetGroupRequest
- AConsumer
that will call methods onCreateDbSubnetGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createEventSubscription
default CompletableFuture<CreateEventSubscriptionResponse> createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.
- Parameters:
createEventSubscriptionRequest
-- Returns:
- A Java Future containing the result of the CreateEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EventSubscriptionQuotaExceededException You have exceeded the number of events you can subscribe to.
- SubscriptionAlreadyExistException This subscription already exists.
- SnsInvalidTopicException The SNS topic is invalid.
- SnsNoAuthorizationException There is no SNS authorization.
- SnsTopicArnNotFoundException The ARN of the SNS topic could not be found.
- SubscriptionCategoryNotFoundException The designated subscription category could not be found.
- SourceNotFoundException The source could not be found.
- 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.
- See Also:
-
createEventSubscription
default CompletableFuture<CreateEventSubscriptionResponse> createEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest) Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.
This is a convenience which creates an instance of the
CreateEventSubscriptionRequest.Builder
avoiding the need to create one manually viaCreateEventSubscriptionRequest.builder()
- Parameters:
createEventSubscriptionRequest
- AConsumer
that will call methods onCreateEventSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EventSubscriptionQuotaExceededException You have exceeded the number of events you can subscribe to.
- SubscriptionAlreadyExistException This subscription already exists.
- SnsInvalidTopicException The SNS topic is invalid.
- SnsNoAuthorizationException There is no SNS authorization.
- SnsTopicArnNotFoundException The ARN of the SNS topic could not be found.
- SubscriptionCategoryNotFoundException The designated subscription category could not be found.
- SourceNotFoundException The source could not be found.
- 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.
- See Also:
-
createGlobalCluster
default CompletableFuture<CreateGlobalClusterResponse> createGlobalCluster(CreateGlobalClusterRequest createGlobalClusterRequest) Creates a Neptune global database spread across multiple Amazon Regions. The global database contains a single primary cluster with read-write capability, and read-only secondary clusters that receive data from the primary cluster through high-speed replication performed by the Neptune storage subsystem.
You can create a global database that is initially empty, and then add a primary cluster and secondary clusters to it, or you can specify an existing Neptune cluster during the create operation to become the primary cluster of the global database.
- Parameters:
createGlobalClusterRequest
-- Returns:
- A Java Future containing the result of the CreateGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterAlreadyExistsException The
GlobalClusterIdentifier
already exists. Choose a new global database identifier (unique name) to create a new global database cluster. - GlobalClusterQuotaExceededException The number of global database clusters for this account is already at the maximum allowed.
- InvalidDbClusterStateException The DB cluster is not in a valid state.
- 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.
- GlobalClusterAlreadyExistsException The
- See Also:
-
createGlobalCluster
default CompletableFuture<CreateGlobalClusterResponse> createGlobalCluster(Consumer<CreateGlobalClusterRequest.Builder> createGlobalClusterRequest) Creates a Neptune global database spread across multiple Amazon Regions. The global database contains a single primary cluster with read-write capability, and read-only secondary clusters that receive data from the primary cluster through high-speed replication performed by the Neptune storage subsystem.
You can create a global database that is initially empty, and then add a primary cluster and secondary clusters to it, or you can specify an existing Neptune cluster during the create operation to become the primary cluster of the global database.
This is a convenience which creates an instance of the
CreateGlobalClusterRequest.Builder
avoiding the need to create one manually viaCreateGlobalClusterRequest.builder()
- Parameters:
createGlobalClusterRequest
- AConsumer
that will call methods onCreateGlobalClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterAlreadyExistsException The
GlobalClusterIdentifier
already exists. Choose a new global database identifier (unique name) to create a new global database cluster. - GlobalClusterQuotaExceededException The number of global database clusters for this account is already at the maximum allowed.
- InvalidDbClusterStateException The DB cluster is not in a valid state.
- 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.
- GlobalClusterAlreadyExistsException The
- See Also:
-
deleteDBCluster
default CompletableFuture<DeleteDbClusterResponse> deleteDBCluster(DeleteDbClusterRequest deleteDbClusterRequest) The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
Note that the DB Cluster cannot be deleted if deletion protection is enabled. To delete it, you must first set its
DeletionProtection
field toFalse
.- Parameters:
deleteDbClusterRequest
-- Returns:
- A Java Future containing the result of the DeleteDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteDBCluster
default CompletableFuture<DeleteDbClusterResponse> deleteDBCluster(Consumer<DeleteDbClusterRequest.Builder> deleteDbClusterRequest) The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
Note that the DB Cluster cannot be deleted if deletion protection is enabled. To delete it, you must first set its
DeletionProtection
field toFalse
.
This is a convenience which creates an instance of the
DeleteDbClusterRequest.Builder
avoiding the need to create one manually viaDeleteDbClusterRequest.builder()
- Parameters:
deleteDbClusterRequest
- AConsumer
that will call methods onDeleteDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteDBClusterEndpoint
default CompletableFuture<DeleteDbClusterEndpointResponse> deleteDBClusterEndpoint(DeleteDbClusterEndpointRequest deleteDbClusterEndpointRequest) Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.
- Parameters:
deleteDbClusterEndpointRequest
-- Returns:
- A Java Future containing the result of the DeleteDBClusterEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbClusterEndpointStateException The requested operation cannot be performed on the endpoint while the endpoint is in this state.
- DbClusterEndpointNotFoundException The specified custom endpoint doesn't exist.
- InvalidDbClusterStateException The DB cluster is not in a valid state.
- 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.
- See Also:
-
deleteDBClusterEndpoint
default CompletableFuture<DeleteDbClusterEndpointResponse> deleteDBClusterEndpoint(Consumer<DeleteDbClusterEndpointRequest.Builder> deleteDbClusterEndpointRequest) Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.
This is a convenience which creates an instance of the
DeleteDbClusterEndpointRequest.Builder
avoiding the need to create one manually viaDeleteDbClusterEndpointRequest.builder()
- Parameters:
deleteDbClusterEndpointRequest
- AConsumer
that will call methods onDeleteDbClusterEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBClusterEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbClusterEndpointStateException The requested operation cannot be performed on the endpoint while the endpoint is in this state.
- DbClusterEndpointNotFoundException The specified custom endpoint doesn't exist.
- InvalidDbClusterStateException The DB cluster is not in a valid state.
- 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.
- See Also:
-
deleteDBClusterParameterGroup
default CompletableFuture<DeleteDbClusterParameterGroupResponse> deleteDBClusterParameterGroup(DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest) Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
- Parameters:
deleteDbClusterParameterGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteDBClusterParameterGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteDBClusterParameterGroup
default CompletableFuture<DeleteDbClusterParameterGroupResponse> deleteDBClusterParameterGroup(Consumer<DeleteDbClusterParameterGroupRequest.Builder> deleteDbClusterParameterGroupRequest) 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 viaDeleteDbClusterParameterGroupRequest.builder()
- Parameters:
deleteDbClusterParameterGroupRequest
- AConsumer
that will call methods onDeleteDbClusterParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBClusterParameterGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteDBClusterSnapshot
default CompletableFuture<DeleteDbClusterSnapshotResponse> deleteDBClusterSnapshot(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest) Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the
available
state to be deleted.- Parameters:
deleteDbClusterSnapshotRequest
-- Returns:
- A Java Future containing the result of the DeleteDBClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteDBClusterSnapshot
default CompletableFuture<DeleteDbClusterSnapshotResponse> deleteDBClusterSnapshot(Consumer<DeleteDbClusterSnapshotRequest.Builder> deleteDbClusterSnapshotRequest) Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the
available
state to be deleted.
This is a convenience which creates an instance of the
DeleteDbClusterSnapshotRequest.Builder
avoiding the need to create one manually viaDeleteDbClusterSnapshotRequest.builder()
- Parameters:
deleteDbClusterSnapshotRequest
- AConsumer
that will call methods onDeleteDbClusterSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteDBInstance
default CompletableFuture<DeleteDbInstanceResponse> deleteDBInstance(DeleteDbInstanceRequest deleteDbInstanceRequest) The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by
DeleteDBInstance
are not deleted.If you request a final DB snapshot the status of the Amazon Neptune DB instance is
deleting
until the DB snapshot is created. The API actionDescribeDBInstance
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
, orincompatible-network
, you can only delete it when theSkipFinalSnapshot
parameter is set totrue
.You can't delete a DB instance if it is the only instance in the DB cluster, or if it has deletion protection enabled.
- Parameters:
deleteDbInstanceRequest
-- Returns:
- A Java Future containing the result of the DeleteDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteDBInstance
default CompletableFuture<DeleteDbInstanceResponse> deleteDBInstance(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest) The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by
DeleteDBInstance
are not deleted.If you request a final DB snapshot the status of the Amazon Neptune DB instance is
deleting
until the DB snapshot is created. The API actionDescribeDBInstance
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
, orincompatible-network
, you can only delete it when theSkipFinalSnapshot
parameter is set totrue
.You can't delete a DB instance if it is the only instance in the DB cluster, or if it has deletion protection enabled.
This is a convenience which creates an instance of the
DeleteDbInstanceRequest.Builder
avoiding the need to create one manually viaDeleteDbInstanceRequest.builder()
- Parameters:
deleteDbInstanceRequest
- AConsumer
that will call methods onDeleteDbInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteDBParameterGroup
default CompletableFuture<DeleteDbParameterGroupResponse> deleteDBParameterGroup(DeleteDbParameterGroupRequest deleteDbParameterGroupRequest) Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.
- Parameters:
deleteDbParameterGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteDBParameterGroup
default CompletableFuture<DeleteDbParameterGroupResponse> deleteDBParameterGroup(Consumer<DeleteDbParameterGroupRequest.Builder> deleteDbParameterGroupRequest) 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 viaDeleteDbParameterGroupRequest.builder()
- Parameters:
deleteDbParameterGroupRequest
- AConsumer
that will call methods onDeleteDbParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteDBSubnetGroup
default CompletableFuture<DeleteDbSubnetGroupResponse> deleteDBSubnetGroup(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest) Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
- Parameters:
deleteDbSubnetGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteDBSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteDBSubnetGroup
default CompletableFuture<DeleteDbSubnetGroupResponse> deleteDBSubnetGroup(Consumer<DeleteDbSubnetGroupRequest.Builder> deleteDbSubnetGroupRequest) 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 viaDeleteDbSubnetGroupRequest.builder()
- Parameters:
deleteDbSubnetGroupRequest
- AConsumer
that will call methods onDeleteDbSubnetGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteEventSubscription
default CompletableFuture<DeleteEventSubscriptionResponse> deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) Deletes an event notification subscription.
- Parameters:
deleteEventSubscriptionRequest
-- Returns:
- A Java Future containing the result of the DeleteEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException The designated subscription could not be found.
- InvalidEventSubscriptionStateException The event subscription is in an invalid 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.
- See Also:
-
deleteEventSubscription
default CompletableFuture<DeleteEventSubscriptionResponse> deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest) Deletes an event notification subscription.
This is a convenience which creates an instance of the
DeleteEventSubscriptionRequest.Builder
avoiding the need to create one manually viaDeleteEventSubscriptionRequest.builder()
- Parameters:
deleteEventSubscriptionRequest
- AConsumer
that will call methods onDeleteEventSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException The designated subscription could not be found.
- InvalidEventSubscriptionStateException The event subscription is in an invalid 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.
- See Also:
-
deleteGlobalCluster
default CompletableFuture<DeleteGlobalClusterResponse> deleteGlobalCluster(DeleteGlobalClusterRequest deleteGlobalClusterRequest) Deletes a global database. The primary and all secondary clusters must already be detached or deleted first.
- Parameters:
deleteGlobalClusterRequest
-- Returns:
- A Java Future containing the result of the DeleteGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested 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.
- GlobalClusterNotFoundException The
- See Also:
-
deleteGlobalCluster
default CompletableFuture<DeleteGlobalClusterResponse> deleteGlobalCluster(Consumer<DeleteGlobalClusterRequest.Builder> deleteGlobalClusterRequest) Deletes a global database. The primary and all secondary clusters must already be detached or deleted first.
This is a convenience which creates an instance of the
DeleteGlobalClusterRequest.Builder
avoiding the need to create one manually viaDeleteGlobalClusterRequest.builder()
- Parameters:
deleteGlobalClusterRequest
- AConsumer
that will call methods onDeleteGlobalClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested 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.
- GlobalClusterNotFoundException The
- See Also:
-
describeDBClusterEndpoints
default CompletableFuture<DescribeDbClusterEndpointsResponse> describeDBClusterEndpoints(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest) Returns information about endpoints for an Amazon Neptune DB cluster.
This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.
- Parameters:
describeDbClusterEndpointsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBClusterEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterEndpoints
default CompletableFuture<DescribeDbClusterEndpointsResponse> describeDBClusterEndpoints(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest) Returns information about endpoints for an Amazon Neptune DB cluster.
This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.
This is a convenience which creates an instance of the
DescribeDbClusterEndpointsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterEndpointsRequest.builder()
- Parameters:
describeDbClusterEndpointsRequest
- AConsumer
that will call methods onDescribeDbClusterEndpointsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBClusterEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterEndpointsPaginator
default DescribeDBClusterEndpointsPublisher describeDBClusterEndpointsPaginator(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest) This is a variant of
describeDBClusterEndpoints(software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterEndpointsPublisher publisher = client.describeDBClusterEndpointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterEndpointsPublisher publisher = client.describeDBClusterEndpointsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterEndpoints(software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsRequest)
operation.- Parameters:
describeDbClusterEndpointsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterEndpointsPaginator
default DescribeDBClusterEndpointsPublisher describeDBClusterEndpointsPaginator(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest) This is a variant of
describeDBClusterEndpoints(software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterEndpointsPublisher publisher = client.describeDBClusterEndpointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterEndpointsPublisher publisher = client.describeDBClusterEndpointsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterEndpoints(software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClusterEndpointsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterEndpointsRequest.builder()
- Parameters:
describeDbClusterEndpointsRequest
- AConsumer
that will call methods onDescribeDbClusterEndpointsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterParameterGroups
default CompletableFuture<DescribeDbClusterParameterGroupsResponse> describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) Returns a list of
DBClusterParameterGroup
descriptions. If aDBClusterParameterGroupName
parameter is specified, the list will contain only the description of the specified DB cluster parameter group.- Parameters:
describeDbClusterParameterGroupsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBClusterParameterGroups operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterParameterGroups
default CompletableFuture<DescribeDbClusterParameterGroupsResponse> describeDBClusterParameterGroups(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) Returns a list of
DBClusterParameterGroup
descriptions. If aDBClusterParameterGroupName
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 viaDescribeDbClusterParameterGroupsRequest.builder()
- Parameters:
describeDbClusterParameterGroupsRequest
- AConsumer
that will call methods onDescribeDbClusterParameterGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBClusterParameterGroups operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterParameterGroups
default CompletableFuture<DescribeDbClusterParameterGroupsResponse> describeDBClusterParameterGroups()Returns a list of
DBClusterParameterGroup
descriptions. If aDBClusterParameterGroupName
parameter is specified, the list will contain only the description of the specified DB cluster parameter group.- Returns:
- A Java Future containing the result of the DescribeDBClusterParameterGroups operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterParameterGroupsPaginator
This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsPublisher publisher = client.describeDBClusterParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsPublisher publisher = client.describeDBClusterParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterParameterGroupsPaginator
default DescribeDBClusterParameterGroupsPublisher describeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsPublisher publisher = client.describeDBClusterParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsPublisher publisher = client.describeDBClusterParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)
operation.- Parameters:
describeDbClusterParameterGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterParameterGroupsPaginator
default DescribeDBClusterParameterGroupsPublisher describeDBClusterParameterGroupsPaginator(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsPublisher publisher = client.describeDBClusterParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsPublisher publisher = client.describeDBClusterParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClusterParameterGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterParameterGroupsRequest.builder()
- Parameters:
describeDbClusterParameterGroupsRequest
- AConsumer
that will call methods onDescribeDbClusterParameterGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterParameters
default CompletableFuture<DescribeDbClusterParametersResponse> describeDBClusterParameters(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) Returns the detailed parameter list for a particular DB cluster parameter group.
- Parameters:
describeDbClusterParametersRequest
-- Returns:
- A Java Future containing the result of the DescribeDBClusterParameters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterParameters
default CompletableFuture<DescribeDbClusterParametersResponse> describeDBClusterParameters(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) 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 viaDescribeDbClusterParametersRequest.builder()
- Parameters:
describeDbClusterParametersRequest
- AConsumer
that will call methods onDescribeDbClusterParametersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBClusterParameters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterParametersPaginator
default DescribeDBClusterParametersPublisher describeDBClusterParametersPaginator(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) This is a variant of
describeDBClusterParameters(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParametersPublisher publisher = client.describeDBClusterParametersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParametersPublisher publisher = client.describeDBClusterParametersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameters(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersRequest)
operation.- Parameters:
describeDbClusterParametersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterParametersPaginator
default DescribeDBClusterParametersPublisher describeDBClusterParametersPaginator(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) This is a variant of
describeDBClusterParameters(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParametersPublisher publisher = client.describeDBClusterParametersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParametersPublisher publisher = client.describeDBClusterParametersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameters(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClusterParametersRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterParametersRequest.builder()
- Parameters:
describeDbClusterParametersRequest
- AConsumer
that will call methods onDescribeDbClusterParametersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterSnapshotAttributes
default CompletableFuture<DescribeDbClusterSnapshotAttributesResponse> describeDBClusterSnapshotAttributes(DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest) Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other Amazon accounts,
DescribeDBClusterSnapshotAttributes
returns therestore
attribute and a list of IDs for the Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. Ifall
is included in the list of values for therestore
attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon accounts.To add or remove access for an Amazon account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
- Parameters:
describeDbClusterSnapshotAttributesRequest
-- Returns:
- A Java Future containing the result of the DescribeDBClusterSnapshotAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterSnapshotAttributes
default CompletableFuture<DescribeDbClusterSnapshotAttributesResponse> describeDBClusterSnapshotAttributes(Consumer<DescribeDbClusterSnapshotAttributesRequest.Builder> describeDbClusterSnapshotAttributesRequest) Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other Amazon accounts,
DescribeDBClusterSnapshotAttributes
returns therestore
attribute and a list of IDs for the Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. Ifall
is included in the list of values for therestore
attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon accounts.To add or remove access for an Amazon account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
This is a convenience which creates an instance of the
DescribeDbClusterSnapshotAttributesRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterSnapshotAttributesRequest.builder()
- Parameters:
describeDbClusterSnapshotAttributesRequest
- AConsumer
that will call methods onDescribeDbClusterSnapshotAttributesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBClusterSnapshotAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterSnapshots
default CompletableFuture<DescribeDbClusterSnapshotsResponse> describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) Returns information about DB cluster snapshots. This API action supports pagination.
- Parameters:
describeDbClusterSnapshotsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBClusterSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterSnapshots
default CompletableFuture<DescribeDbClusterSnapshotsResponse> describeDBClusterSnapshots(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) 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 viaDescribeDbClusterSnapshotsRequest.builder()
- Parameters:
describeDbClusterSnapshotsRequest
- AConsumer
that will call methods onDescribeDbClusterSnapshotsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBClusterSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterSnapshots
Returns information about DB cluster snapshots. This API action supports pagination.
- Returns:
- A Java Future containing the result of the DescribeDBClusterSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterSnapshotsPaginator
This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsPublisher publisher = client.describeDBClusterSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsPublisher publisher = client.describeDBClusterSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterSnapshotsPaginator
default DescribeDBClusterSnapshotsPublisher describeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsPublisher publisher = client.describeDBClusterSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsPublisher publisher = client.describeDBClusterSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)
operation.- Parameters:
describeDbClusterSnapshotsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusterSnapshotsPaginator
default DescribeDBClusterSnapshotsPublisher describeDBClusterSnapshotsPaginator(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsPublisher publisher = client.describeDBClusterSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsPublisher publisher = client.describeDBClusterSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClusterSnapshotsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterSnapshotsRequest.builder()
- Parameters:
describeDbClusterSnapshotsRequest
- AConsumer
that will call methods onDescribeDbClusterSnapshotsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusters
default CompletableFuture<DescribeDbClustersResponse> describeDBClusters(DescribeDbClustersRequest describeDbClustersRequest) Returns information about provisioned DB clusters, and supports pagination.
This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.
- Parameters:
describeDbClustersRequest
-- Returns:
- A Java Future containing the result of the DescribeDBClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusters
default CompletableFuture<DescribeDbClustersResponse> describeDBClusters(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) Returns information about provisioned DB clusters, and supports pagination.
This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.
This is a convenience which creates an instance of the
DescribeDbClustersRequest.Builder
avoiding the need to create one manually viaDescribeDbClustersRequest.builder()
- Parameters:
describeDbClustersRequest
- AConsumer
that will call methods onDescribeDbClustersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClusters
Returns information about provisioned DB clusters, and supports pagination.
This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.
- Returns:
- A Java Future containing the result of the DescribeDBClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClustersPaginator
This is a variant of
describeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClustersPublisher publisher = client.describeDBClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBClustersPublisher publisher = client.describeDBClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbClustersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClustersPaginator
default DescribeDBClustersPublisher describeDBClustersPaginator(DescribeDbClustersRequest describeDbClustersRequest) This is a variant of
describeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClustersPublisher publisher = client.describeDBClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBClustersPublisher publisher = client.describeDBClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbClustersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)
operation.- Parameters:
describeDbClustersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBClustersPaginator
default DescribeDBClustersPublisher describeDBClustersPaginator(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) This is a variant of
describeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClustersPublisher publisher = client.describeDBClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBClustersPublisher publisher = client.describeDBClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbClustersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClustersRequest.Builder
avoiding the need to create one manually viaDescribeDbClustersRequest.builder()
- Parameters:
describeDbClustersRequest
- AConsumer
that will call methods onDescribeDbClustersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBEngineVersions
default CompletableFuture<DescribeDbEngineVersionsResponse> describeDBEngineVersions(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) Returns a list of the available DB engines.
- Parameters:
describeDbEngineVersionsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBEngineVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBEngineVersions
default CompletableFuture<DescribeDbEngineVersionsResponse> describeDBEngineVersions(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) 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 viaDescribeDbEngineVersionsRequest.builder()
- Parameters:
describeDbEngineVersionsRequest
- AConsumer
that will call methods onDescribeDbEngineVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBEngineVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBEngineVersions
Returns a list of the available DB engines.
- Returns:
- A Java Future containing the result of the DescribeDBEngineVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBEngineVersionsPaginator
This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsPublisher publisher = client.describeDBEngineVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsPublisher publisher = client.describeDBEngineVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBEngineVersionsPaginator
default DescribeDBEngineVersionsPublisher describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsPublisher publisher = client.describeDBEngineVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsPublisher publisher = client.describeDBEngineVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation.- Parameters:
describeDbEngineVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBEngineVersionsPaginator
default DescribeDBEngineVersionsPublisher describeDBEngineVersionsPaginator(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsPublisher publisher = client.describeDBEngineVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsPublisher publisher = client.describeDBEngineVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 viaDescribeDbEngineVersionsRequest.builder()
- Parameters:
describeDbEngineVersionsRequest
- AConsumer
that will call methods onDescribeDbEngineVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBInstances
default CompletableFuture<DescribeDbInstancesResponse> describeDBInstances(DescribeDbInstancesRequest describeDbInstancesRequest) Returns information about provisioned instances, and supports pagination.
This operation can also return information for Amazon RDS instances and Amazon DocDB instances.
- Parameters:
describeDbInstancesRequest
-- Returns:
- A Java Future containing the result of the DescribeDBInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBInstances
default CompletableFuture<DescribeDbInstancesResponse> describeDBInstances(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) Returns information about provisioned instances, and supports pagination.
This operation can also return information for Amazon RDS instances and Amazon DocDB instances.
This is a convenience which creates an instance of the
DescribeDbInstancesRequest.Builder
avoiding the need to create one manually viaDescribeDbInstancesRequest.builder()
- Parameters:
describeDbInstancesRequest
- AConsumer
that will call methods onDescribeDbInstancesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBInstances
Returns information about provisioned instances, and supports pagination.
This operation can also return information for Amazon RDS instances and Amazon DocDB instances.
- Returns:
- A Java Future containing the result of the DescribeDBInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBInstancesPaginator
This is a variant of
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesPublisher publisher = client.describeDBInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesPublisher publisher = client.describeDBInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBInstancesPaginator
default DescribeDBInstancesPublisher describeDBInstancesPaginator(DescribeDbInstancesRequest describeDbInstancesRequest) This is a variant of
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesPublisher publisher = client.describeDBInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesPublisher publisher = client.describeDBInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation.- Parameters:
describeDbInstancesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBInstancesPaginator
default DescribeDBInstancesPublisher describeDBInstancesPaginator(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) This is a variant of
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesPublisher publisher = client.describeDBInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesPublisher publisher = client.describeDBInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 viaDescribeDbInstancesRequest.builder()
- Parameters:
describeDbInstancesRequest
- AConsumer
that will call methods onDescribeDbInstancesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBParameterGroups
default CompletableFuture<DescribeDbParameterGroupsResponse> describeDBParameterGroups(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) Returns a list of
DBParameterGroup
descriptions. If aDBParameterGroupName
is specified, the list will contain only the description of the specified DB parameter group.- Parameters:
describeDbParameterGroupsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBParameterGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBParameterGroups
default CompletableFuture<DescribeDbParameterGroupsResponse> describeDBParameterGroups(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) Returns a list of
DBParameterGroup
descriptions. If aDBParameterGroupName
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 viaDescribeDbParameterGroupsRequest.builder()
- Parameters:
describeDbParameterGroupsRequest
- AConsumer
that will call methods onDescribeDbParameterGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBParameterGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBParameterGroups
Returns a list of
DBParameterGroup
descriptions. If aDBParameterGroupName
is specified, the list will contain only the description of the specified DB parameter group.- Returns:
- A Java Future containing the result of the DescribeDBParameterGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBParameterGroupsPaginator
This is a variant of
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsPublisher publisher = client.describeDBParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsPublisher publisher = client.describeDBParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBParameterGroupsPaginator
default DescribeDBParameterGroupsPublisher describeDBParameterGroupsPaginator(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) This is a variant of
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsPublisher publisher = client.describeDBParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsPublisher publisher = client.describeDBParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation.- Parameters:
describeDbParameterGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBParameterGroupsPaginator
default DescribeDBParameterGroupsPublisher describeDBParameterGroupsPaginator(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) This is a variant of
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsPublisher publisher = client.describeDBParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsPublisher publisher = client.describeDBParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 viaDescribeDbParameterGroupsRequest.builder()
- Parameters:
describeDbParameterGroupsRequest
- AConsumer
that will call methods onDescribeDbParameterGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBParameters
default CompletableFuture<DescribeDbParametersResponse> describeDBParameters(DescribeDbParametersRequest describeDbParametersRequest) Returns the detailed parameter list for a particular DB parameter group.
- Parameters:
describeDbParametersRequest
-- Returns:
- A Java Future containing the result of the DescribeDBParameters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBParameters
default CompletableFuture<DescribeDbParametersResponse> describeDBParameters(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) 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 viaDescribeDbParametersRequest.builder()
- Parameters:
describeDbParametersRequest
- AConsumer
that will call methods onDescribeDbParametersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBParameters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBParametersPaginator
default DescribeDBParametersPublisher describeDBParametersPaginator(DescribeDbParametersRequest describeDbParametersRequest) This is a variant of
describeDBParameters(software.amazon.awssdk.services.neptune.model.DescribeDbParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParametersPublisher publisher = client.describeDBParametersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBParametersPublisher publisher = client.describeDBParametersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbParametersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbParametersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBParameters(software.amazon.awssdk.services.neptune.model.DescribeDbParametersRequest)
operation.- Parameters:
describeDbParametersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBParametersPaginator
default DescribeDBParametersPublisher describeDBParametersPaginator(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) This is a variant of
describeDBParameters(software.amazon.awssdk.services.neptune.model.DescribeDbParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParametersPublisher publisher = client.describeDBParametersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBParametersPublisher publisher = client.describeDBParametersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbParametersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbParametersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 viaDescribeDbParametersRequest.builder()
- Parameters:
describeDbParametersRequest
- AConsumer
that will call methods onDescribeDbParametersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBSubnetGroups
default CompletableFuture<DescribeDbSubnetGroupsResponse> describeDBSubnetGroups(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
- Parameters:
describeDbSubnetGroupsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBSubnetGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBSubnetGroups
default CompletableFuture<DescribeDbSubnetGroupsResponse> describeDBSubnetGroups(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
This is a convenience which creates an instance of the
DescribeDbSubnetGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbSubnetGroupsRequest.builder()
- Parameters:
describeDbSubnetGroupsRequest
- AConsumer
that will call methods onDescribeDbSubnetGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBSubnetGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBSubnetGroups
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.
- Returns:
- A Java Future containing the result of the DescribeDBSubnetGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBSubnetGroupsPaginator
This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsPublisher publisher = client.describeDBSubnetGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsPublisher publisher = client.describeDBSubnetGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBSubnetGroupsPaginator
default DescribeDBSubnetGroupsPublisher describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsPublisher publisher = client.describeDBSubnetGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsPublisher publisher = client.describeDBSubnetGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation.- Parameters:
describeDbSubnetGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDBSubnetGroupsPaginator
default DescribeDBSubnetGroupsPublisher describeDBSubnetGroupsPaginator(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsPublisher publisher = client.describeDBSubnetGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsPublisher publisher = client.describeDBSubnetGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 viaDescribeDbSubnetGroupsRequest.builder()
- Parameters:
describeDbSubnetGroupsRequest
- AConsumer
that will call methods onDescribeDbSubnetGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeEngineDefaultClusterParameters
default CompletableFuture<DescribeEngineDefaultClusterParametersResponse> describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) Returns the default engine and system parameter information for the cluster database engine.
- Parameters:
describeEngineDefaultClusterParametersRequest
-- Returns:
- A Java Future containing the result of the DescribeEngineDefaultClusterParameters operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeEngineDefaultClusterParameters
default CompletableFuture<DescribeEngineDefaultClusterParametersResponse> describeEngineDefaultClusterParameters(Consumer<DescribeEngineDefaultClusterParametersRequest.Builder> describeEngineDefaultClusterParametersRequest) 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 viaDescribeEngineDefaultClusterParametersRequest.builder()
- Parameters:
describeEngineDefaultClusterParametersRequest
- AConsumer
that will call methods onDescribeEngineDefaultClusterParametersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEngineDefaultClusterParameters operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeEngineDefaultParameters
default CompletableFuture<DescribeEngineDefaultParametersResponse> describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) Returns the default engine and system parameter information for the specified database engine.
- Parameters:
describeEngineDefaultParametersRequest
-- Returns:
- A Java Future containing the result of the DescribeEngineDefaultParameters operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeEngineDefaultParameters
default CompletableFuture<DescribeEngineDefaultParametersResponse> describeEngineDefaultParameters(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) 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 viaDescribeEngineDefaultParametersRequest.builder()
- Parameters:
describeEngineDefaultParametersRequest
- AConsumer
that will call methods onDescribeEngineDefaultParametersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEngineDefaultParameters operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeEngineDefaultParametersPaginator
default DescribeEngineDefaultParametersPublisher describeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) This is a variant of
describeEngineDefaultParameters(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersPublisher publisher = client.describeEngineDefaultParametersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersPublisher publisher = client.describeEngineDefaultParametersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEngineDefaultParameters(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersRequest)
operation.- Parameters:
describeEngineDefaultParametersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeEngineDefaultParametersPaginator
default DescribeEngineDefaultParametersPublisher describeEngineDefaultParametersPaginator(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) This is a variant of
describeEngineDefaultParameters(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersPublisher publisher = client.describeEngineDefaultParametersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersPublisher publisher = client.describeEngineDefaultParametersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 viaDescribeEngineDefaultParametersRequest.builder()
- Parameters:
describeEngineDefaultParametersRequest
- AConsumer
that will call methods onDescribeEngineDefaultParametersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeEventCategories
default CompletableFuture<DescribeEventCategoriesResponse> describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) Displays a list of categories for all event source types, or, if specified, for a specified source type.
- Parameters:
describeEventCategoriesRequest
-- Returns:
- A Java Future containing the result of the DescribeEventCategories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeEventCategories
default CompletableFuture<DescribeEventCategoriesResponse> describeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest) 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 viaDescribeEventCategoriesRequest.builder()
- Parameters:
describeEventCategoriesRequest
- AConsumer
that will call methods onDescribeEventCategoriesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEventCategories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeEventCategories
Displays a list of categories for all event source types, or, if specified, for a specified source type.
- Returns:
- A Java Future containing the result of the DescribeEventCategories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeEventSubscriptions
default CompletableFuture<DescribeEventSubscriptionsResponse> describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
- Parameters:
describeEventSubscriptionsRequest
-- Returns:
- A Java Future containing the result of the DescribeEventSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException The designated subscription could not be 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.
- See Also:
-
describeEventSubscriptions
default CompletableFuture<DescribeEventSubscriptionsResponse> describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
This is a convenience which creates an instance of the
DescribeEventSubscriptionsRequest.Builder
avoiding the need to create one manually viaDescribeEventSubscriptionsRequest.builder()
- Parameters:
describeEventSubscriptionsRequest
- AConsumer
that will call methods onDescribeEventSubscriptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEventSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException The designated subscription could not be 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.
- See Also:
-
describeEventSubscriptions
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.
- Returns:
- A Java Future containing the result of the DescribeEventSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException The designated subscription could not be 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.
- See Also:
-
describeEventSubscriptionsPaginator
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException The designated subscription could not be 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.
- See Also:
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsPublisher describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation.- Parameters:
describeEventSubscriptionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException The designated subscription could not be 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.
- See Also:
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsPublisher describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 viaDescribeEventSubscriptionsRequest.builder()
- Parameters:
describeEventSubscriptionsRequest
- AConsumer
that will call methods onDescribeEventSubscriptionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException The designated subscription could not be 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.
- See Also:
-
describeEvents
default CompletableFuture<DescribeEventsResponse> describeEvents(DescribeEventsRequest describeEventsRequest) Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
- Parameters:
describeEventsRequest
-- Returns:
- A Java Future containing the result of the DescribeEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeEvents
default CompletableFuture<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. 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 viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeEvents
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.
- Returns:
- A Java Future containing the result of the DescribeEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeEventsPaginator
This is a variant of
describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeEventsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeEventsPaginator
default DescribeEventsPublisher describeEventsPaginator(DescribeEventsRequest describeEventsRequest) This is a variant of
describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeEventsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation.- Parameters:
describeEventsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeEventsPaginator
default DescribeEventsPublisher describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) This is a variant of
describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeEventsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeGlobalClusters
default CompletableFuture<DescribeGlobalClustersResponse> describeGlobalClusters(DescribeGlobalClustersRequest describeGlobalClustersRequest) Returns information about Neptune global database clusters. This API supports pagination.
- Parameters:
describeGlobalClustersRequest
-- Returns:
- A Java Future containing the result of the DescribeGlobalClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database 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.
- GlobalClusterNotFoundException The
- See Also:
-
describeGlobalClusters
default CompletableFuture<DescribeGlobalClustersResponse> describeGlobalClusters(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) Returns information about Neptune global database clusters. This API supports pagination.
This is a convenience which creates an instance of the
DescribeGlobalClustersRequest.Builder
avoiding the need to create one manually viaDescribeGlobalClustersRequest.builder()
- Parameters:
describeGlobalClustersRequest
- AConsumer
that will call methods onDescribeGlobalClustersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeGlobalClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database 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.
- GlobalClusterNotFoundException The
- See Also:
-
describeGlobalClustersPaginator
default DescribeGlobalClustersPublisher describeGlobalClustersPaginator(DescribeGlobalClustersRequest describeGlobalClustersRequest) This is a variant of
describeGlobalClusters(software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeGlobalClustersPublisher publisher = client.describeGlobalClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeGlobalClustersPublisher publisher = client.describeGlobalClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGlobalClusters(software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersRequest)
operation.- Parameters:
describeGlobalClustersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database 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.
- GlobalClusterNotFoundException The
- See Also:
-
describeGlobalClustersPaginator
default DescribeGlobalClustersPublisher describeGlobalClustersPaginator(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) This is a variant of
describeGlobalClusters(software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeGlobalClustersPublisher publisher = client.describeGlobalClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeGlobalClustersPublisher publisher = client.describeGlobalClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGlobalClusters(software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersRequest)
operation.
This is a convenience which creates an instance of the
DescribeGlobalClustersRequest.Builder
avoiding the need to create one manually viaDescribeGlobalClustersRequest.builder()
- Parameters:
describeGlobalClustersRequest
- AConsumer
that will call methods onDescribeGlobalClustersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database 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.
- GlobalClusterNotFoundException The
- See Also:
-
describeOrderableDBInstanceOptions
default CompletableFuture<DescribeOrderableDbInstanceOptionsResponse> describeOrderableDBInstanceOptions(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) Returns a list of orderable DB instance options for the specified engine.
- Parameters:
describeOrderableDbInstanceOptionsRequest
-- Returns:
- A Java Future containing the result of the DescribeOrderableDBInstanceOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeOrderableDBInstanceOptions
default CompletableFuture<DescribeOrderableDbInstanceOptionsResponse> describeOrderableDBInstanceOptions(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) 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 viaDescribeOrderableDbInstanceOptionsRequest.builder()
- Parameters:
describeOrderableDbInstanceOptionsRequest
- AConsumer
that will call methods onDescribeOrderableDbInstanceOptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeOrderableDBInstanceOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeOrderableDBInstanceOptionsPaginator
default DescribeOrderableDBInstanceOptionsPublisher describeOrderableDBInstanceOptionsPaginator(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) This is a variant of
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsPublisher publisher = client.describeOrderableDBInstanceOptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsPublisher publisher = client.describeOrderableDBInstanceOptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsRequest)
operation.- Parameters:
describeOrderableDbInstanceOptionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeOrderableDBInstanceOptionsPaginator
default DescribeOrderableDBInstanceOptionsPublisher describeOrderableDBInstanceOptionsPaginator(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) This is a variant of
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsPublisher publisher = client.describeOrderableDBInstanceOptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsPublisher publisher = client.describeOrderableDBInstanceOptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 viaDescribeOrderableDbInstanceOptionsRequest.builder()
- Parameters:
describeOrderableDbInstanceOptionsRequest
- AConsumer
that will call methods onDescribeOrderableDbInstanceOptionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describePendingMaintenanceActions
default CompletableFuture<DescribePendingMaintenanceActionsResponse> describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
- Parameters:
describePendingMaintenanceActionsRequest
-- Returns:
- A Java Future containing the result of the DescribePendingMaintenanceActions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describePendingMaintenanceActions
default CompletableFuture<DescribePendingMaintenanceActionsResponse> describePendingMaintenanceActions(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) 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 viaDescribePendingMaintenanceActionsRequest.builder()
- Parameters:
describePendingMaintenanceActionsRequest
- AConsumer
that will call methods onDescribePendingMaintenanceActionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePendingMaintenanceActions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describePendingMaintenanceActions
default CompletableFuture<DescribePendingMaintenanceActionsResponse> describePendingMaintenanceActions()Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
- Returns:
- A Java Future containing the result of the DescribePendingMaintenanceActions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describePendingMaintenanceActionsPaginator
This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsPublisher publisher = client.describePendingMaintenanceActionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsPublisher publisher = client.describePendingMaintenanceActionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describePendingMaintenanceActionsPaginator
default DescribePendingMaintenanceActionsPublisher describePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsPublisher publisher = client.describePendingMaintenanceActionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsPublisher publisher = client.describePendingMaintenanceActionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)
operation.- Parameters:
describePendingMaintenanceActionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describePendingMaintenanceActionsPaginator
default DescribePendingMaintenanceActionsPublisher describePendingMaintenanceActionsPaginator(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsPublisher publisher = client.describePendingMaintenanceActionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsPublisher publisher = client.describePendingMaintenanceActionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)
operation.
This is a convenience which creates an instance of the
DescribePendingMaintenanceActionsRequest.Builder
avoiding the need to create one manually viaDescribePendingMaintenanceActionsRequest.builder()
- Parameters:
describePendingMaintenanceActionsRequest
- AConsumer
that will call methods onDescribePendingMaintenanceActionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeValidDBInstanceModifications
default CompletableFuture<DescribeValidDbInstanceModificationsResponse> describeValidDBInstanceModifications(DescribeValidDbInstanceModificationsRequest describeValidDbInstanceModificationsRequest) You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
- Parameters:
describeValidDbInstanceModificationsRequest
-- Returns:
- A Java Future containing the result of the DescribeValidDBInstanceModifications operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeValidDBInstanceModifications
default CompletableFuture<DescribeValidDbInstanceModificationsResponse> describeValidDBInstanceModifications(Consumer<DescribeValidDbInstanceModificationsRequest.Builder> describeValidDbInstanceModificationsRequest) You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
This is a convenience which creates an instance of the
DescribeValidDbInstanceModificationsRequest.Builder
avoiding the need to create one manually viaDescribeValidDbInstanceModificationsRequest.builder()
- Parameters:
describeValidDbInstanceModificationsRequest
- AConsumer
that will call methods onDescribeValidDbInstanceModificationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeValidDBInstanceModifications operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
failoverDBCluster
default CompletableFuture<FailoverDbClusterResponse> failoverDBCluster(FailoverDbClusterRequest failoverDbClusterRequest) Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).
Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
- Parameters:
failoverDbClusterRequest
-- Returns:
- A Java Future containing the result of the FailoverDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
failoverDBCluster
default CompletableFuture<FailoverDbClusterResponse> failoverDBCluster(Consumer<FailoverDbClusterRequest.Builder> failoverDbClusterRequest) Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).
Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
This is a convenience which creates an instance of the
FailoverDbClusterRequest.Builder
avoiding the need to create one manually viaFailoverDbClusterRequest.builder()
- Parameters:
failoverDbClusterRequest
- AConsumer
that will call methods onFailoverDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the FailoverDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
failoverGlobalCluster
default CompletableFuture<FailoverGlobalClusterResponse> failoverGlobalCluster(FailoverGlobalClusterRequest failoverGlobalClusterRequest) Initiates the failover process for a Neptune global database.
A failover for a Neptune global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected target secondary DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Neptune global database.
This action applies only to Neptune global databases. This action is only intended for use on healthy Neptune global databases with healthy Neptune DB clusters and no region-wide outages, to test disaster recovery scenarios or to reconfigure the global database topology.
- Parameters:
failoverGlobalClusterRequest
-- Returns:
- A Java Future containing the result of the FailoverGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested operation.
- InvalidDbClusterStateException The DB cluster is not in a valid state.
- 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.
- GlobalClusterNotFoundException The
- See Also:
-
failoverGlobalCluster
default CompletableFuture<FailoverGlobalClusterResponse> failoverGlobalCluster(Consumer<FailoverGlobalClusterRequest.Builder> failoverGlobalClusterRequest) Initiates the failover process for a Neptune global database.
A failover for a Neptune global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected target secondary DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Neptune global database.
This action applies only to Neptune global databases. This action is only intended for use on healthy Neptune global databases with healthy Neptune DB clusters and no region-wide outages, to test disaster recovery scenarios or to reconfigure the global database topology.
This is a convenience which creates an instance of the
FailoverGlobalClusterRequest.Builder
avoiding the need to create one manually viaFailoverGlobalClusterRequest.builder()
- Parameters:
failoverGlobalClusterRequest
- AConsumer
that will call methods onFailoverGlobalClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the FailoverGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested operation.
- InvalidDbClusterStateException The DB cluster is not in a valid state.
- 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.
- GlobalClusterNotFoundException The
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags on an Amazon Neptune resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
modifyDBCluster
default CompletableFuture<ModifyDbClusterResponse> modifyDBCluster(ModifyDbClusterRequest modifyDbClusterRequest) Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
- Parameters:
modifyDbClusterRequest
-- Returns:
- A Java Future containing the result of the ModifyDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- StorageTypeNotSupportedException StorageType specified cannot be associated with the 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.
- See Also:
-
modifyDBCluster
default CompletableFuture<ModifyDbClusterResponse> modifyDBCluster(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest) Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
This is a convenience which creates an instance of the
ModifyDbClusterRequest.Builder
avoiding the need to create one manually viaModifyDbClusterRequest.builder()
- Parameters:
modifyDbClusterRequest
- AConsumer
that will call methods onModifyDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- StorageTypeNotSupportedException StorageType specified cannot be associated with the 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.
- See Also:
-
modifyDBClusterEndpoint
default CompletableFuture<ModifyDbClusterEndpointResponse> modifyDBClusterEndpoint(ModifyDbClusterEndpointRequest modifyDbClusterEndpointRequest) Modifies the properties of an endpoint in an Amazon Neptune DB cluster.
- Parameters:
modifyDbClusterEndpointRequest
-- Returns:
- A Java Future containing the result of the ModifyDBClusterEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbClusterStateException The DB cluster is not in a valid state.
- InvalidDbClusterEndpointStateException The requested operation cannot be performed on the endpoint while the endpoint is in this state.
- DbClusterEndpointNotFoundException The specified custom endpoint doesn't exist.
- DbInstanceNotFoundException DBInstanceIdentifier does not refer to an existing DB instance.
- InvalidDbInstanceStateException The specified DB instance is not in the available state.
- 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.
- See Also:
-
modifyDBClusterEndpoint
default CompletableFuture<ModifyDbClusterEndpointResponse> modifyDBClusterEndpoint(Consumer<ModifyDbClusterEndpointRequest.Builder> modifyDbClusterEndpointRequest) Modifies the properties of an endpoint in an Amazon Neptune DB cluster.
This is a convenience which creates an instance of the
ModifyDbClusterEndpointRequest.Builder
avoiding the need to create one manually viaModifyDbClusterEndpointRequest.builder()
- Parameters:
modifyDbClusterEndpointRequest
- AConsumer
that will call methods onModifyDbClusterEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBClusterEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbClusterStateException The DB cluster is not in a valid state.
- InvalidDbClusterEndpointStateException The requested operation cannot be performed on the endpoint while the endpoint is in this state.
- DbClusterEndpointNotFoundException The specified custom endpoint doesn't exist.
- DbInstanceNotFoundException DBInstanceIdentifier does not refer to an existing DB instance.
- InvalidDbInstanceStateException The specified DB instance is not in the available state.
- 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.
- See Also:
-
modifyDBClusterParameterGroup
default CompletableFuture<ModifyDbClusterParameterGroupResponse> modifyDBClusterParameterGroup(ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. A maximum of 20 parameters can be modified in a single request.Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.- Parameters:
modifyDbClusterParameterGroupRequest
-- Returns:
- A Java Future containing the result of the ModifyDBClusterParameterGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
modifyDBClusterParameterGroup
default CompletableFuture<ModifyDbClusterParameterGroupResponse> modifyDBClusterParameterGroup(Consumer<ModifyDbClusterParameterGroupRequest.Builder> modifyDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. 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 viaModifyDbClusterParameterGroupRequest.builder()
- Parameters:
modifyDbClusterParameterGroupRequest
- AConsumer
that will call methods onModifyDbClusterParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBClusterParameterGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
modifyDBClusterSnapshotAttribute
default CompletableFuture<ModifyDbClusterSnapshotAttributeResponse> modifyDBClusterSnapshotAttribute(ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other Amazon accounts, specify
restore
as theAttributeName
and use theValuesToAdd
parameter to add a list of IDs of the Amazon accounts that are authorized to restore the manual DB cluster snapshot. Use the valueall
to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon accounts. Do not add theall
value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon account IDs for theValuesToAdd
parameter. You can't useall
as a value for that parameter in this case.To view which Amazon accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.
- Parameters:
modifyDbClusterSnapshotAttributeRequest
-- Returns:
- A Java Future containing the result of the ModifyDBClusterSnapshotAttribute operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
modifyDBClusterSnapshotAttribute
default CompletableFuture<ModifyDbClusterSnapshotAttributeResponse> modifyDBClusterSnapshotAttribute(Consumer<ModifyDbClusterSnapshotAttributeRequest.Builder> modifyDbClusterSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other Amazon accounts, specify
restore
as theAttributeName
and use theValuesToAdd
parameter to add a list of IDs of the Amazon accounts that are authorized to restore the manual DB cluster snapshot. Use the valueall
to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon accounts. Do not add theall
value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon account IDs for theValuesToAdd
parameter. You can't useall
as a value for that parameter in this case.To view which Amazon accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.
This is a convenience which creates an instance of the
ModifyDbClusterSnapshotAttributeRequest.Builder
avoiding the need to create one manually viaModifyDbClusterSnapshotAttributeRequest.builder()
- Parameters:
modifyDbClusterSnapshotAttributeRequest
- AConsumer
that will call methods onModifyDbClusterSnapshotAttributeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBClusterSnapshotAttribute operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
modifyDBInstance
default CompletableFuture<ModifyDbInstanceResponse> modifyDBInstance(ModifyDbInstanceRequest modifyDbInstanceRequest) Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.
- Parameters:
modifyDbInstanceRequest
-- Returns:
- A Java Future containing the result of the ModifyDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbInstanceStateException The specified DB instance is not in the available state.
- InvalidDbSecurityGroupStateException The state of the DB security group does not allow deletion.
- DbInstanceAlreadyExistsException User already has a DB instance with the given identifier.
- DbInstanceNotFoundException DBInstanceIdentifier does not refer to an existing DB instance.
- DbSecurityGroupNotFoundException DBSecurityGroupName does not refer to an existing DB security group.
- DbParameterGroupNotFoundException DBParameterGroupName does not refer to an existing DB parameter group.
- InsufficientDbInstanceCapacityException Specified DB instance class is not available in the specified Availability Zone.
- StorageQuotaExceededException Request would result in user exceeding the allowed amount of storage available across all DB instances.
- InvalidVpcNetworkStateException DB subnet group does not cover all Availability Zones after it is created because users' change.
- ProvisionedIopsNotAvailableInAzException Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundException The designated option group could not be found.
- DbUpgradeDependencyFailureException The DB upgrade failed because a resource the DB depends on could not be modified.
- StorageTypeNotSupportedException StorageType specified cannot be associated with the DB Instance.
- AuthorizationNotFoundException Specified CIDRIP or EC2 security group is not authorized for the
specified DB security group.
Neptune may not also be authorized via IAM to perform necessary actions on your behalf.
- CertificateNotFoundException CertificateIdentifier does not refer to an existing certificate.
- DomainNotFoundException Domain does not refer to an existing Active Directory Domain.
- 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.
- See Also:
-
modifyDBInstance
default CompletableFuture<ModifyDbInstanceResponse> modifyDBInstance(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest) Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.
This is a convenience which creates an instance of the
ModifyDbInstanceRequest.Builder
avoiding the need to create one manually viaModifyDbInstanceRequest.builder()
- Parameters:
modifyDbInstanceRequest
- AConsumer
that will call methods onModifyDbInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbInstanceStateException The specified DB instance is not in the available state.
- InvalidDbSecurityGroupStateException The state of the DB security group does not allow deletion.
- DbInstanceAlreadyExistsException User already has a DB instance with the given identifier.
- DbInstanceNotFoundException DBInstanceIdentifier does not refer to an existing DB instance.
- DbSecurityGroupNotFoundException DBSecurityGroupName does not refer to an existing DB security group.
- DbParameterGroupNotFoundException DBParameterGroupName does not refer to an existing DB parameter group.
- InsufficientDbInstanceCapacityException Specified DB instance class is not available in the specified Availability Zone.
- StorageQuotaExceededException Request would result in user exceeding the allowed amount of storage available across all DB instances.
- InvalidVpcNetworkStateException DB subnet group does not cover all Availability Zones after it is created because users' change.
- ProvisionedIopsNotAvailableInAzException Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundException The designated option group could not be found.
- DbUpgradeDependencyFailureException The DB upgrade failed because a resource the DB depends on could not be modified.
- StorageTypeNotSupportedException StorageType specified cannot be associated with the DB Instance.
- AuthorizationNotFoundException Specified CIDRIP or EC2 security group is not authorized for the
specified DB security group.
Neptune may not also be authorized via IAM to perform necessary actions on your behalf.
- CertificateNotFoundException CertificateIdentifier does not refer to an existing certificate.
- DomainNotFoundException Domain does not refer to an existing Active Directory Domain.
- 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.
- See Also:
-
modifyDBParameterGroup
default CompletableFuture<ModifyDbParameterGroupResponse> modifyDBParameterGroup(ModifyDbParameterGroupRequest modifyDbParameterGroupRequest) Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. A maximum of 20 parameters can be modified in a single request.Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.- Parameters:
modifyDbParameterGroupRequest
-- Returns:
- A Java Future containing the result of the ModifyDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
modifyDBParameterGroup
default CompletableFuture<ModifyDbParameterGroupResponse> modifyDBParameterGroup(Consumer<ModifyDbParameterGroupRequest.Builder> modifyDbParameterGroupRequest) Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. 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 viaModifyDbParameterGroupRequest.builder()
- Parameters:
modifyDbParameterGroupRequest
- AConsumer
that will call methods onModifyDbParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
modifyDBSubnetGroup
default CompletableFuture<ModifyDbSubnetGroupResponse> modifyDBSubnetGroup(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest) Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.
- Parameters:
modifyDbSubnetGroupRequest
-- Returns:
- A Java Future containing the result of the ModifyDBSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
modifyDBSubnetGroup
default CompletableFuture<ModifyDbSubnetGroupResponse> modifyDBSubnetGroup(Consumer<ModifyDbSubnetGroupRequest.Builder> modifyDbSubnetGroupRequest) Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.
This is a convenience which creates an instance of the
ModifyDbSubnetGroupRequest.Builder
avoiding the need to create one manually viaModifyDbSubnetGroupRequest.builder()
- Parameters:
modifyDbSubnetGroupRequest
- AConsumer
that will call methods onModifyDbSubnetGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
modifyEventSubscription
default CompletableFuture<ModifyEventSubscriptionResponse> modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action.
- Parameters:
modifyEventSubscriptionRequest
-- Returns:
- A Java Future containing the result of the ModifyEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EventSubscriptionQuotaExceededException You have exceeded the number of events you can subscribe to.
- SubscriptionNotFoundException The designated subscription could not be found.
- SnsInvalidTopicException The SNS topic is invalid.
- SnsNoAuthorizationException There is no SNS authorization.
- SnsTopicArnNotFoundException The ARN of the SNS topic could not be found.
- SubscriptionCategoryNotFoundException The designated subscription category could not be found.
- 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.
- See Also:
-
modifyEventSubscription
default CompletableFuture<ModifyEventSubscriptionResponse> modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest) Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action.
This is a convenience which creates an instance of the
ModifyEventSubscriptionRequest.Builder
avoiding the need to create one manually viaModifyEventSubscriptionRequest.builder()
- Parameters:
modifyEventSubscriptionRequest
- AConsumer
that will call methods onModifyEventSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EventSubscriptionQuotaExceededException You have exceeded the number of events you can subscribe to.
- SubscriptionNotFoundException The designated subscription could not be found.
- SnsInvalidTopicException The SNS topic is invalid.
- SnsNoAuthorizationException There is no SNS authorization.
- SnsTopicArnNotFoundException The ARN of the SNS topic could not be found.
- SubscriptionCategoryNotFoundException The designated subscription category could not be found.
- 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.
- See Also:
-
modifyGlobalCluster
default CompletableFuture<ModifyGlobalClusterResponse> modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest) Modify a setting for an Amazon Neptune global cluster. You can change one or more database configuration parameters by specifying these parameters and their new values in the request.
- Parameters:
modifyGlobalClusterRequest
-- Returns:
- A Java Future containing the result of the ModifyGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested 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.
- GlobalClusterNotFoundException The
- See Also:
-
modifyGlobalCluster
default CompletableFuture<ModifyGlobalClusterResponse> modifyGlobalCluster(Consumer<ModifyGlobalClusterRequest.Builder> modifyGlobalClusterRequest) Modify a setting for an Amazon Neptune global cluster. You can change one or more database configuration parameters by specifying these parameters and their new values in the request.
This is a convenience which creates an instance of the
ModifyGlobalClusterRequest.Builder
avoiding the need to create one manually viaModifyGlobalClusterRequest.builder()
- Parameters:
modifyGlobalClusterRequest
- AConsumer
that will call methods onModifyGlobalClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested 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.
- GlobalClusterNotFoundException The
- See Also:
-
promoteReadReplicaDBCluster
default CompletableFuture<PromoteReadReplicaDbClusterResponse> promoteReadReplicaDBCluster(PromoteReadReplicaDbClusterRequest promoteReadReplicaDbClusterRequest) Not supported.
- Parameters:
promoteReadReplicaDbClusterRequest
-- Returns:
- A Java Future containing the result of the PromoteReadReplicaDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
promoteReadReplicaDBCluster
default CompletableFuture<PromoteReadReplicaDbClusterResponse> promoteReadReplicaDBCluster(Consumer<PromoteReadReplicaDbClusterRequest.Builder> promoteReadReplicaDbClusterRequest) Not supported.
This is a convenience which creates an instance of the
PromoteReadReplicaDbClusterRequest.Builder
avoiding the need to create one manually viaPromoteReadReplicaDbClusterRequest.builder()
- Parameters:
promoteReadReplicaDbClusterRequest
- AConsumer
that will call methods onPromoteReadReplicaDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PromoteReadReplicaDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
rebootDBInstance
default CompletableFuture<RebootDbInstanceResponse> rebootDBInstance(RebootDbInstanceRequest rebootDbInstanceRequest) You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
- Parameters:
rebootDbInstanceRequest
-- Returns:
- A Java Future containing the result of the RebootDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
rebootDBInstance
default CompletableFuture<RebootDbInstanceResponse> rebootDBInstance(Consumer<RebootDbInstanceRequest.Builder> rebootDbInstanceRequest) You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
This is a convenience which creates an instance of the
RebootDbInstanceRequest.Builder
avoiding the need to create one manually viaRebootDbInstanceRequest.builder()
- Parameters:
rebootDbInstanceRequest
- AConsumer
that will call methods onRebootDbInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RebootDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
removeFromGlobalCluster
default CompletableFuture<RemoveFromGlobalClusterResponse> removeFromGlobalCluster(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest) Detaches a Neptune DB cluster from a Neptune global database. A secondary cluster becomes a normal standalone cluster with read-write capability instead of being read-only, and no longer receives data from a the primary cluster.
- Parameters:
removeFromGlobalClusterRequest
-- Returns:
- A Java Future containing the result of the RemoveFromGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested operation.
- 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.
- GlobalClusterNotFoundException The
- See Also:
-
removeFromGlobalCluster
default CompletableFuture<RemoveFromGlobalClusterResponse> removeFromGlobalCluster(Consumer<RemoveFromGlobalClusterRequest.Builder> removeFromGlobalClusterRequest) Detaches a Neptune DB cluster from a Neptune global database. A secondary cluster becomes a normal standalone cluster with read-write capability instead of being read-only, and no longer receives data from a the primary cluster.
This is a convenience which creates an instance of the
RemoveFromGlobalClusterRequest.Builder
avoiding the need to create one manually viaRemoveFromGlobalClusterRequest.builder()
- Parameters:
removeFromGlobalClusterRequest
- AConsumer
that will call methods onRemoveFromGlobalClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveFromGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested operation.
- 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.
- GlobalClusterNotFoundException The
- See Also:
-
removeRoleFromDBCluster
default CompletableFuture<RemoveRoleFromDbClusterResponse> removeRoleFromDBCluster(RemoveRoleFromDbClusterRequest removeRoleFromDbClusterRequest) Disassociates an Identity and Access Management (IAM) role from a DB cluster.
- Parameters:
removeRoleFromDbClusterRequest
-- Returns:
- A Java Future containing the result of the RemoveRoleFromDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
removeRoleFromDBCluster
default CompletableFuture<RemoveRoleFromDbClusterResponse> removeRoleFromDBCluster(Consumer<RemoveRoleFromDbClusterRequest.Builder> removeRoleFromDbClusterRequest) 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 viaRemoveRoleFromDbClusterRequest.builder()
- Parameters:
removeRoleFromDbClusterRequest
- AConsumer
that will call methods onRemoveRoleFromDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveRoleFromDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
removeSourceIdentifierFromSubscription
default CompletableFuture<RemoveSourceIdentifierFromSubscriptionResponse> removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) Removes a source identifier from an existing event notification subscription.
- Parameters:
removeSourceIdentifierFromSubscriptionRequest
-- Returns:
- A Java Future containing the result of the RemoveSourceIdentifierFromSubscription operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException The designated subscription could not be found.
- SourceNotFoundException The source could not be 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.
- See Also:
-
removeSourceIdentifierFromSubscription
default CompletableFuture<RemoveSourceIdentifierFromSubscriptionResponse> removeSourceIdentifierFromSubscription(Consumer<RemoveSourceIdentifierFromSubscriptionRequest.Builder> removeSourceIdentifierFromSubscriptionRequest) 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 viaRemoveSourceIdentifierFromSubscriptionRequest.builder()
- Parameters:
removeSourceIdentifierFromSubscriptionRequest
- AConsumer
that will call methods onRemoveSourceIdentifierFromSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveSourceIdentifierFromSubscription operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException The designated subscription could not be found.
- SourceNotFoundException The source could not be 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.
- See Also:
-
removeTagsFromResource
default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes metadata tags from an Amazon Neptune resource.
- Parameters:
removeTagsFromResourceRequest
-- Returns:
- A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
removeTagsFromResource
default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) 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 viaRemoveTagsFromResourceRequest.builder()
- Parameters:
removeTagsFromResourceRequest
- AConsumer
that will call methods onRemoveTagsFromResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
resetDBClusterParameterGroup
default CompletableFuture<ResetDbClusterParameterGroupResponse> resetDBClusterParameterGroup(ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following:
ParameterName
andApplyMethod
. To reset the entire DB cluster parameter group, specify theDBClusterParameterGroupName
andResetAllParameters
parameters.When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to
pending-reboot
to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.- Parameters:
resetDbClusterParameterGroupRequest
-- Returns:
- A Java Future containing the result of the ResetDBClusterParameterGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
resetDBClusterParameterGroup
default CompletableFuture<ResetDbClusterParameterGroupResponse> resetDBClusterParameterGroup(Consumer<ResetDbClusterParameterGroupRequest.Builder> resetDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following:
ParameterName
andApplyMethod
. To reset the entire DB cluster parameter group, specify theDBClusterParameterGroupName
andResetAllParameters
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 viaResetDbClusterParameterGroupRequest.builder()
- Parameters:
resetDbClusterParameterGroupRequest
- AConsumer
that will call methods onResetDbClusterParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ResetDBClusterParameterGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
resetDBParameterGroup
default CompletableFuture<ResetDbParameterGroupResponse> resetDBParameterGroup(ResetDbParameterGroupRequest resetDbParameterGroupRequest) Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following:
ParameterName
andApplyMethod
. To reset the entire DB parameter group, specify theDBParameterGroup
name andResetAllParameters
parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set topending-reboot
to take effect on the next DB instance restart orRebootDBInstance
request.- Parameters:
resetDbParameterGroupRequest
-- Returns:
- A Java Future containing the result of the ResetDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
resetDBParameterGroup
default CompletableFuture<ResetDbParameterGroupResponse> resetDBParameterGroup(Consumer<ResetDbParameterGroupRequest.Builder> resetDbParameterGroupRequest) Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following:
ParameterName
andApplyMethod
. To reset the entire DB parameter group, specify theDBParameterGroup
name andResetAllParameters
parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set topending-reboot
to take effect on the next DB instance restart orRebootDBInstance
request.
This is a convenience which creates an instance of the
ResetDbParameterGroupRequest.Builder
avoiding the need to create one manually viaResetDbParameterGroupRequest.builder()
- Parameters:
resetDbParameterGroupRequest
- AConsumer
that will call methods onResetDbParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ResetDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
restoreDBClusterFromSnapshot
default CompletableFuture<RestoreDbClusterFromSnapshotResponse> restoreDBClusterFromSnapshot(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest) Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- Parameters:
restoreDbClusterFromSnapshotRequest
-- Returns:
- A Java Future containing the result of the RestoreDBClusterFromSnapshot operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterAlreadyExistsException User already has a DB cluster with the given identifier.
- DbClusterQuotaExceededException User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- StorageQuotaExceededException Request would result in user exceeding the allowed amount of storage available across all DB instances.
- DbSubnetGroupNotFoundException DBSubnetGroupName does not refer to an existing DB subnet group.
- DbSnapshotNotFoundException DBSnapshotIdentifier does not refer to an existing DB snapshot.
- DbClusterSnapshotNotFoundException DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
- InsufficientDbClusterCapacityException The DB cluster does not have enough capacity for the current operation.
- InsufficientStorageClusterCapacityException There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
- InvalidDbSnapshotStateException The state of the DB snapshot does not allow deletion.
- InvalidDbClusterSnapshotStateException The supplied value is not a valid DB cluster snapshot state.
- StorageQuotaExceededException Request would result in user exceeding the allowed amount of storage available across all DB instances.
- InvalidVpcNetworkStateException DB subnet group does not cover all Availability Zones after it is created because users' change.
- InvalidRestoreException Cannot restore from vpc backup to non-vpc DB instance.
- DbSubnetGroupNotFoundException DBSubnetGroupName does not refer to an existing DB subnet group.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- OptionGroupNotFoundException The designated option group could not be found.
- KmsKeyNotAccessibleException Error accessing KMS key.
- DbClusterParameterGroupNotFoundException DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.
- 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.
- See Also:
-
restoreDBClusterFromSnapshot
default CompletableFuture<RestoreDbClusterFromSnapshotResponse> restoreDBClusterFromSnapshot(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest) Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
This is a convenience which creates an instance of the
RestoreDbClusterFromSnapshotRequest.Builder
avoiding the need to create one manually viaRestoreDbClusterFromSnapshotRequest.builder()
- Parameters:
restoreDbClusterFromSnapshotRequest
- AConsumer
that will call methods onRestoreDbClusterFromSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RestoreDBClusterFromSnapshot operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterAlreadyExistsException User already has a DB cluster with the given identifier.
- DbClusterQuotaExceededException User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- StorageQuotaExceededException Request would result in user exceeding the allowed amount of storage available across all DB instances.
- DbSubnetGroupNotFoundException DBSubnetGroupName does not refer to an existing DB subnet group.
- DbSnapshotNotFoundException DBSnapshotIdentifier does not refer to an existing DB snapshot.
- DbClusterSnapshotNotFoundException DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
- InsufficientDbClusterCapacityException The DB cluster does not have enough capacity for the current operation.
- InsufficientStorageClusterCapacityException There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
- InvalidDbSnapshotStateException The state of the DB snapshot does not allow deletion.
- InvalidDbClusterSnapshotStateException The supplied value is not a valid DB cluster snapshot state.
- StorageQuotaExceededException Request would result in user exceeding the allowed amount of storage available across all DB instances.
- InvalidVpcNetworkStateException DB subnet group does not cover all Availability Zones after it is created because users' change.
- InvalidRestoreException Cannot restore from vpc backup to non-vpc DB instance.
- DbSubnetGroupNotFoundException DBSubnetGroupName does not refer to an existing DB subnet group.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- OptionGroupNotFoundException The designated option group could not be found.
- KmsKeyNotAccessibleException Error accessing KMS key.
- DbClusterParameterGroupNotFoundException DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.
- 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.
- See Also:
-
restoreDBClusterToPointInTime
default CompletableFuture<RestoreDbClusterToPointInTimeResponse> restoreDBClusterToPointInTime(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest) Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime
for up toBackupRetentionPeriod
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 theRestoreDBClusterToPointInTime
action has completed and the DB cluster is available.- Parameters:
restoreDbClusterToPointInTimeRequest
-- Returns:
- A Java Future containing the result of the RestoreDBClusterToPointInTime operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterAlreadyExistsException User already has a DB cluster with the given identifier.
- DbClusterNotFoundException DBClusterIdentifier does not refer to an existing DB cluster.
- DbClusterQuotaExceededException User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- DbClusterSnapshotNotFoundException DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
- DbSubnetGroupNotFoundException DBSubnetGroupName does not refer to an existing DB subnet group.
- InsufficientDbClusterCapacityException The DB cluster does not have enough capacity for the current operation.
- InsufficientStorageClusterCapacityException There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
- InvalidDbClusterSnapshotStateException The supplied value is not a valid DB cluster snapshot state.
- InvalidDbClusterStateException The DB cluster is not in a valid state.
- InvalidDbSnapshotStateException The state of the DB snapshot does not allow deletion.
- InvalidRestoreException Cannot restore from vpc backup to non-vpc DB instance.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVpcNetworkStateException DB subnet group does not cover all Availability Zones after it is created because users' change.
- KmsKeyNotAccessibleException Error accessing KMS key.
- OptionGroupNotFoundException The designated option group could not be found.
- StorageQuotaExceededException Request would result in user exceeding the allowed amount of storage available across all DB instances.
- DbClusterParameterGroupNotFoundException DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.
- 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.
- See Also:
-
restoreDBClusterToPointInTime
default CompletableFuture<RestoreDbClusterToPointInTimeResponse> restoreDBClusterToPointInTime(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest) Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime
for up toBackupRetentionPeriod
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 theRestoreDBClusterToPointInTime
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 viaRestoreDbClusterToPointInTimeRequest.builder()
- Parameters:
restoreDbClusterToPointInTimeRequest
- AConsumer
that will call methods onRestoreDbClusterToPointInTimeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RestoreDBClusterToPointInTime operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterAlreadyExistsException User already has a DB cluster with the given identifier.
- DbClusterNotFoundException DBClusterIdentifier does not refer to an existing DB cluster.
- DbClusterQuotaExceededException User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- DbClusterSnapshotNotFoundException DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
- DbSubnetGroupNotFoundException DBSubnetGroupName does not refer to an existing DB subnet group.
- InsufficientDbClusterCapacityException The DB cluster does not have enough capacity for the current operation.
- InsufficientStorageClusterCapacityException There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
- InvalidDbClusterSnapshotStateException The supplied value is not a valid DB cluster snapshot state.
- InvalidDbClusterStateException The DB cluster is not in a valid state.
- InvalidDbSnapshotStateException The state of the DB snapshot does not allow deletion.
- InvalidRestoreException Cannot restore from vpc backup to non-vpc DB instance.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVpcNetworkStateException DB subnet group does not cover all Availability Zones after it is created because users' change.
- KmsKeyNotAccessibleException Error accessing KMS key.
- OptionGroupNotFoundException The designated option group could not be found.
- StorageQuotaExceededException Request would result in user exceeding the allowed amount of storage available across all DB instances.
- DbClusterParameterGroupNotFoundException DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.
- 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.
- See Also:
-
startDBCluster
default CompletableFuture<StartDbClusterResponse> startDBCluster(StartDbClusterRequest startDbClusterRequest) Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.
- Parameters:
startDbClusterRequest
-- Returns:
- A Java Future containing the result of the StartDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
startDBCluster
default CompletableFuture<StartDbClusterResponse> startDBCluster(Consumer<StartDbClusterRequest.Builder> startDbClusterRequest) Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.
This is a convenience which creates an instance of the
StartDbClusterRequest.Builder
avoiding the need to create one manually viaStartDbClusterRequest.builder()
- Parameters:
startDbClusterRequest
- AConsumer
that will call methods onStartDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
stopDBCluster
default CompletableFuture<StopDbClusterResponse> stopDBCluster(StopDbClusterRequest stopDbClusterRequest) Stops an Amazon Neptune DB cluster. When you stop a DB cluster, Neptune retains the DB cluster's metadata, including its endpoints and DB parameter groups.
Neptune also retains the transaction logs so you can do a point-in-time restore if necessary.
- Parameters:
stopDbClusterRequest
-- Returns:
- A Java Future containing the result of the StopDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
stopDBCluster
default CompletableFuture<StopDbClusterResponse> stopDBCluster(Consumer<StopDbClusterRequest.Builder> stopDbClusterRequest) Stops an Amazon Neptune DB cluster. When you stop a DB cluster, Neptune retains the DB cluster's metadata, including its endpoints and DB parameter groups.
Neptune also retains the transaction logs so you can do a point-in-time restore if necessary.
This is a convenience which creates an instance of the
StopDbClusterRequest.Builder
avoiding the need to create one manually viaStopDbClusterRequest.builder()
- Parameters:
stopDbClusterRequest
- AConsumer
that will call methods onStopDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
waiter
Create an instance ofNeptuneAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
NeptuneAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aNeptuneAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aNeptuneAsyncClient
.
-