Interface NeptuneClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface NeptuneClient extends AwsClient
Service client for accessing Amazon Neptune. This can be created using the staticbuilder()method.Amazon Neptune Amazon Neptune is a fast, reliable, fully-managed graph database service that makes it easy to build and run applications that work with highly connected datasets. The core of Amazon Neptune is a purpose-built, high-performance graph database engine optimized for storing billions of relationships and querying the graph with milliseconds latency. Amazon Neptune supports popular graph models Property Graph and W3C's RDF, and their respective query languages Apache TinkerPop Gremlin and SPARQL, allowing you to easily build queries that efficiently navigate highly connected datasets. Neptune powers graph use cases such as recommendation engines, fraud detection, knowledge graphs, drug discovery, and network security.
This interface reference for Amazon Neptune contains documentation for a programming or command line interface you can use to manage Amazon Neptune. Note that Amazon Neptune is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default AddRoleToDbClusterResponseaddRoleToDBCluster(Consumer<AddRoleToDbClusterRequest.Builder> addRoleToDbClusterRequest)Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.default AddRoleToDbClusterResponseaddRoleToDBCluster(AddRoleToDbClusterRequest addRoleToDbClusterRequest)Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.default AddSourceIdentifierToSubscriptionResponseaddSourceIdentifierToSubscription(Consumer<AddSourceIdentifierToSubscriptionRequest.Builder> addSourceIdentifierToSubscriptionRequest)Adds a source identifier to an existing event notification subscription.default AddSourceIdentifierToSubscriptionResponseaddSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)Adds a source identifier to an existing event notification subscription.default AddTagsToResourceResponseaddTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)Adds metadata tags to an Amazon Neptune resource.default AddTagsToResourceResponseaddTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)Adds metadata tags to an Amazon Neptune resource.default ApplyPendingMaintenanceActionResponseapplyPendingMaintenanceAction(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest)Applies a pending maintenance action to a resource (for example, to a DB instance).default ApplyPendingMaintenanceActionResponseapplyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)Applies a pending maintenance action to a resource (for example, to a DB instance).static NeptuneClientBuilderbuilder()Create a builder that can be used to configure and create aNeptuneClient.default CopyDbClusterParameterGroupResponsecopyDBClusterParameterGroup(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest)Copies the specified DB cluster parameter group.default CopyDbClusterParameterGroupResponsecopyDBClusterParameterGroup(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest)Copies the specified DB cluster parameter group.default CopyDbClusterSnapshotResponsecopyDBClusterSnapshot(Consumer<CopyDbClusterSnapshotRequest.Builder> copyDbClusterSnapshotRequest)Copies a snapshot of a DB cluster.default CopyDbClusterSnapshotResponsecopyDBClusterSnapshot(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest)Copies a snapshot of a DB cluster.default CopyDbParameterGroupResponsecopyDBParameterGroup(Consumer<CopyDbParameterGroupRequest.Builder> copyDbParameterGroupRequest)Copies the specified DB parameter group.default CopyDbParameterGroupResponsecopyDBParameterGroup(CopyDbParameterGroupRequest copyDbParameterGroupRequest)Copies the specified DB parameter group.static NeptuneClientcreate()Create aNeptuneClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateDbClusterResponsecreateDBCluster(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest)Creates a new Amazon Neptune DB cluster.default CreateDbClusterResponsecreateDBCluster(CreateDbClusterRequest createDbClusterRequest)Creates a new Amazon Neptune DB cluster.default CreateDbClusterEndpointResponsecreateDBClusterEndpoint(Consumer<CreateDbClusterEndpointRequest.Builder> createDbClusterEndpointRequest)Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.default CreateDbClusterEndpointResponsecreateDBClusterEndpoint(CreateDbClusterEndpointRequest createDbClusterEndpointRequest)Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.default CreateDbClusterParameterGroupResponsecreateDBClusterParameterGroup(Consumer<CreateDbClusterParameterGroupRequest.Builder> createDbClusterParameterGroupRequest)Creates a new DB cluster parameter group.default CreateDbClusterParameterGroupResponsecreateDBClusterParameterGroup(CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest)Creates a new DB cluster parameter group.default CreateDbClusterSnapshotResponsecreateDBClusterSnapshot(Consumer<CreateDbClusterSnapshotRequest.Builder> createDbClusterSnapshotRequest)Creates a snapshot of a DB cluster.default CreateDbClusterSnapshotResponsecreateDBClusterSnapshot(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest)Creates a snapshot of a DB cluster.default CreateDbInstanceResponsecreateDBInstance(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest)Creates a new DB instance.default CreateDbInstanceResponsecreateDBInstance(CreateDbInstanceRequest createDbInstanceRequest)Creates a new DB instance.default CreateDbParameterGroupResponsecreateDBParameterGroup(Consumer<CreateDbParameterGroupRequest.Builder> createDbParameterGroupRequest)Creates a new DB parameter group.default CreateDbParameterGroupResponsecreateDBParameterGroup(CreateDbParameterGroupRequest createDbParameterGroupRequest)Creates a new DB parameter group.default CreateDbSubnetGroupResponsecreateDBSubnetGroup(Consumer<CreateDbSubnetGroupRequest.Builder> createDbSubnetGroupRequest)Creates a new DB subnet group.default CreateDbSubnetGroupResponsecreateDBSubnetGroup(CreateDbSubnetGroupRequest createDbSubnetGroupRequest)Creates a new DB subnet group.default CreateEventSubscriptionResponsecreateEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest)Creates an event notification subscription.default CreateEventSubscriptionResponsecreateEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)Creates an event notification subscription.default CreateGlobalClusterResponsecreateGlobalCluster(Consumer<CreateGlobalClusterRequest.Builder> createGlobalClusterRequest)Creates a Neptune global database spread across multiple Amazon Regions.default CreateGlobalClusterResponsecreateGlobalCluster(CreateGlobalClusterRequest createGlobalClusterRequest)Creates a Neptune global database spread across multiple Amazon Regions.default DeleteDbClusterResponsedeleteDBCluster(Consumer<DeleteDbClusterRequest.Builder> deleteDbClusterRequest)The DeleteDBCluster action deletes a previously provisioned DB cluster.default DeleteDbClusterResponsedeleteDBCluster(DeleteDbClusterRequest deleteDbClusterRequest)The DeleteDBCluster action deletes a previously provisioned DB cluster.default DeleteDbClusterEndpointResponsedeleteDBClusterEndpoint(Consumer<DeleteDbClusterEndpointRequest.Builder> deleteDbClusterEndpointRequest)Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.default DeleteDbClusterEndpointResponsedeleteDBClusterEndpoint(DeleteDbClusterEndpointRequest deleteDbClusterEndpointRequest)Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.default DeleteDbClusterParameterGroupResponsedeleteDBClusterParameterGroup(Consumer<DeleteDbClusterParameterGroupRequest.Builder> deleteDbClusterParameterGroupRequest)Deletes a specified DB cluster parameter group.default DeleteDbClusterParameterGroupResponsedeleteDBClusterParameterGroup(DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest)Deletes a specified DB cluster parameter group.default DeleteDbClusterSnapshotResponsedeleteDBClusterSnapshot(Consumer<DeleteDbClusterSnapshotRequest.Builder> deleteDbClusterSnapshotRequest)Deletes a DB cluster snapshot.default DeleteDbClusterSnapshotResponsedeleteDBClusterSnapshot(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest)Deletes a DB cluster snapshot.default DeleteDbInstanceResponsedeleteDBInstance(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest)The DeleteDBInstance action deletes a previously provisioned DB instance.default DeleteDbInstanceResponsedeleteDBInstance(DeleteDbInstanceRequest deleteDbInstanceRequest)The DeleteDBInstance action deletes a previously provisioned DB instance.default DeleteDbParameterGroupResponsedeleteDBParameterGroup(Consumer<DeleteDbParameterGroupRequest.Builder> deleteDbParameterGroupRequest)Deletes a specified DBParameterGroup.default DeleteDbParameterGroupResponsedeleteDBParameterGroup(DeleteDbParameterGroupRequest deleteDbParameterGroupRequest)Deletes a specified DBParameterGroup.default DeleteDbSubnetGroupResponsedeleteDBSubnetGroup(Consumer<DeleteDbSubnetGroupRequest.Builder> deleteDbSubnetGroupRequest)Deletes a DB subnet group.default DeleteDbSubnetGroupResponsedeleteDBSubnetGroup(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest)Deletes a DB subnet group.default DeleteEventSubscriptionResponsedeleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest)Deletes an event notification subscription.default DeleteEventSubscriptionResponsedeleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)Deletes an event notification subscription.default DeleteGlobalClusterResponsedeleteGlobalCluster(Consumer<DeleteGlobalClusterRequest.Builder> deleteGlobalClusterRequest)Deletes a global database.default DeleteGlobalClusterResponsedeleteGlobalCluster(DeleteGlobalClusterRequest deleteGlobalClusterRequest)Deletes a global database.default DescribeDbClusterEndpointsResponsedescribeDBClusterEndpoints(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest)Returns information about endpoints for an Amazon Neptune DB cluster.default DescribeDbClusterEndpointsResponsedescribeDBClusterEndpoints(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest)Returns information about endpoints for an Amazon Neptune DB cluster.default DescribeDBClusterEndpointsIterabledescribeDBClusterEndpointsPaginator(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest)Returns information about endpoints for an Amazon Neptune DB cluster.default DescribeDBClusterEndpointsIterabledescribeDBClusterEndpointsPaginator(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest)Returns information about endpoints for an Amazon Neptune DB cluster.default DescribeDbClusterParameterGroupsResponsedescribeDBClusterParameterGroups()Returns a list ofDBClusterParameterGroupdescriptions.default DescribeDbClusterParameterGroupsResponsedescribeDBClusterParameterGroups(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest)Returns a list ofDBClusterParameterGroupdescriptions.default DescribeDbClusterParameterGroupsResponsedescribeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest)Returns a list ofDBClusterParameterGroupdescriptions.default DescribeDBClusterParameterGroupsIterabledescribeDBClusterParameterGroupsPaginator()Returns a list ofDBClusterParameterGroupdescriptions.default DescribeDBClusterParameterGroupsIterabledescribeDBClusterParameterGroupsPaginator(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest)Returns a list ofDBClusterParameterGroupdescriptions.default DescribeDBClusterParameterGroupsIterabledescribeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest)Returns a list ofDBClusterParameterGroupdescriptions.default DescribeDbClusterParametersResponsedescribeDBClusterParameters(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest)Returns the detailed parameter list for a particular DB cluster parameter group.default DescribeDbClusterParametersResponsedescribeDBClusterParameters(DescribeDbClusterParametersRequest describeDbClusterParametersRequest)Returns the detailed parameter list for a particular DB cluster parameter group.default DescribeDBClusterParametersIterabledescribeDBClusterParametersPaginator(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest)Returns the detailed parameter list for a particular DB cluster parameter group.default DescribeDBClusterParametersIterabledescribeDBClusterParametersPaginator(DescribeDbClusterParametersRequest describeDbClusterParametersRequest)Returns the detailed parameter list for a particular DB cluster parameter group.default DescribeDbClustersResponsedescribeDBClusters()Returns information about provisioned DB clusters, and supports pagination.default DescribeDbClustersResponsedescribeDBClusters(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest)Returns information about provisioned DB clusters, and supports pagination.default DescribeDbClustersResponsedescribeDBClusters(DescribeDbClustersRequest describeDbClustersRequest)Returns information about provisioned DB clusters, and supports pagination.default DescribeDbClusterSnapshotAttributesResponsedescribeDBClusterSnapshotAttributes(Consumer<DescribeDbClusterSnapshotAttributesRequest.Builder> describeDbClusterSnapshotAttributesRequest)Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.default DescribeDbClusterSnapshotAttributesResponsedescribeDBClusterSnapshotAttributes(DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest)Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.default DescribeDbClusterSnapshotsResponsedescribeDBClusterSnapshots()Returns information about DB cluster snapshots.default DescribeDbClusterSnapshotsResponsedescribeDBClusterSnapshots(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest)Returns information about DB cluster snapshots.default DescribeDbClusterSnapshotsResponsedescribeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest)Returns information about DB cluster snapshots.default DescribeDBClusterSnapshotsIterabledescribeDBClusterSnapshotsPaginator()Returns information about DB cluster snapshots.default DescribeDBClusterSnapshotsIterabledescribeDBClusterSnapshotsPaginator(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest)Returns information about DB cluster snapshots.default DescribeDBClusterSnapshotsIterabledescribeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest)Returns information about DB cluster snapshots.default DescribeDBClustersIterabledescribeDBClustersPaginator()Returns information about provisioned DB clusters, and supports pagination.default DescribeDBClustersIterabledescribeDBClustersPaginator(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest)Returns information about provisioned DB clusters, and supports pagination.default DescribeDBClustersIterabledescribeDBClustersPaginator(DescribeDbClustersRequest describeDbClustersRequest)Returns information about provisioned DB clusters, and supports pagination.default DescribeDbEngineVersionsResponsedescribeDBEngineVersions()Returns a list of the available DB engines.default DescribeDbEngineVersionsResponsedescribeDBEngineVersions(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest)Returns a list of the available DB engines.default DescribeDbEngineVersionsResponsedescribeDBEngineVersions(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest)Returns a list of the available DB engines.default DescribeDBEngineVersionsIterabledescribeDBEngineVersionsPaginator()Returns a list of the available DB engines.default DescribeDBEngineVersionsIterabledescribeDBEngineVersionsPaginator(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest)Returns a list of the available DB engines.default DescribeDBEngineVersionsIterabledescribeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest)Returns a list of the available DB engines.default DescribeDbInstancesResponsedescribeDBInstances()Returns information about provisioned instances, and supports pagination.default DescribeDbInstancesResponsedescribeDBInstances(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest)Returns information about provisioned instances, and supports pagination.default DescribeDbInstancesResponsedescribeDBInstances(DescribeDbInstancesRequest describeDbInstancesRequest)Returns information about provisioned instances, and supports pagination.default DescribeDBInstancesIterabledescribeDBInstancesPaginator()Returns information about provisioned instances, and supports pagination.default DescribeDBInstancesIterabledescribeDBInstancesPaginator(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest)Returns information about provisioned instances, and supports pagination.default DescribeDBInstancesIterabledescribeDBInstancesPaginator(DescribeDbInstancesRequest describeDbInstancesRequest)Returns information about provisioned instances, and supports pagination.default DescribeDbParameterGroupsResponsedescribeDBParameterGroups()Returns a list ofDBParameterGroupdescriptions.default DescribeDbParameterGroupsResponsedescribeDBParameterGroups(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest)Returns a list ofDBParameterGroupdescriptions.default DescribeDbParameterGroupsResponsedescribeDBParameterGroups(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest)Returns a list ofDBParameterGroupdescriptions.default DescribeDBParameterGroupsIterabledescribeDBParameterGroupsPaginator()Returns a list ofDBParameterGroupdescriptions.default DescribeDBParameterGroupsIterabledescribeDBParameterGroupsPaginator(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest)Returns a list ofDBParameterGroupdescriptions.default DescribeDBParameterGroupsIterabledescribeDBParameterGroupsPaginator(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest)Returns a list ofDBParameterGroupdescriptions.default DescribeDbParametersResponsedescribeDBParameters(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest)Returns the detailed parameter list for a particular DB parameter group.default DescribeDbParametersResponsedescribeDBParameters(DescribeDbParametersRequest describeDbParametersRequest)Returns the detailed parameter list for a particular DB parameter group.default DescribeDBParametersIterabledescribeDBParametersPaginator(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest)Returns the detailed parameter list for a particular DB parameter group.default DescribeDBParametersIterabledescribeDBParametersPaginator(DescribeDbParametersRequest describeDbParametersRequest)Returns the detailed parameter list for a particular DB parameter group.default DescribeDbSubnetGroupsResponsedescribeDBSubnetGroups()Returns a list of DBSubnetGroup descriptions.default DescribeDbSubnetGroupsResponsedescribeDBSubnetGroups(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest)Returns a list of DBSubnetGroup descriptions.default DescribeDbSubnetGroupsResponsedescribeDBSubnetGroups(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest)Returns a list of DBSubnetGroup descriptions.default DescribeDBSubnetGroupsIterabledescribeDBSubnetGroupsPaginator()Returns a list of DBSubnetGroup descriptions.default DescribeDBSubnetGroupsIterabledescribeDBSubnetGroupsPaginator(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest)Returns a list of DBSubnetGroup descriptions.default DescribeDBSubnetGroupsIterabledescribeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest)Returns a list of DBSubnetGroup descriptions.default DescribeEngineDefaultClusterParametersResponsedescribeEngineDefaultClusterParameters(Consumer<DescribeEngineDefaultClusterParametersRequest.Builder> describeEngineDefaultClusterParametersRequest)Returns the default engine and system parameter information for the cluster database engine.default DescribeEngineDefaultClusterParametersResponsedescribeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest)Returns the default engine and system parameter information for the cluster database engine.default DescribeEngineDefaultParametersResponsedescribeEngineDefaultParameters(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest)Returns the default engine and system parameter information for the specified database engine.default DescribeEngineDefaultParametersResponsedescribeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)Returns the default engine and system parameter information for the specified database engine.default DescribeEngineDefaultParametersIterabledescribeEngineDefaultParametersPaginator(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest)Returns the default engine and system parameter information for the specified database engine.default DescribeEngineDefaultParametersIterabledescribeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)Returns the default engine and system parameter information for the specified database engine.default DescribeEventCategoriesResponsedescribeEventCategories()Displays a list of categories for all event source types, or, if specified, for a specified source type.default DescribeEventCategoriesResponsedescribeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest)Displays a list of categories for all event source types, or, if specified, for a specified source type.default DescribeEventCategoriesResponsedescribeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)Displays a list of categories for all event source types, or, if specified, for a specified source type.default DescribeEventsResponsedescribeEvents()Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days.default DescribeEventsResponsedescribeEvents(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 DescribeEventsResponsedescribeEvents(DescribeEventsRequest describeEventsRequest)Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days.default DescribeEventsIterabledescribeEventsPaginator()Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days.default DescribeEventsIterabledescribeEventsPaginator(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 DescribeEventsIterabledescribeEventsPaginator(DescribeEventsRequest describeEventsRequest)Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days.default DescribeEventSubscriptionsResponsedescribeEventSubscriptions()Lists all the subscription descriptions for a customer account.default DescribeEventSubscriptionsResponsedescribeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest)Lists all the subscription descriptions for a customer account.default DescribeEventSubscriptionsResponsedescribeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)Lists all the subscription descriptions for a customer account.default DescribeEventSubscriptionsIterabledescribeEventSubscriptionsPaginator()Lists all the subscription descriptions for a customer account.default DescribeEventSubscriptionsIterabledescribeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest)Lists all the subscription descriptions for a customer account.default DescribeEventSubscriptionsIterabledescribeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)Lists all the subscription descriptions for a customer account.default DescribeGlobalClustersResponsedescribeGlobalClusters(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest)Returns information about Neptune global database clusters.default DescribeGlobalClustersResponsedescribeGlobalClusters(DescribeGlobalClustersRequest describeGlobalClustersRequest)Returns information about Neptune global database clusters.default DescribeGlobalClustersIterabledescribeGlobalClustersPaginator(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest)Returns information about Neptune global database clusters.default DescribeGlobalClustersIterabledescribeGlobalClustersPaginator(DescribeGlobalClustersRequest describeGlobalClustersRequest)Returns information about Neptune global database clusters.default DescribeOrderableDbInstanceOptionsResponsedescribeOrderableDBInstanceOptions(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest)Returns a list of orderable DB instance options for the specified engine.default DescribeOrderableDbInstanceOptionsResponsedescribeOrderableDBInstanceOptions(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest)Returns a list of orderable DB instance options for the specified engine.default DescribeOrderableDBInstanceOptionsIterabledescribeOrderableDBInstanceOptionsPaginator(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest)Returns a list of orderable DB instance options for the specified engine.default DescribeOrderableDBInstanceOptionsIterabledescribeOrderableDBInstanceOptionsPaginator(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest)Returns a list of orderable DB instance options for the specified engine.default DescribePendingMaintenanceActionsResponsedescribePendingMaintenanceActions()Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.default DescribePendingMaintenanceActionsResponsedescribePendingMaintenanceActions(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest)Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.default DescribePendingMaintenanceActionsResponsedescribePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.default DescribePendingMaintenanceActionsIterabledescribePendingMaintenanceActionsPaginator()Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.default DescribePendingMaintenanceActionsIterabledescribePendingMaintenanceActionsPaginator(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest)Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.default DescribePendingMaintenanceActionsIterabledescribePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.default DescribeValidDbInstanceModificationsResponsedescribeValidDBInstanceModifications(Consumer<DescribeValidDbInstanceModificationsRequest.Builder> describeValidDbInstanceModificationsRequest)You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance.default DescribeValidDbInstanceModificationsResponsedescribeValidDBInstanceModifications(DescribeValidDbInstanceModificationsRequest describeValidDbInstanceModificationsRequest)You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance.default FailoverDbClusterResponsefailoverDBCluster(Consumer<FailoverDbClusterRequest.Builder> failoverDbClusterRequest)Forces a failover for a DB cluster.default FailoverDbClusterResponsefailoverDBCluster(FailoverDbClusterRequest failoverDbClusterRequest)Forces a failover for a DB cluster.default FailoverGlobalClusterResponsefailoverGlobalCluster(Consumer<FailoverGlobalClusterRequest.Builder> failoverGlobalClusterRequest)Initiates the failover process for a Neptune global database.default FailoverGlobalClusterResponsefailoverGlobalCluster(FailoverGlobalClusterRequest failoverGlobalClusterRequest)Initiates the failover process for a Neptune global database.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Lists all tags on an Amazon Neptune resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Lists all tags on an Amazon Neptune resource.default ModifyDbClusterResponsemodifyDBCluster(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest)Modify a setting for a DB cluster.default ModifyDbClusterResponsemodifyDBCluster(ModifyDbClusterRequest modifyDbClusterRequest)Modify a setting for a DB cluster.default ModifyDbClusterEndpointResponsemodifyDBClusterEndpoint(Consumer<ModifyDbClusterEndpointRequest.Builder> modifyDbClusterEndpointRequest)Modifies the properties of an endpoint in an Amazon Neptune DB cluster.default ModifyDbClusterEndpointResponsemodifyDBClusterEndpoint(ModifyDbClusterEndpointRequest modifyDbClusterEndpointRequest)Modifies the properties of an endpoint in an Amazon Neptune DB cluster.default ModifyDbClusterParameterGroupResponsemodifyDBClusterParameterGroup(Consumer<ModifyDbClusterParameterGroupRequest.Builder> modifyDbClusterParameterGroupRequest)Modifies the parameters of a DB cluster parameter group.default ModifyDbClusterParameterGroupResponsemodifyDBClusterParameterGroup(ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest)Modifies the parameters of a DB cluster parameter group.default ModifyDbClusterSnapshotAttributeResponsemodifyDBClusterSnapshotAttribute(Consumer<ModifyDbClusterSnapshotAttributeRequest.Builder> modifyDbClusterSnapshotAttributeRequest)Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.default ModifyDbClusterSnapshotAttributeResponsemodifyDBClusterSnapshotAttribute(ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest)Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.default ModifyDbInstanceResponsemodifyDBInstance(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest)Modifies settings for a DB instance.default ModifyDbInstanceResponsemodifyDBInstance(ModifyDbInstanceRequest modifyDbInstanceRequest)Modifies settings for a DB instance.default ModifyDbParameterGroupResponsemodifyDBParameterGroup(Consumer<ModifyDbParameterGroupRequest.Builder> modifyDbParameterGroupRequest)Modifies the parameters of a DB parameter group.default ModifyDbParameterGroupResponsemodifyDBParameterGroup(ModifyDbParameterGroupRequest modifyDbParameterGroupRequest)Modifies the parameters of a DB parameter group.default ModifyDbSubnetGroupResponsemodifyDBSubnetGroup(Consumer<ModifyDbSubnetGroupRequest.Builder> modifyDbSubnetGroupRequest)Modifies an existing DB subnet group.default ModifyDbSubnetGroupResponsemodifyDBSubnetGroup(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest)Modifies an existing DB subnet group.default ModifyEventSubscriptionResponsemodifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest)Modifies an existing event notification subscription.default ModifyEventSubscriptionResponsemodifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)Modifies an existing event notification subscription.default ModifyGlobalClusterResponsemodifyGlobalCluster(Consumer<ModifyGlobalClusterRequest.Builder> modifyGlobalClusterRequest)Modify a setting for an Amazon Neptune global cluster.default ModifyGlobalClusterResponsemodifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest)Modify a setting for an Amazon Neptune global cluster.default PromoteReadReplicaDbClusterResponsepromoteReadReplicaDBCluster(Consumer<PromoteReadReplicaDbClusterRequest.Builder> promoteReadReplicaDbClusterRequest)Not supported.default PromoteReadReplicaDbClusterResponsepromoteReadReplicaDBCluster(PromoteReadReplicaDbClusterRequest promoteReadReplicaDbClusterRequest)Not supported.default RebootDbInstanceResponserebootDBInstance(Consumer<RebootDbInstanceRequest.Builder> rebootDbInstanceRequest)You might need to reboot your DB instance, usually for maintenance reasons.default RebootDbInstanceResponserebootDBInstance(RebootDbInstanceRequest rebootDbInstanceRequest)You might need to reboot your DB instance, usually for maintenance reasons.default RemoveFromGlobalClusterResponseremoveFromGlobalCluster(Consumer<RemoveFromGlobalClusterRequest.Builder> removeFromGlobalClusterRequest)Detaches a Neptune DB cluster from a Neptune global database.default RemoveFromGlobalClusterResponseremoveFromGlobalCluster(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest)Detaches a Neptune DB cluster from a Neptune global database.default RemoveRoleFromDbClusterResponseremoveRoleFromDBCluster(Consumer<RemoveRoleFromDbClusterRequest.Builder> removeRoleFromDbClusterRequest)Disassociates an Identity and Access Management (IAM) role from a DB cluster.default RemoveRoleFromDbClusterResponseremoveRoleFromDBCluster(RemoveRoleFromDbClusterRequest removeRoleFromDbClusterRequest)Disassociates an Identity and Access Management (IAM) role from a DB cluster.default RemoveSourceIdentifierFromSubscriptionResponseremoveSourceIdentifierFromSubscription(Consumer<RemoveSourceIdentifierFromSubscriptionRequest.Builder> removeSourceIdentifierFromSubscriptionRequest)Removes a source identifier from an existing event notification subscription.default RemoveSourceIdentifierFromSubscriptionResponseremoveSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest)Removes a source identifier from an existing event notification subscription.default RemoveTagsFromResourceResponseremoveTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)Removes metadata tags from an Amazon Neptune resource.default RemoveTagsFromResourceResponseremoveTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)Removes metadata tags from an Amazon Neptune resource.default ResetDbClusterParameterGroupResponseresetDBClusterParameterGroup(Consumer<ResetDbClusterParameterGroupRequest.Builder> resetDbClusterParameterGroupRequest)Modifies the parameters of a DB cluster parameter group to the default value.default ResetDbClusterParameterGroupResponseresetDBClusterParameterGroup(ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest)Modifies the parameters of a DB cluster parameter group to the default value.default ResetDbParameterGroupResponseresetDBParameterGroup(Consumer<ResetDbParameterGroupRequest.Builder> resetDbParameterGroupRequest)Modifies the parameters of a DB parameter group to the engine/system default value.default ResetDbParameterGroupResponseresetDBParameterGroup(ResetDbParameterGroupRequest resetDbParameterGroupRequest)Modifies the parameters of a DB parameter group to the engine/system default value.default RestoreDbClusterFromSnapshotResponserestoreDBClusterFromSnapshot(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest)Creates a new DB cluster from a DB snapshot or DB cluster snapshot.default RestoreDbClusterFromSnapshotResponserestoreDBClusterFromSnapshot(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest)Creates a new DB cluster from a DB snapshot or DB cluster snapshot.default RestoreDbClusterToPointInTimeResponserestoreDBClusterToPointInTime(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest)Restores a DB cluster to an arbitrary point in time.default RestoreDbClusterToPointInTimeResponserestoreDBClusterToPointInTime(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest)Restores a DB cluster to an arbitrary point in time.default NeptuneServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartDbClusterResponsestartDBCluster(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 StartDbClusterResponsestartDBCluster(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 StopDbClusterResponsestopDBCluster(Consumer<StopDbClusterRequest.Builder> stopDbClusterRequest)Stops an Amazon Neptune DB cluster.default StopDbClusterResponsestopDBCluster(StopDbClusterRequest stopDbClusterRequest)Stops an Amazon Neptune DB cluster.default NeptuneWaiterwaiter()Create an instance ofNeptuneWaiterusing this client.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
addRoleToDBCluster
default AddRoleToDbClusterResponse addRoleToDBCluster(AddRoleToDbClusterRequest addRoleToDbClusterRequest) throws DbClusterNotFoundException, DbClusterRoleAlreadyExistsException, InvalidDbClusterStateException, DbClusterRoleQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException
Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.
- Parameters:
addRoleToDbClusterRequest-- Returns:
- Result of the AddRoleToDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.DbClusterRoleAlreadyExistsException- The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.InvalidDbClusterStateException- The DB cluster is not in a valid state.DbClusterRoleQuotaExceededException- You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
addRoleToDBCluster
default AddRoleToDbClusterResponse addRoleToDBCluster(Consumer<AddRoleToDbClusterRequest.Builder> addRoleToDbClusterRequest) throws DbClusterNotFoundException, DbClusterRoleAlreadyExistsException, InvalidDbClusterStateException, DbClusterRoleQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException
Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.
This is a convenience which creates an instance of the
AddRoleToDbClusterRequest.Builderavoiding the need to create one manually viaAddRoleToDbClusterRequest.builder()- Parameters:
addRoleToDbClusterRequest- AConsumerthat will call methods onAddRoleToDbClusterRequest.Builderto create a request.- Returns:
- Result of the AddRoleToDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.DbClusterRoleAlreadyExistsException- The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.InvalidDbClusterStateException- The DB cluster is not in a valid state.DbClusterRoleQuotaExceededException- You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
addSourceIdentifierToSubscription
default AddSourceIdentifierToSubscriptionResponse addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Adds a source identifier to an existing event notification subscription.
- Parameters:
addSourceIdentifierToSubscriptionRequest-- Returns:
- Result of the AddSourceIdentifierToSubscription operation returned by the service.
- Throws:
SubscriptionNotFoundException- The designated subscription could not be found.SourceNotFoundException- The source could not be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
addSourceIdentifierToSubscription
default AddSourceIdentifierToSubscriptionResponse addSourceIdentifierToSubscription(Consumer<AddSourceIdentifierToSubscriptionRequest.Builder> addSourceIdentifierToSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Adds a source identifier to an existing event notification subscription.
This is a convenience which creates an instance of the
AddSourceIdentifierToSubscriptionRequest.Builderavoiding the need to create one manually viaAddSourceIdentifierToSubscriptionRequest.builder()- Parameters:
addSourceIdentifierToSubscriptionRequest- AConsumerthat will call methods onAddSourceIdentifierToSubscriptionRequest.Builderto create a request.- Returns:
- Result of the AddSourceIdentifierToSubscription operation returned by the service.
- Throws:
SubscriptionNotFoundException- The designated subscription could not be found.SourceNotFoundException- The source could not be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
addTagsToResource
default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Adds metadata tags to an Amazon Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune.
- Parameters:
addTagsToResourceRequest-- Returns:
- Result of the AddTagsToResource operation returned by the service.
- Throws:
DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.DbSnapshotNotFoundException- DBSnapshotIdentifier does not refer to an existing DB snapshot.DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
addTagsToResource
default AddTagsToResourceResponse addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Adds metadata tags to an Amazon Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune.
This is a convenience which creates an instance of the
AddTagsToResourceRequest.Builderavoiding the need to create one manually viaAddTagsToResourceRequest.builder()- Parameters:
addTagsToResourceRequest- AConsumerthat will call methods onAddTagsToResourceRequest.Builderto create a request.- Returns:
- Result of the AddTagsToResource operation returned by the service.
- Throws:
DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.DbSnapshotNotFoundException- DBSnapshotIdentifier does not refer to an existing DB snapshot.DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
applyPendingMaintenanceAction
default ApplyPendingMaintenanceActionResponse applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Applies a pending maintenance action to a resource (for example, to a DB instance).
- Parameters:
applyPendingMaintenanceActionRequest-- Returns:
- Result of the ApplyPendingMaintenanceAction operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource ID was not found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
applyPendingMaintenanceAction
default ApplyPendingMaintenanceActionResponse applyPendingMaintenanceAction(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Applies a pending maintenance action to a resource (for example, to a DB instance).
This is a convenience which creates an instance of the
ApplyPendingMaintenanceActionRequest.Builderavoiding the need to create one manually viaApplyPendingMaintenanceActionRequest.builder()- Parameters:
applyPendingMaintenanceActionRequest- AConsumerthat will call methods onApplyPendingMaintenanceActionRequest.Builderto create a request.- Returns:
- Result of the ApplyPendingMaintenanceAction operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource ID was not found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
copyDBClusterParameterGroup
default CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException
Copies the specified DB cluster parameter group.
- Parameters:
copyDbClusterParameterGroupRequest-- Returns:
- Result of the CopyDBClusterParameterGroup operation returned by the service.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.DbParameterGroupQuotaExceededException- Request would result in user exceeding the allowed number of DB parameter groups.DbParameterGroupAlreadyExistsException- A DB parameter group with the same name exists.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
copyDBClusterParameterGroup
default CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException
Copies the specified DB cluster parameter group.
This is a convenience which creates an instance of the
CopyDbClusterParameterGroupRequest.Builderavoiding the need to create one manually viaCopyDbClusterParameterGroupRequest.builder()- Parameters:
copyDbClusterParameterGroupRequest- AConsumerthat will call methods onCopyDbClusterParameterGroupRequest.Builderto create a request.- Returns:
- Result of the CopyDBClusterParameterGroup operation returned by the service.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.DbParameterGroupQuotaExceededException- Request would result in user exceeding the allowed number of DB parameter groups.DbParameterGroupAlreadyExistsException- A DB parameter group with the same name exists.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
copyDBClusterSnapshot
default CopyDbClusterSnapshotResponse copyDBClusterSnapshot(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, DbClusterSnapshotNotFoundException, InvalidDbClusterStateException, InvalidDbClusterSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, NeptuneException
Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot,
SourceDBClusterSnapshotIdentifiermust be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.- Parameters:
copyDbClusterSnapshotRequest-- Returns:
- Result of the CopyDBClusterSnapshot operation returned by the service.
- Throws:
DbClusterSnapshotAlreadyExistsException- User already has a DB cluster snapshot with the given identifier.DbClusterSnapshotNotFoundException- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.InvalidDbClusterStateException- The DB cluster is not in a valid state.InvalidDbClusterSnapshotStateException- The supplied value is not a valid DB cluster snapshot state.SnapshotQuotaExceededException- Request would result in user exceeding the allowed number of DB snapshots.KmsKeyNotAccessibleException- Error accessing KMS key.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
copyDBClusterSnapshot
default CopyDbClusterSnapshotResponse copyDBClusterSnapshot(Consumer<CopyDbClusterSnapshotRequest.Builder> copyDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, DbClusterSnapshotNotFoundException, InvalidDbClusterStateException, InvalidDbClusterSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, NeptuneException
Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot,
SourceDBClusterSnapshotIdentifiermust be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
This is a convenience which creates an instance of the
CopyDbClusterSnapshotRequest.Builderavoiding the need to create one manually viaCopyDbClusterSnapshotRequest.builder()- Parameters:
copyDbClusterSnapshotRequest- AConsumerthat will call methods onCopyDbClusterSnapshotRequest.Builderto create a request.- Returns:
- Result of the CopyDBClusterSnapshot operation returned by the service.
- Throws:
DbClusterSnapshotAlreadyExistsException- User already has a DB cluster snapshot with the given identifier.DbClusterSnapshotNotFoundException- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.InvalidDbClusterStateException- The DB cluster is not in a valid state.InvalidDbClusterSnapshotStateException- The supplied value is not a valid DB cluster snapshot state.SnapshotQuotaExceededException- Request would result in user exceeding the allowed number of DB snapshots.KmsKeyNotAccessibleException- Error accessing KMS key.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
copyDBParameterGroup
default CopyDbParameterGroupResponse copyDBParameterGroup(CopyDbParameterGroupRequest copyDbParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupAlreadyExistsException, DbParameterGroupQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException
Copies the specified DB parameter group.
- Parameters:
copyDbParameterGroupRequest-- Returns:
- Result of the CopyDBParameterGroup operation returned by the service.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.DbParameterGroupAlreadyExistsException- A DB parameter group with the same name exists.DbParameterGroupQuotaExceededException- Request would result in user exceeding the allowed number of DB parameter groups.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
copyDBParameterGroup
default CopyDbParameterGroupResponse copyDBParameterGroup(Consumer<CopyDbParameterGroupRequest.Builder> copyDbParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupAlreadyExistsException, DbParameterGroupQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException
Copies the specified DB parameter group.
This is a convenience which creates an instance of the
CopyDbParameterGroupRequest.Builderavoiding the need to create one manually viaCopyDbParameterGroupRequest.builder()- Parameters:
copyDbParameterGroupRequest- AConsumerthat will call methods onCopyDbParameterGroupRequest.Builderto create a request.- Returns:
- Result of the CopyDBParameterGroup operation returned by the service.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.DbParameterGroupAlreadyExistsException- A DB parameter group with the same name exists.DbParameterGroupQuotaExceededException- Request would result in user exceeding the allowed number of DB parameter groups.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDBCluster
default CreateDbClusterResponse createDBCluster(CreateDbClusterRequest createDbClusterRequest) throws DbClusterAlreadyExistsException, InsufficientStorageClusterCapacityException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidDbInstanceStateException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException, DbInstanceNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, NeptuneException
Creates a new Amazon Neptune DB cluster.
You can use the
ReplicationSourceIdentifierparameter 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
CreateDBClusterdirectly, 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 itsDeletionProtectionfield is set tofalse.- Parameters:
createDbClusterRequest-- Returns:
- Result of the CreateDBCluster operation returned by the service.
- Throws:
DbClusterAlreadyExistsException- User already has a DB cluster with the given identifier.InsufficientStorageClusterCapacityException- There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.DbClusterQuotaExceededException- User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.StorageQuotaExceededException- Request would result in user exceeding the allowed amount of storage available across all DB instances.DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.InvalidVpcNetworkStateException- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidDbClusterStateException- The DB cluster is not in a valid state.InvalidDbSubnetGroupStateException- The DB subnet group cannot be deleted because it is in use.InvalidSubnetException- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidDbInstanceStateException- The specified DB instance is not in the available state.DbClusterParameterGroupNotFoundException- DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.KmsKeyNotAccessibleException- Error accessing KMS key.DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.DbSubnetGroupDoesNotCoverEnoughAZsException- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn'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.AwsServiceException- See Also:
- AWS API Documentation
-
createDBCluster
default CreateDbClusterResponse createDBCluster(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest) throws DbClusterAlreadyExistsException, InsufficientStorageClusterCapacityException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidDbInstanceStateException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException, DbInstanceNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, NeptuneException
Creates a new Amazon Neptune DB cluster.
You can use the
ReplicationSourceIdentifierparameter 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
CreateDBClusterdirectly, 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 itsDeletionProtectionfield is set tofalse.
This is a convenience which creates an instance of the
CreateDbClusterRequest.Builderavoiding the need to create one manually viaCreateDbClusterRequest.builder()- Parameters:
createDbClusterRequest- AConsumerthat will call methods onCreateDbClusterRequest.Builderto create a request.- Returns:
- Result of the CreateDBCluster operation returned by the service.
- Throws:
DbClusterAlreadyExistsException- User already has a DB cluster with the given identifier.InsufficientStorageClusterCapacityException- There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.DbClusterQuotaExceededException- User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.StorageQuotaExceededException- Request would result in user exceeding the allowed amount of storage available across all DB instances.DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.InvalidVpcNetworkStateException- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidDbClusterStateException- The DB cluster is not in a valid state.InvalidDbSubnetGroupStateException- The DB subnet group cannot be deleted because it is in use.InvalidSubnetException- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidDbInstanceStateException- The specified DB instance is not in the available state.DbClusterParameterGroupNotFoundException- DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.KmsKeyNotAccessibleException- Error accessing KMS key.DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.DbSubnetGroupDoesNotCoverEnoughAZsException- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn'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.AwsServiceException- See Also:
- AWS API Documentation
-
createDBClusterEndpoint
default CreateDbClusterEndpointResponse createDBClusterEndpoint(CreateDbClusterEndpointRequest createDbClusterEndpointRequest) throws DbClusterEndpointQuotaExceededException, DbClusterEndpointAlreadyExistsException, DbClusterNotFoundException, InvalidDbClusterStateException, DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException
Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.
- Parameters:
createDbClusterEndpointRequest-- Returns:
- Result of the CreateDBClusterEndpoint operation returned by the service.
- Throws:
DbClusterEndpointQuotaExceededException- The cluster already has the maximum number of custom endpoints.DbClusterEndpointAlreadyExistsException- The specified custom endpoint cannot be created because it already exists.DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDbClusterStateException- The DB cluster is not in a valid state.DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDbInstanceStateException- The specified DB instance is not in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDBClusterEndpoint
default CreateDbClusterEndpointResponse createDBClusterEndpoint(Consumer<CreateDbClusterEndpointRequest.Builder> createDbClusterEndpointRequest) throws DbClusterEndpointQuotaExceededException, DbClusterEndpointAlreadyExistsException, DbClusterNotFoundException, InvalidDbClusterStateException, DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException
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.Builderavoiding the need to create one manually viaCreateDbClusterEndpointRequest.builder()- Parameters:
createDbClusterEndpointRequest- AConsumerthat will call methods onCreateDbClusterEndpointRequest.Builderto create a request.- Returns:
- Result of the CreateDBClusterEndpoint operation returned by the service.
- Throws:
DbClusterEndpointQuotaExceededException- The cluster already has the maximum number of custom endpoints.DbClusterEndpointAlreadyExistsException- The specified custom endpoint cannot be created because it already exists.DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDbClusterStateException- The DB cluster is not in a valid state.DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDbInstanceStateException- The specified DB instance is not in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDBClusterParameterGroup
default CreateDbClusterParameterGroupResponse createDBClusterParameterGroup(CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException
Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the
character_set_databaseparameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.- Parameters:
createDbClusterParameterGroupRequest-- Returns:
- Result of the CreateDBClusterParameterGroup operation returned by the service.
- Throws:
DbParameterGroupQuotaExceededException- Request would result in user exceeding the allowed number of DB parameter groups.DbParameterGroupAlreadyExistsException- A DB parameter group with the same name exists.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDBClusterParameterGroup
default CreateDbClusterParameterGroupResponse createDBClusterParameterGroup(Consumer<CreateDbClusterParameterGroupRequest.Builder> createDbClusterParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException
Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the
character_set_databaseparameter. 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.Builderavoiding the need to create one manually viaCreateDbClusterParameterGroupRequest.builder()- Parameters:
createDbClusterParameterGroupRequest- AConsumerthat will call methods onCreateDbClusterParameterGroupRequest.Builderto create a request.- Returns:
- Result of the CreateDBClusterParameterGroup operation returned by the service.
- Throws:
DbParameterGroupQuotaExceededException- Request would result in user exceeding the allowed number of DB parameter groups.DbParameterGroupAlreadyExistsException- A DB parameter group with the same name exists.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDBClusterSnapshot
default CreateDbClusterSnapshotResponse createDBClusterSnapshot(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, InvalidDbClusterStateException, DbClusterNotFoundException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, NeptuneException
Creates a snapshot of a DB cluster.
- Parameters:
createDbClusterSnapshotRequest-- Returns:
- Result of the CreateDBClusterSnapshot operation returned by the service.
- Throws:
DbClusterSnapshotAlreadyExistsException- User already has a DB cluster snapshot with the given identifier.InvalidDbClusterStateException- The DB cluster is not in a valid state.DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.SnapshotQuotaExceededException- Request would result in user exceeding the allowed number of DB snapshots.InvalidDbClusterSnapshotStateException- The supplied value is not a valid DB cluster snapshot state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDBClusterSnapshot
default CreateDbClusterSnapshotResponse createDBClusterSnapshot(Consumer<CreateDbClusterSnapshotRequest.Builder> createDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, InvalidDbClusterStateException, DbClusterNotFoundException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, NeptuneException
Creates a snapshot of a DB cluster.
This is a convenience which creates an instance of the
CreateDbClusterSnapshotRequest.Builderavoiding the need to create one manually viaCreateDbClusterSnapshotRequest.builder()- Parameters:
createDbClusterSnapshotRequest- AConsumerthat will call methods onCreateDbClusterSnapshotRequest.Builderto create a request.- Returns:
- Result of the CreateDBClusterSnapshot operation returned by the service.
- Throws:
DbClusterSnapshotAlreadyExistsException- User already has a DB cluster snapshot with the given identifier.InvalidDbClusterStateException- The DB cluster is not in a valid state.DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.SnapshotQuotaExceededException- Request would result in user exceeding the allowed number of DB snapshots.InvalidDbClusterSnapshotStateException- The supplied value is not a valid DB cluster snapshot state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDBInstance
default CreateDbInstanceResponse createDBInstance(CreateDbInstanceRequest createDbInstanceRequest) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException, InvalidSubnetException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbClusterNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, DomainNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Creates a new DB instance.
- Parameters:
createDbInstanceRequest-- Returns:
- Result of the CreateDBInstance operation returned by the service.
- Throws:
DbInstanceAlreadyExistsException- User already has a DB instance with the given identifier.InsufficientDbInstanceCapacityException- Specified DB instance class is not available in the specified Availability Zone.DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.DbSecurityGroupNotFoundException- DBSecurityGroupName does not refer to an existing DB security group.InstanceQuotaExceededException- Request would result in user exceeding the allowed number of DB instances.StorageQuotaExceededException- Request would result in user exceeding the allowed amount of storage available across all DB instances.DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidDbClusterStateException- The DB cluster is not in a valid state.InvalidSubnetException- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVpcNetworkStateException- DB subnet group does not cover all Availability Zones after it is created because users' change.ProvisionedIopsNotAvailableInAzException- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException- The designated option group could not be found.DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.StorageTypeNotSupportedException- StorageType specified cannot be associated with the DB Instance.AuthorizationNotFoundException- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.Neptune may not also be authorized via IAM to perform necessary actions on your behalf.
KmsKeyNotAccessibleException- Error accessing KMS key.DomainNotFoundException- Domain does not refer to an existing Active Directory Domain.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDBInstance
default CreateDbInstanceResponse createDBInstance(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException, InvalidSubnetException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbClusterNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, DomainNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Creates a new DB instance.
This is a convenience which creates an instance of the
CreateDbInstanceRequest.Builderavoiding the need to create one manually viaCreateDbInstanceRequest.builder()- Parameters:
createDbInstanceRequest- AConsumerthat will call methods onCreateDbInstanceRequest.Builderto create a request.- Returns:
- Result of the CreateDBInstance operation returned by the service.
- Throws:
DbInstanceAlreadyExistsException- User already has a DB instance with the given identifier.InsufficientDbInstanceCapacityException- Specified DB instance class is not available in the specified Availability Zone.DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.DbSecurityGroupNotFoundException- DBSecurityGroupName does not refer to an existing DB security group.InstanceQuotaExceededException- Request would result in user exceeding the allowed number of DB instances.StorageQuotaExceededException- Request would result in user exceeding the allowed amount of storage available across all DB instances.DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidDbClusterStateException- The DB cluster is not in a valid state.InvalidSubnetException- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVpcNetworkStateException- DB subnet group does not cover all Availability Zones after it is created because users' change.ProvisionedIopsNotAvailableInAzException- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException- The designated option group could not be found.DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.StorageTypeNotSupportedException- StorageType specified cannot be associated with the DB Instance.AuthorizationNotFoundException- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.Neptune may not also be authorized via IAM to perform necessary actions on your behalf.
KmsKeyNotAccessibleException- Error accessing KMS key.DomainNotFoundException- Domain does not refer to an existing Active Directory Domain.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDBParameterGroup
default CreateDbParameterGroupResponse createDBParameterGroup(CreateDbParameterGroupRequest createDbParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException
Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the
character_set_databaseparameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.- Parameters:
createDbParameterGroupRequest-- Returns:
- Result of the CreateDBParameterGroup operation returned by the service.
- Throws:
DbParameterGroupQuotaExceededException- Request would result in user exceeding the allowed number of DB parameter groups.DbParameterGroupAlreadyExistsException- A DB parameter group with the same name exists.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDBParameterGroup
default CreateDbParameterGroupResponse createDBParameterGroup(Consumer<CreateDbParameterGroupRequest.Builder> createDbParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException
Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the
character_set_databaseparameter. 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.Builderavoiding the need to create one manually viaCreateDbParameterGroupRequest.builder()- Parameters:
createDbParameterGroupRequest- AConsumerthat will call methods onCreateDbParameterGroupRequest.Builderto create a request.- Returns:
- Result of the CreateDBParameterGroup operation returned by the service.
- Throws:
DbParameterGroupQuotaExceededException- Request would result in user exceeding the allowed number of DB parameter groups.DbParameterGroupAlreadyExistsException- A DB parameter group with the same name exists.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDBSubnetGroup
default CreateDbSubnetGroupResponse createDBSubnetGroup(CreateDbSubnetGroupRequest createDbSubnetGroupRequest) throws DbSubnetGroupAlreadyExistsException, DbSubnetGroupQuotaExceededException, DbSubnetQuotaExceededException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, NeptuneException
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.
- Parameters:
createDbSubnetGroupRequest-- Returns:
- Result of the CreateDBSubnetGroup operation returned by the service.
- Throws:
DbSubnetGroupAlreadyExistsException- DBSubnetGroupName is already used by an existing DB subnet group.DbSubnetGroupQuotaExceededException- Request would result in user exceeding the allowed number of DB subnet groups.DbSubnetQuotaExceededException- Request would result in user exceeding the allowed number of subnets in a DB subnet groups.DbSubnetGroupDoesNotCoverEnoughAZsException- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidSubnetException- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDBSubnetGroup
default CreateDbSubnetGroupResponse createDBSubnetGroup(Consumer<CreateDbSubnetGroupRequest.Builder> createDbSubnetGroupRequest) throws DbSubnetGroupAlreadyExistsException, DbSubnetGroupQuotaExceededException, DbSubnetQuotaExceededException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, NeptuneException
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.
This is a convenience which creates an instance of the
CreateDbSubnetGroupRequest.Builderavoiding the need to create one manually viaCreateDbSubnetGroupRequest.builder()- Parameters:
createDbSubnetGroupRequest- AConsumerthat will call methods onCreateDbSubnetGroupRequest.Builderto create a request.- Returns:
- Result of the CreateDBSubnetGroup operation returned by the service.
- Throws:
DbSubnetGroupAlreadyExistsException- DBSubnetGroupName is already used by an existing DB subnet group.DbSubnetGroupQuotaExceededException- Request would result in user exceeding the allowed number of DB subnet groups.DbSubnetQuotaExceededException- Request would result in user exceeding the allowed number of subnets in a DB subnet groups.DbSubnetGroupDoesNotCoverEnoughAZsException- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidSubnetException- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createEventSubscription
default CreateEventSubscriptionResponse createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.
- Parameters:
createEventSubscriptionRequest-- Returns:
- Result of the CreateEventSubscription operation returned by the service.
- Throws:
EventSubscriptionQuotaExceededException- You have exceeded the number of events you can subscribe to.SubscriptionAlreadyExistException- This subscription already exists.SnsInvalidTopicException- The SNS topic is invalid.SnsNoAuthorizationException- There is no SNS authorization.SnsTopicArnNotFoundException- The ARN of the SNS topic could not be found.SubscriptionCategoryNotFoundException- The designated subscription category could not be found.SourceNotFoundException- The source could not be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createEventSubscription
default CreateEventSubscriptionResponse createEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.
This is a convenience which creates an instance of the
CreateEventSubscriptionRequest.Builderavoiding the need to create one manually viaCreateEventSubscriptionRequest.builder()- Parameters:
createEventSubscriptionRequest- AConsumerthat will call methods onCreateEventSubscriptionRequest.Builderto create a request.- Returns:
- Result of the CreateEventSubscription operation returned by the service.
- Throws:
EventSubscriptionQuotaExceededException- You have exceeded the number of events you can subscribe to.SubscriptionAlreadyExistException- This subscription already exists.SnsInvalidTopicException- The SNS topic is invalid.SnsNoAuthorizationException- There is no SNS authorization.SnsTopicArnNotFoundException- The ARN of the SNS topic could not be found.SubscriptionCategoryNotFoundException- The designated subscription category could not be found.SourceNotFoundException- The source could not be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createGlobalCluster
default CreateGlobalClusterResponse createGlobalCluster(CreateGlobalClusterRequest createGlobalClusterRequest) throws GlobalClusterAlreadyExistsException, GlobalClusterQuotaExceededException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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:
- Result of the CreateGlobalCluster operation returned by the service.
- Throws:
GlobalClusterAlreadyExistsException- TheGlobalClusterIdentifieralready 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.AwsServiceException- See Also:
- AWS API Documentation
-
createGlobalCluster
default CreateGlobalClusterResponse createGlobalCluster(Consumer<CreateGlobalClusterRequest.Builder> createGlobalClusterRequest) throws GlobalClusterAlreadyExistsException, GlobalClusterQuotaExceededException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.Builderavoiding the need to create one manually viaCreateGlobalClusterRequest.builder()- Parameters:
createGlobalClusterRequest- AConsumerthat will call methods onCreateGlobalClusterRequest.Builderto create a request.- Returns:
- Result of the CreateGlobalCluster operation returned by the service.
- Throws:
GlobalClusterAlreadyExistsException- TheGlobalClusterIdentifieralready 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDBCluster
default DeleteDbClusterResponse deleteDBCluster(DeleteDbClusterRequest deleteDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, DbClusterSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, NeptuneException
The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
Note that the DB Cluster cannot be deleted if deletion protection is enabled. To delete it, you must first set its
DeletionProtectionfield toFalse.- Parameters:
deleteDbClusterRequest-- Returns:
- Result of the DeleteDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDbClusterStateException- The DB cluster is not in a valid state.DbClusterSnapshotAlreadyExistsException- User already has a DB cluster snapshot with the given identifier.SnapshotQuotaExceededException- Request would result in user exceeding the allowed number of DB snapshots.InvalidDbClusterSnapshotStateException- The supplied value is not a valid DB cluster snapshot state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDBCluster
default DeleteDbClusterResponse deleteDBCluster(Consumer<DeleteDbClusterRequest.Builder> deleteDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, DbClusterSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, NeptuneException
The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
Note that the DB Cluster cannot be deleted if deletion protection is enabled. To delete it, you must first set its
DeletionProtectionfield toFalse.
This is a convenience which creates an instance of the
DeleteDbClusterRequest.Builderavoiding the need to create one manually viaDeleteDbClusterRequest.builder()- Parameters:
deleteDbClusterRequest- AConsumerthat will call methods onDeleteDbClusterRequest.Builderto create a request.- Returns:
- Result of the DeleteDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDbClusterStateException- The DB cluster is not in a valid state.DbClusterSnapshotAlreadyExistsException- User already has a DB cluster snapshot with the given identifier.SnapshotQuotaExceededException- Request would result in user exceeding the allowed number of DB snapshots.InvalidDbClusterSnapshotStateException- The supplied value is not a valid DB cluster snapshot state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDBClusterEndpoint
default DeleteDbClusterEndpointResponse deleteDBClusterEndpoint(DeleteDbClusterEndpointRequest deleteDbClusterEndpointRequest) throws InvalidDbClusterEndpointStateException, DbClusterEndpointNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException
Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.
- Parameters:
deleteDbClusterEndpointRequest-- Returns:
- Result of the DeleteDBClusterEndpoint operation returned by the service.
- Throws:
InvalidDbClusterEndpointStateException- The requested operation cannot be performed on the endpoint while the endpoint is in this state.DbClusterEndpointNotFoundException- The specified custom endpoint doesn't exist.InvalidDbClusterStateException- The DB cluster is not in a valid state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDBClusterEndpoint
default DeleteDbClusterEndpointResponse deleteDBClusterEndpoint(Consumer<DeleteDbClusterEndpointRequest.Builder> deleteDbClusterEndpointRequest) throws InvalidDbClusterEndpointStateException, DbClusterEndpointNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException
Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.
This is a convenience which creates an instance of the
DeleteDbClusterEndpointRequest.Builderavoiding the need to create one manually viaDeleteDbClusterEndpointRequest.builder()- Parameters:
deleteDbClusterEndpointRequest- AConsumerthat will call methods onDeleteDbClusterEndpointRequest.Builderto create a request.- Returns:
- Result of the DeleteDBClusterEndpoint operation returned by the service.
- Throws:
InvalidDbClusterEndpointStateException- The requested operation cannot be performed on the endpoint while the endpoint is in this state.DbClusterEndpointNotFoundException- The specified custom endpoint doesn't exist.InvalidDbClusterStateException- The DB cluster is not in a valid state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDBClusterParameterGroup
default DeleteDbClusterParameterGroupResponse deleteDBClusterParameterGroup(DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
- Parameters:
deleteDbClusterParameterGroupRequest-- Returns:
- Result of the DeleteDBClusterParameterGroup operation returned by the service.
- Throws:
InvalidDbParameterGroupStateException- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDBClusterParameterGroup
default DeleteDbClusterParameterGroupResponse deleteDBClusterParameterGroup(Consumer<DeleteDbClusterParameterGroupRequest.Builder> deleteDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
This is a convenience which creates an instance of the
DeleteDbClusterParameterGroupRequest.Builderavoiding the need to create one manually viaDeleteDbClusterParameterGroupRequest.builder()- Parameters:
deleteDbClusterParameterGroupRequest- AConsumerthat will call methods onDeleteDbClusterParameterGroupRequest.Builderto create a request.- Returns:
- Result of the DeleteDBClusterParameterGroup operation returned by the service.
- Throws:
InvalidDbParameterGroupStateException- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDBClusterSnapshot
default DeleteDbClusterSnapshotResponse deleteDBClusterSnapshot(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest) throws InvalidDbClusterSnapshotStateException, DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the
availablestate to be deleted.- Parameters:
deleteDbClusterSnapshotRequest-- Returns:
- Result of the DeleteDBClusterSnapshot operation returned by the service.
- Throws:
InvalidDbClusterSnapshotStateException- The supplied value is not a valid DB cluster snapshot state.DbClusterSnapshotNotFoundException- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDBClusterSnapshot
default DeleteDbClusterSnapshotResponse deleteDBClusterSnapshot(Consumer<DeleteDbClusterSnapshotRequest.Builder> deleteDbClusterSnapshotRequest) throws InvalidDbClusterSnapshotStateException, DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the
availablestate to be deleted.
This is a convenience which creates an instance of the
DeleteDbClusterSnapshotRequest.Builderavoiding the need to create one manually viaDeleteDbClusterSnapshotRequest.builder()- Parameters:
deleteDbClusterSnapshotRequest- AConsumerthat will call methods onDeleteDbClusterSnapshotRequest.Builderto create a request.- Returns:
- Result of the DeleteDBClusterSnapshot operation returned by the service.
- Throws:
InvalidDbClusterSnapshotStateException- The supplied value is not a valid DB cluster snapshot state.DbClusterSnapshotNotFoundException- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDBInstance
default DeleteDbInstanceResponse deleteDBInstance(DeleteDbInstanceRequest deleteDbInstanceRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException
The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by
DeleteDBInstanceare not deleted.If you request a final DB snapshot the status of the Amazon Neptune DB instance is
deletinguntil the DB snapshot is created. The API actionDescribeDBInstanceis 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 theSkipFinalSnapshotparameter 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:
- Result of the DeleteDBInstance operation returned by the service.
- Throws:
DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDbInstanceStateException- The specified DB instance is not in the available state.DbSnapshotAlreadyExistsException- DBSnapshotIdentifier is already used by an existing snapshot.SnapshotQuotaExceededException- Request would result in user exceeding the allowed number of DB snapshots.InvalidDbClusterStateException- The DB cluster is not in a valid state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDBInstance
default DeleteDbInstanceResponse deleteDBInstance(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException
The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by
DeleteDBInstanceare not deleted.If you request a final DB snapshot the status of the Amazon Neptune DB instance is
deletinguntil the DB snapshot is created. The API actionDescribeDBInstanceis 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 theSkipFinalSnapshotparameter 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.Builderavoiding the need to create one manually viaDeleteDbInstanceRequest.builder()- Parameters:
deleteDbInstanceRequest- AConsumerthat will call methods onDeleteDbInstanceRequest.Builderto create a request.- Returns:
- Result of the DeleteDBInstance operation returned by the service.
- Throws:
DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDbInstanceStateException- The specified DB instance is not in the available state.DbSnapshotAlreadyExistsException- DBSnapshotIdentifier is already used by an existing snapshot.SnapshotQuotaExceededException- Request would result in user exceeding the allowed number of DB snapshots.InvalidDbClusterStateException- The DB cluster is not in a valid state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDBParameterGroup
default DeleteDbParameterGroupResponse deleteDBParameterGroup(DeleteDbParameterGroupRequest deleteDbParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.
- Parameters:
deleteDbParameterGroupRequest-- Returns:
- Result of the DeleteDBParameterGroup operation returned by the service.
- Throws:
InvalidDbParameterGroupStateException- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDBParameterGroup
default DeleteDbParameterGroupResponse deleteDBParameterGroup(Consumer<DeleteDbParameterGroupRequest.Builder> deleteDbParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.
This is a convenience which creates an instance of the
DeleteDbParameterGroupRequest.Builderavoiding the need to create one manually viaDeleteDbParameterGroupRequest.builder()- Parameters:
deleteDbParameterGroupRequest- AConsumerthat will call methods onDeleteDbParameterGroupRequest.Builderto create a request.- Returns:
- Result of the DeleteDBParameterGroup operation returned by the service.
- Throws:
InvalidDbParameterGroupStateException- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDBSubnetGroup
default DeleteDbSubnetGroupResponse deleteDBSubnetGroup(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest) throws InvalidDbSubnetGroupStateException, InvalidDbSubnetStateException, DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
- Parameters:
deleteDbSubnetGroupRequest-- Returns:
- Result of the DeleteDBSubnetGroup operation returned by the service.
- Throws:
InvalidDbSubnetGroupStateException- The DB subnet group cannot be deleted because it is in use.InvalidDbSubnetStateException- The DB subnet is not in the available state.DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDBSubnetGroup
default DeleteDbSubnetGroupResponse deleteDBSubnetGroup(Consumer<DeleteDbSubnetGroupRequest.Builder> deleteDbSubnetGroupRequest) throws InvalidDbSubnetGroupStateException, InvalidDbSubnetStateException, DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
This is a convenience which creates an instance of the
DeleteDbSubnetGroupRequest.Builderavoiding the need to create one manually viaDeleteDbSubnetGroupRequest.builder()- Parameters:
deleteDbSubnetGroupRequest- AConsumerthat will call methods onDeleteDbSubnetGroupRequest.Builderto create a request.- Returns:
- Result of the DeleteDBSubnetGroup operation returned by the service.
- Throws:
InvalidDbSubnetGroupStateException- The DB subnet group cannot be deleted because it is in use.InvalidDbSubnetStateException- The DB subnet is not in the available state.DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteEventSubscription
default DeleteEventSubscriptionResponse deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidEventSubscriptionStateException, AwsServiceException, SdkClientException, NeptuneException
Deletes an event notification subscription.
- Parameters:
deleteEventSubscriptionRequest-- Returns:
- Result of the DeleteEventSubscription operation returned by the service.
- Throws:
SubscriptionNotFoundException- The designated subscription could not be found.InvalidEventSubscriptionStateException- The event subscription is in an invalid state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteEventSubscription
default DeleteEventSubscriptionResponse deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidEventSubscriptionStateException, AwsServiceException, SdkClientException, NeptuneException
Deletes an event notification subscription.
This is a convenience which creates an instance of the
DeleteEventSubscriptionRequest.Builderavoiding the need to create one manually viaDeleteEventSubscriptionRequest.builder()- Parameters:
deleteEventSubscriptionRequest- AConsumerthat will call methods onDeleteEventSubscriptionRequest.Builderto create a request.- Returns:
- Result of the DeleteEventSubscription operation returned by the service.
- Throws:
SubscriptionNotFoundException- The designated subscription could not be found.InvalidEventSubscriptionStateException- The event subscription is in an invalid state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGlobalCluster
default DeleteGlobalClusterResponse deleteGlobalCluster(DeleteGlobalClusterRequest deleteGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, NeptuneException
Deletes a global database. The primary and all secondary clusters must already be detached or deleted first.
- Parameters:
deleteGlobalClusterRequest-- Returns:
- Result of the DeleteGlobalCluster operation returned by the service.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn'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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGlobalCluster
default DeleteGlobalClusterResponse deleteGlobalCluster(Consumer<DeleteGlobalClusterRequest.Builder> deleteGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, NeptuneException
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.Builderavoiding the need to create one manually viaDeleteGlobalClusterRequest.builder()- Parameters:
deleteGlobalClusterRequest- AConsumerthat will call methods onDeleteGlobalClusterRequest.Builderto create a request.- Returns:
- Result of the DeleteGlobalCluster operation returned by the service.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn'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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterEndpoints
default DescribeDbClusterEndpointsResponse describeDBClusterEndpoints(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about endpoints for an Amazon Neptune DB cluster.
This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.
- Parameters:
describeDbClusterEndpointsRequest-- Returns:
- Result of the DescribeDBClusterEndpoints operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterEndpoints
default DescribeDbClusterEndpointsResponse describeDBClusterEndpoints(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.Builderavoiding the need to create one manually viaDescribeDbClusterEndpointsRequest.builder()- Parameters:
describeDbClusterEndpointsRequest- AConsumerthat will call methods onDescribeDbClusterEndpointsRequest.Builderto create a request.- Returns:
- Result of the DescribeDBClusterEndpoints operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterEndpointsPaginator
default DescribeDBClusterEndpointsIterable describeDBClusterEndpointsPaginator(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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 variant of
describeDBClusterEndpoints(software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterEndpointsIterable responses = client.describeDBClusterEndpointsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterEndpointsIterable responses = client .describeDBClusterEndpointsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterEndpointsIterable responses = client.describeDBClusterEndpointsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterEndpointsPaginator
default DescribeDBClusterEndpointsIterable describeDBClusterEndpointsPaginator(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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 variant of
describeDBClusterEndpoints(software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterEndpointsIterable responses = client.describeDBClusterEndpointsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterEndpointsIterable responses = client .describeDBClusterEndpointsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterEndpointsIterable responses = client.describeDBClusterEndpointsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeDbClusterEndpointsRequest.builder()- Parameters:
describeDbClusterEndpointsRequest- AConsumerthat will call methods onDescribeDbClusterEndpointsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterParameterGroups
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of
DBClusterParameterGroupdescriptions. If aDBClusterParameterGroupNameparameter is specified, the list will contain only the description of the specified DB cluster parameter group.- Parameters:
describeDbClusterParameterGroupsRequest-- Returns:
- Result of the DescribeDBClusterParameterGroups operation returned by the service.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterParameterGroups
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of
DBClusterParameterGroupdescriptions. If aDBClusterParameterGroupNameparameter 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.Builderavoiding the need to create one manually viaDescribeDbClusterParameterGroupsRequest.builder()- Parameters:
describeDbClusterParameterGroupsRequest- AConsumerthat will call methods onDescribeDbClusterParameterGroupsRequest.Builderto create a request.- Returns:
- Result of the DescribeDBClusterParameterGroups operation returned by the service.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterParameterGroups
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of
DBClusterParameterGroupdescriptions. If aDBClusterParameterGroupNameparameter is specified, the list will contain only the description of the specified DB cluster parameter group.- Returns:
- Result of the DescribeDBClusterParameterGroups operation returned by the service.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest), AWS API Documentation
-
describeDBClusterParameterGroupsPaginator
default DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of
DBClusterParameterGroupdescriptions. If aDBClusterParameterGroupNameparameter is specified, the list will contain only the description of the specified DB cluster parameter group.
This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsIterable responses = client .describeDBClusterParameterGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest), AWS API Documentation
-
describeDBClusterParameterGroupsPaginator
default DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of
DBClusterParameterGroupdescriptions. If aDBClusterParameterGroupNameparameter is specified, the list will contain only the description of the specified DB cluster parameter group.
This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsIterable responses = client .describeDBClusterParameterGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterParameterGroupsPaginator
default DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of
DBClusterParameterGroupdescriptions. If aDBClusterParameterGroupNameparameter is specified, the list will contain only the description of the specified DB cluster parameter group.
This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsIterable responses = client .describeDBClusterParameterGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeDbClusterParameterGroupsRequest.builder()- Parameters:
describeDbClusterParameterGroupsRequest- AConsumerthat will call methods onDescribeDbClusterParameterGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterParameters
default DescribeDbClusterParametersResponse describeDBClusterParameters(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns the detailed parameter list for a particular DB cluster parameter group.
- Parameters:
describeDbClusterParametersRequest-- Returns:
- Result of the DescribeDBClusterParameters operation returned by the service.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterParameters
default DescribeDbClusterParametersResponse describeDBClusterParameters(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns the detailed parameter list for a particular DB cluster parameter group.
This is a convenience which creates an instance of the
DescribeDbClusterParametersRequest.Builderavoiding the need to create one manually viaDescribeDbClusterParametersRequest.builder()- Parameters:
describeDbClusterParametersRequest- AConsumerthat will call methods onDescribeDbClusterParametersRequest.Builderto create a request.- Returns:
- Result of the DescribeDBClusterParameters operation returned by the service.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterParametersPaginator
default DescribeDBClusterParametersIterable describeDBClusterParametersPaginator(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns the detailed parameter list for a particular DB cluster parameter group.
This is a variant of
describeDBClusterParameters(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParametersIterable responses = client .describeDBClusterParametersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterParametersPaginator
default DescribeDBClusterParametersIterable describeDBClusterParametersPaginator(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns the detailed parameter list for a particular DB cluster parameter group.
This is a variant of
describeDBClusterParameters(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParametersIterable responses = client .describeDBClusterParametersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeDbClusterParametersRequest.builder()- Parameters:
describeDbClusterParametersRequest- AConsumerthat will call methods onDescribeDbClusterParametersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterSnapshotAttributes
default DescribeDbClusterSnapshotAttributesResponse describeDBClusterSnapshotAttributes(DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other Amazon accounts,
DescribeDBClusterSnapshotAttributesreturns therestoreattribute and a list of IDs for the Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. Ifallis included in the list of values for therestoreattribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon accounts.To add or remove access for an Amazon account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
- Parameters:
describeDbClusterSnapshotAttributesRequest-- Returns:
- Result of the DescribeDBClusterSnapshotAttributes operation returned by the service.
- Throws:
DbClusterSnapshotNotFoundException- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterSnapshotAttributes
default DescribeDbClusterSnapshotAttributesResponse describeDBClusterSnapshotAttributes(Consumer<DescribeDbClusterSnapshotAttributesRequest.Builder> describeDbClusterSnapshotAttributesRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other Amazon accounts,
DescribeDBClusterSnapshotAttributesreturns therestoreattribute and a list of IDs for the Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. Ifallis included in the list of values for therestoreattribute, 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.Builderavoiding the need to create one manually viaDescribeDbClusterSnapshotAttributesRequest.builder()- Parameters:
describeDbClusterSnapshotAttributesRequest- AConsumerthat will call methods onDescribeDbClusterSnapshotAttributesRequest.Builderto create a request.- Returns:
- Result of the DescribeDBClusterSnapshotAttributes operation returned by the service.
- Throws:
DbClusterSnapshotNotFoundException- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterSnapshots
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about DB cluster snapshots. This API action supports pagination.
- Parameters:
describeDbClusterSnapshotsRequest-- Returns:
- Result of the DescribeDBClusterSnapshots operation returned by the service.
- Throws:
DbClusterSnapshotNotFoundException- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterSnapshots
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about DB cluster snapshots. This API action supports pagination.
This is a convenience which creates an instance of the
DescribeDbClusterSnapshotsRequest.Builderavoiding the need to create one manually viaDescribeDbClusterSnapshotsRequest.builder()- Parameters:
describeDbClusterSnapshotsRequest- AConsumerthat will call methods onDescribeDbClusterSnapshotsRequest.Builderto create a request.- Returns:
- Result of the DescribeDBClusterSnapshots operation returned by the service.
- Throws:
DbClusterSnapshotNotFoundException- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterSnapshots
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots() throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about DB cluster snapshots. This API action supports pagination.
- Returns:
- Result of the DescribeDBClusterSnapshots operation returned by the service.
- Throws:
DbClusterSnapshotNotFoundException- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest), AWS API Documentation
-
describeDBClusterSnapshotsPaginator
default DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator() throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about DB cluster snapshots. This API action supports pagination.
This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsIterable responses = client .describeDBClusterSnapshotsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
DbClusterSnapshotNotFoundException- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest), AWS API Documentation
-
describeDBClusterSnapshotsPaginator
default DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about DB cluster snapshots. This API action supports pagination.
This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsIterable responses = client .describeDBClusterSnapshotsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
DbClusterSnapshotNotFoundException- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterSnapshotsPaginator
default DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about DB cluster snapshots. This API action supports pagination.
This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsIterable responses = client .describeDBClusterSnapshotsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeDbClusterSnapshotsRequest.builder()- Parameters:
describeDbClusterSnapshotsRequest- AConsumerthat will call methods onDescribeDbClusterSnapshotsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
DbClusterSnapshotNotFoundException- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusters
default DescribeDbClustersResponse describeDBClusters(DescribeDbClustersRequest describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about provisioned DB clusters, and supports pagination.
This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.
- Parameters:
describeDbClustersRequest-- Returns:
- Result of the DescribeDBClusters operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusters
default DescribeDbClustersResponse describeDBClusters(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.Builderavoiding the need to create one manually viaDescribeDbClustersRequest.builder()- Parameters:
describeDbClustersRequest- AConsumerthat will call methods onDescribeDbClustersRequest.Builderto create a request.- Returns:
- Result of the DescribeDBClusters operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusters
default DescribeDbClustersResponse describeDBClusters() throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about provisioned DB clusters, and supports pagination.
This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.
- Returns:
- Result of the DescribeDBClusters operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBClusters(DescribeDbClustersRequest), AWS API Documentation
-
describeDBClustersPaginator
default DescribeDBClustersIterable describeDBClustersPaginator() throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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 variant of
describeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClustersIterable responses = client .describeDBClustersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClustersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBClustersPaginator(DescribeDbClustersRequest), AWS API Documentation
-
describeDBClustersPaginator
default DescribeDBClustersIterable describeDBClustersPaginator(DescribeDbClustersRequest describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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 variant of
describeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClustersIterable responses = client .describeDBClustersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClustersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClustersPaginator
default DescribeDBClustersIterable describeDBClustersPaginator(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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 variant of
describeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClustersIterable responses = client .describeDBClustersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClustersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeDbClustersRequest.builder()- Parameters:
describeDbClustersRequest- AConsumerthat will call methods onDescribeDbClustersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBEngineVersions
default DescribeDbEngineVersionsResponse describeDBEngineVersions(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of the available DB engines.
- Parameters:
describeDbEngineVersionsRequest-- Returns:
- Result of the DescribeDBEngineVersions operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBEngineVersions
default DescribeDbEngineVersionsResponse describeDBEngineVersions(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of the available DB engines.
This is a convenience which creates an instance of the
DescribeDbEngineVersionsRequest.Builderavoiding the need to create one manually viaDescribeDbEngineVersionsRequest.builder()- Parameters:
describeDbEngineVersionsRequest- AConsumerthat will call methods onDescribeDbEngineVersionsRequest.Builderto create a request.- Returns:
- Result of the DescribeDBEngineVersions operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBEngineVersions
default DescribeDbEngineVersionsResponse describeDBEngineVersions() throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of the available DB engines.
- Returns:
- Result of the DescribeDBEngineVersions operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBEngineVersions(DescribeDbEngineVersionsRequest), AWS API Documentation
-
describeDBEngineVersionsPaginator
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator() throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of the available DB engines.
This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client .describeDBEngineVersionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest), AWS API Documentation
-
describeDBEngineVersionsPaginator
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of the available DB engines.
This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client .describeDBEngineVersionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBEngineVersionsPaginator
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of the available DB engines.
This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client .describeDBEngineVersionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeDbEngineVersionsRequest.builder()- Parameters:
describeDbEngineVersionsRequest- AConsumerthat will call methods onDescribeDbEngineVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBInstances
default DescribeDbInstancesResponse describeDBInstances(DescribeDbInstancesRequest describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about provisioned instances, and supports pagination.
This operation can also return information for Amazon RDS instances and Amazon DocDB instances.
- Parameters:
describeDbInstancesRequest-- Returns:
- Result of the DescribeDBInstances operation returned by the service.
- Throws:
DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBInstances
default DescribeDbInstancesResponse describeDBInstances(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.Builderavoiding the need to create one manually viaDescribeDbInstancesRequest.builder()- Parameters:
describeDbInstancesRequest- AConsumerthat will call methods onDescribeDbInstancesRequest.Builderto create a request.- Returns:
- Result of the DescribeDBInstances operation returned by the service.
- Throws:
DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBInstances
default DescribeDbInstancesResponse describeDBInstances() throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about provisioned instances, and supports pagination.
This operation can also return information for Amazon RDS instances and Amazon DocDB instances.
- Returns:
- Result of the DescribeDBInstances operation returned by the service.
- Throws:
DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBInstances(DescribeDbInstancesRequest), AWS API Documentation
-
describeDBInstancesPaginator
default DescribeDBInstancesIterable describeDBInstancesPaginator() throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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 variant of
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client .describeDBInstancesPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbInstancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBInstancesPaginator(DescribeDbInstancesRequest), AWS API Documentation
-
describeDBInstancesPaginator
default DescribeDBInstancesIterable describeDBInstancesPaginator(DescribeDbInstancesRequest describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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 variant of
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client .describeDBInstancesPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbInstancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBInstancesPaginator
default DescribeDBInstancesIterable describeDBInstancesPaginator(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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 variant of
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client .describeDBInstancesPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbInstancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeDbInstancesRequest.builder()- Parameters:
describeDbInstancesRequest- AConsumerthat will call methods onDescribeDbInstancesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBParameterGroups
default DescribeDbParameterGroupsResponse describeDBParameterGroups(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of
DBParameterGroupdescriptions. If aDBParameterGroupNameis specified, the list will contain only the description of the specified DB parameter group.- Parameters:
describeDbParameterGroupsRequest-- Returns:
- Result of the DescribeDBParameterGroups operation returned by the service.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBParameterGroups
default DescribeDbParameterGroupsResponse describeDBParameterGroups(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of
DBParameterGroupdescriptions. If aDBParameterGroupNameis 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.Builderavoiding the need to create one manually viaDescribeDbParameterGroupsRequest.builder()- Parameters:
describeDbParameterGroupsRequest- AConsumerthat will call methods onDescribeDbParameterGroupsRequest.Builderto create a request.- Returns:
- Result of the DescribeDBParameterGroups operation returned by the service.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBParameterGroups
default DescribeDbParameterGroupsResponse describeDBParameterGroups() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of
DBParameterGroupdescriptions. If aDBParameterGroupNameis specified, the list will contain only the description of the specified DB parameter group.- Returns:
- Result of the DescribeDBParameterGroups operation returned by the service.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBParameterGroups(DescribeDbParameterGroupsRequest), AWS API Documentation
-
describeDBParameterGroupsPaginator
default DescribeDBParameterGroupsIterable describeDBParameterGroupsPaginator() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of
DBParameterGroupdescriptions. If aDBParameterGroupNameis specified, the list will contain only the description of the specified DB parameter group.
This is a variant of
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client .describeDBParameterGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBParameterGroupsPaginator(DescribeDbParameterGroupsRequest), AWS API Documentation
-
describeDBParameterGroupsPaginator
default DescribeDBParameterGroupsIterable describeDBParameterGroupsPaginator(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of
DBParameterGroupdescriptions. If aDBParameterGroupNameis specified, the list will contain only the description of the specified DB parameter group.
This is a variant of
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client .describeDBParameterGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBParameterGroupsPaginator
default DescribeDBParameterGroupsIterable describeDBParameterGroupsPaginator(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of
DBParameterGroupdescriptions. If aDBParameterGroupNameis specified, the list will contain only the description of the specified DB parameter group.
This is a variant of
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client .describeDBParameterGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeDbParameterGroupsRequest.builder()- Parameters:
describeDbParameterGroupsRequest- AConsumerthat will call methods onDescribeDbParameterGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBParameters
default DescribeDbParametersResponse describeDBParameters(DescribeDbParametersRequest describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns the detailed parameter list for a particular DB parameter group.
- Parameters:
describeDbParametersRequest-- Returns:
- Result of the DescribeDBParameters operation returned by the service.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBParameters
default DescribeDbParametersResponse describeDBParameters(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns the detailed parameter list for a particular DB parameter group.
This is a convenience which creates an instance of the
DescribeDbParametersRequest.Builderavoiding the need to create one manually viaDescribeDbParametersRequest.builder()- Parameters:
describeDbParametersRequest- AConsumerthat will call methods onDescribeDbParametersRequest.Builderto create a request.- Returns:
- Result of the DescribeDBParameters operation returned by the service.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBParametersPaginator
default DescribeDBParametersIterable describeDBParametersPaginator(DescribeDbParametersRequest describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns the detailed parameter list for a particular DB parameter group.
This is a variant of
describeDBParameters(software.amazon.awssdk.services.neptune.model.DescribeDbParametersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParametersIterable responses = client.describeDBParametersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBParametersIterable responses = client .describeDBParametersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbParametersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParametersIterable responses = client.describeDBParametersPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBParametersPaginator
default DescribeDBParametersIterable describeDBParametersPaginator(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns the detailed parameter list for a particular DB parameter group.
This is a variant of
describeDBParameters(software.amazon.awssdk.services.neptune.model.DescribeDbParametersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParametersIterable responses = client.describeDBParametersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBParametersIterable responses = client .describeDBParametersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbParametersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParametersIterable responses = client.describeDBParametersPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeDbParametersRequest.builder()- Parameters:
describeDbParametersRequest- AConsumerthat will call methods onDescribeDbParametersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBSubnetGroups
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
- Parameters:
describeDbSubnetGroupsRequest-- Returns:
- Result of the DescribeDBSubnetGroups operation returned by the service.
- Throws:
DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBSubnetGroups
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
This is a convenience which creates an instance of the
DescribeDbSubnetGroupsRequest.Builderavoiding the need to create one manually viaDescribeDbSubnetGroupsRequest.builder()- Parameters:
describeDbSubnetGroupsRequest- AConsumerthat will call methods onDescribeDbSubnetGroupsRequest.Builderto create a request.- Returns:
- Result of the DescribeDBSubnetGroups operation returned by the service.
- Throws:
DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBSubnetGroups
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups() throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
- Returns:
- Result of the DescribeDBSubnetGroups operation returned by the service.
- Throws:
DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBSubnetGroups(DescribeDbSubnetGroupsRequest), AWS API Documentation
-
describeDBSubnetGroupsPaginator
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator() throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client .describeDBSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest), AWS API Documentation
-
describeDBSubnetGroupsPaginator
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client .describeDBSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBSubnetGroupsPaginator
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client .describeDBSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeDbSubnetGroupsRequest.builder()- Parameters:
describeDbSubnetGroupsRequest- AConsumerthat will call methods onDescribeDbSubnetGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEngineDefaultClusterParameters
default DescribeEngineDefaultClusterParametersResponse describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns the default engine and system parameter information for the cluster database engine.
- Parameters:
describeEngineDefaultClusterParametersRequest-- Returns:
- Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEngineDefaultClusterParameters
default DescribeEngineDefaultClusterParametersResponse describeEngineDefaultClusterParameters(Consumer<DescribeEngineDefaultClusterParametersRequest.Builder> describeEngineDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns the default engine and system parameter information for the cluster database engine.
This is a convenience which creates an instance of the
DescribeEngineDefaultClusterParametersRequest.Builderavoiding the need to create one manually viaDescribeEngineDefaultClusterParametersRequest.builder()- Parameters:
describeEngineDefaultClusterParametersRequest- AConsumerthat will call methods onDescribeEngineDefaultClusterParametersRequest.Builderto create a request.- Returns:
- Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEngineDefaultParameters
default DescribeEngineDefaultParametersResponse describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns the default engine and system parameter information for the specified database engine.
- Parameters:
describeEngineDefaultParametersRequest-- Returns:
- Result of the DescribeEngineDefaultParameters operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEngineDefaultParameters
default DescribeEngineDefaultParametersResponse describeEngineDefaultParameters(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns the default engine and system parameter information for the specified database engine.
This is a convenience which creates an instance of the
DescribeEngineDefaultParametersRequest.Builderavoiding the need to create one manually viaDescribeEngineDefaultParametersRequest.builder()- Parameters:
describeEngineDefaultParametersRequest- AConsumerthat will call methods onDescribeEngineDefaultParametersRequest.Builderto create a request.- Returns:
- Result of the DescribeEngineDefaultParameters operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEngineDefaultParametersPaginator
default DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns the default engine and system parameter information for the specified database engine.
This is a variant of
describeEngineDefaultParameters(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersIterable responses = client .describeEngineDefaultParametersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEngineDefaultParametersPaginator
default DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns the default engine and system parameter information for the specified database engine.
This is a variant of
describeEngineDefaultParameters(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersIterable responses = client .describeEngineDefaultParametersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeEngineDefaultParametersRequest.builder()- Parameters:
describeEngineDefaultParametersRequest- AConsumerthat will call methods onDescribeEngineDefaultParametersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEventCategories
default DescribeEventCategoriesResponse describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) throws AwsServiceException, SdkClientException, NeptuneException
Displays a list of categories for all event source types, or, if specified, for a specified source type.
- Parameters:
describeEventCategoriesRequest-- Returns:
- Result of the DescribeEventCategories operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEventCategories
default DescribeEventCategoriesResponse describeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest) throws AwsServiceException, SdkClientException, NeptuneException
Displays a list of categories for all event source types, or, if specified, for a specified source type.
This is a convenience which creates an instance of the
DescribeEventCategoriesRequest.Builderavoiding the need to create one manually viaDescribeEventCategoriesRequest.builder()- Parameters:
describeEventCategoriesRequest- AConsumerthat will call methods onDescribeEventCategoriesRequest.Builderto create a request.- Returns:
- Result of the DescribeEventCategories operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEventCategories
default DescribeEventCategoriesResponse describeEventCategories() throws AwsServiceException, SdkClientException, NeptuneException
Displays a list of categories for all event source types, or, if specified, for a specified source type.
- Returns:
- Result of the DescribeEventCategories operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeEventCategories(DescribeEventCategoriesRequest), AWS API Documentation
-
describeEventSubscriptions
default DescribeEventSubscriptionsResponse describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
- Parameters:
describeEventSubscriptionsRequest-- Returns:
- Result of the DescribeEventSubscriptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEventSubscriptions
default DescribeEventSubscriptionsResponse describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
This is a convenience which creates an instance of the
DescribeEventSubscriptionsRequest.Builderavoiding the need to create one manually viaDescribeEventSubscriptionsRequest.builder()- Parameters:
describeEventSubscriptionsRequest- AConsumerthat will call methods onDescribeEventSubscriptionsRequest.Builderto create a request.- Returns:
- Result of the DescribeEventSubscriptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEventSubscriptions
default DescribeEventSubscriptionsResponse describeEventSubscriptions() throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
- Returns:
- Result of the DescribeEventSubscriptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
describeEventSubscriptions(DescribeEventSubscriptionsRequest), AWS API Documentation
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator() throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client .describeEventSubscriptionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest), AWS API Documentation
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client .describeEventSubscriptionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client .describeEventSubscriptionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeEventSubscriptionsRequest.builder()- Parameters:
describeEventSubscriptionsRequest- AConsumerthat will call methods onDescribeEventSubscriptionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEvents
default DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
- Parameters:
describeEventsRequest-- Returns:
- Result of the DescribeEvents operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEvents
default DescribeEventsResponse describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
This is a convenience which creates an instance of the
DescribeEventsRequest.Builderavoiding the need to create one manually viaDescribeEventsRequest.builder()- Parameters:
describeEventsRequest- AConsumerthat will call methods onDescribeEventsRequest.Builderto create a request.- Returns:
- Result of the DescribeEvents operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEvents
default DescribeEventsResponse describeEvents() throws AwsServiceException, SdkClientException, NeptuneException
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
- Returns:
- Result of the DescribeEvents operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeEvents(DescribeEventsRequest), AWS API Documentation
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator() throws AwsServiceException, SdkClientException, NeptuneException
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
This is a variant of
describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEventsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeEventsPaginator(DescribeEventsRequest), AWS API Documentation
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
This is a variant of
describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEventsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
This is a variant of
describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEventsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeEventsRequest.builder()- Parameters:
describeEventsRequest- AConsumerthat will call methods onDescribeEventsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeGlobalClusters
default DescribeGlobalClustersResponse describeGlobalClusters(DescribeGlobalClustersRequest describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about Neptune global database clusters. This API supports pagination.
- Parameters:
describeGlobalClustersRequest-- Returns:
- Result of the DescribeGlobalClusters operation returned by the service.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn'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.AwsServiceException- See Also:
- AWS API Documentation
-
describeGlobalClusters
default DescribeGlobalClustersResponse describeGlobalClusters(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about Neptune global database clusters. This API supports pagination.
This is a convenience which creates an instance of the
DescribeGlobalClustersRequest.Builderavoiding the need to create one manually viaDescribeGlobalClustersRequest.builder()- Parameters:
describeGlobalClustersRequest- AConsumerthat will call methods onDescribeGlobalClustersRequest.Builderto create a request.- Returns:
- Result of the DescribeGlobalClusters operation returned by the service.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn'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.AwsServiceException- See Also:
- AWS API Documentation
-
describeGlobalClustersPaginator
default DescribeGlobalClustersIterable describeGlobalClustersPaginator(DescribeGlobalClustersRequest describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about Neptune global database clusters. This API supports pagination.
This is a variant of
describeGlobalClusters(software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeGlobalClustersIterable responses = client .describeGlobalClustersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn'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.AwsServiceException- See Also:
- AWS API Documentation
-
describeGlobalClustersPaginator
default DescribeGlobalClustersIterable describeGlobalClustersPaginator(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about Neptune global database clusters. This API supports pagination.
This is a variant of
describeGlobalClusters(software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeGlobalClustersIterable responses = client .describeGlobalClustersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeGlobalClustersRequest.builder()- Parameters:
describeGlobalClustersRequest- AConsumerthat will call methods onDescribeGlobalClustersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn'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.AwsServiceException- See Also:
- AWS API Documentation
-
describeOrderableDBInstanceOptions
default DescribeOrderableDbInstanceOptionsResponse describeOrderableDBInstanceOptions(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of orderable DB instance options for the specified engine.
- Parameters:
describeOrderableDbInstanceOptionsRequest-- Returns:
- Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeOrderableDBInstanceOptions
default DescribeOrderableDbInstanceOptionsResponse describeOrderableDBInstanceOptions(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of orderable DB instance options for the specified engine.
This is a convenience which creates an instance of the
DescribeOrderableDbInstanceOptionsRequest.Builderavoiding the need to create one manually viaDescribeOrderableDbInstanceOptionsRequest.builder()- Parameters:
describeOrderableDbInstanceOptionsRequest- AConsumerthat will call methods onDescribeOrderableDbInstanceOptionsRequest.Builderto create a request.- Returns:
- Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeOrderableDBInstanceOptionsPaginator
default DescribeOrderableDBInstanceOptionsIterable describeOrderableDBInstanceOptionsPaginator(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of orderable DB instance options for the specified engine.
This is a variant of
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client .describeOrderableDBInstanceOptionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeOrderableDBInstanceOptionsPaginator
default DescribeOrderableDBInstanceOptionsIterable describeOrderableDBInstanceOptionsPaginator(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of orderable DB instance options for the specified engine.
This is a variant of
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client .describeOrderableDBInstanceOptionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeOrderableDbInstanceOptionsRequest.builder()- Parameters:
describeOrderableDbInstanceOptionsRequest- AConsumerthat will call methods onDescribeOrderableDbInstanceOptionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePendingMaintenanceActions
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
- Parameters:
describePendingMaintenanceActionsRequest-- Returns:
- Result of the DescribePendingMaintenanceActions operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource ID was not found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePendingMaintenanceActions
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
This is a convenience which creates an instance of the
DescribePendingMaintenanceActionsRequest.Builderavoiding the need to create one manually viaDescribePendingMaintenanceActionsRequest.builder()- Parameters:
describePendingMaintenanceActionsRequest- AConsumerthat will call methods onDescribePendingMaintenanceActionsRequest.Builderto create a request.- Returns:
- Result of the DescribePendingMaintenanceActions operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource ID was not found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePendingMaintenanceActions
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions() throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
- Returns:
- Result of the DescribePendingMaintenanceActions operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource ID was not found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest), AWS API Documentation
-
describePendingMaintenanceActionsPaginator
default DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator() throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsIterable responses = client .describePendingMaintenanceActionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- The specified resource ID was not found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest), AWS API Documentation
-
describePendingMaintenanceActionsPaginator
default DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsIterable responses = client .describePendingMaintenanceActionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- The specified resource ID was not found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePendingMaintenanceActionsPaginator
default DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsIterable responses = client .describePendingMaintenanceActionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribePendingMaintenanceActionsRequest.builder()- Parameters:
describePendingMaintenanceActionsRequest- AConsumerthat will call methods onDescribePendingMaintenanceActionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- The specified resource ID was not found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeValidDBInstanceModifications
default DescribeValidDbInstanceModificationsResponse describeValidDBInstanceModifications(DescribeValidDbInstanceModificationsRequest describeValidDbInstanceModificationsRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
- Parameters:
describeValidDbInstanceModificationsRequest-- Returns:
- Result of the DescribeValidDBInstanceModifications operation returned by the service.
- Throws:
DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDbInstanceStateException- The specified DB instance is not in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeValidDBInstanceModifications
default DescribeValidDbInstanceModificationsResponse describeValidDBInstanceModifications(Consumer<DescribeValidDbInstanceModificationsRequest.Builder> describeValidDbInstanceModificationsRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
This is a convenience which creates an instance of the
DescribeValidDbInstanceModificationsRequest.Builderavoiding the need to create one manually viaDescribeValidDbInstanceModificationsRequest.builder()- Parameters:
describeValidDbInstanceModificationsRequest- AConsumerthat will call methods onDescribeValidDbInstanceModificationsRequest.Builderto create a request.- Returns:
- Result of the DescribeValidDBInstanceModifications operation returned by the service.
- Throws:
DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDbInstanceStateException- The specified DB instance is not in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
failoverDBCluster
default FailoverDbClusterResponse failoverDBCluster(FailoverDbClusterRequest failoverDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException
Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).
Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
- Parameters:
failoverDbClusterRequest-- Returns:
- Result of the FailoverDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDbClusterStateException- The DB cluster is not in a valid state.InvalidDbInstanceStateException- The specified DB instance is not in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
failoverDBCluster
default FailoverDbClusterResponse failoverDBCluster(Consumer<FailoverDbClusterRequest.Builder> failoverDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException
Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).
Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
This is a convenience which creates an instance of the
FailoverDbClusterRequest.Builderavoiding the need to create one manually viaFailoverDbClusterRequest.builder()- Parameters:
failoverDbClusterRequest- AConsumerthat will call methods onFailoverDbClusterRequest.Builderto create a request.- Returns:
- Result of the FailoverDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDbClusterStateException- The DB cluster is not in a valid state.InvalidDbInstanceStateException- The specified DB instance is not in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
failoverGlobalCluster
default FailoverGlobalClusterResponse failoverGlobalCluster(FailoverGlobalClusterRequest failoverGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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:
- Result of the FailoverGlobalCluster operation returned by the service.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn'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.AwsServiceException- See Also:
- AWS API Documentation
-
failoverGlobalCluster
default FailoverGlobalClusterResponse failoverGlobalCluster(Consumer<FailoverGlobalClusterRequest.Builder> failoverGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.Builderavoiding the need to create one manually viaFailoverGlobalClusterRequest.builder()- Parameters:
failoverGlobalClusterRequest- AConsumerthat will call methods onFailoverGlobalClusterRequest.Builderto create a request.- Returns:
- Result of the FailoverGlobalCluster operation returned by the service.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn'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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Lists all tags on an Amazon Neptune resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.DbSnapshotNotFoundException- DBSnapshotIdentifier does not refer to an existing DB snapshot.DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Lists all tags on an Amazon Neptune resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.DbSnapshotNotFoundException- DBSnapshotIdentifier does not refer to an existing DB snapshot.DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
modifyDBCluster
default ModifyDbClusterResponse modifyDBCluster(ModifyDbClusterRequest modifyDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException, InvalidDbInstanceStateException, DbClusterAlreadyExistsException, StorageTypeNotSupportedException, AwsServiceException, SdkClientException, NeptuneException
Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
- Parameters:
modifyDbClusterRequest-- Returns:
- Result of the ModifyDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDbClusterStateException- The DB cluster is not in a valid state.StorageQuotaExceededException- Request would result in user exceeding the allowed amount of storage available across all DB instances.DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.InvalidVpcNetworkStateException- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidDbSubnetGroupStateException- The DB subnet group cannot be deleted because it is in use.InvalidSubnetException- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.DbClusterParameterGroupNotFoundException- DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.InvalidDbSecurityGroupStateException- The state of the DB security group does not allow deletion.InvalidDbInstanceStateException- The specified DB instance is not in the available state.DbClusterAlreadyExistsException- User already has a DB cluster with the given identifier.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.AwsServiceException- See Also:
- AWS API Documentation
-
modifyDBCluster
default ModifyDbClusterResponse modifyDBCluster(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException, InvalidDbInstanceStateException, DbClusterAlreadyExistsException, StorageTypeNotSupportedException, AwsServiceException, SdkClientException, NeptuneException
Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
This is a convenience which creates an instance of the
ModifyDbClusterRequest.Builderavoiding the need to create one manually viaModifyDbClusterRequest.builder()- Parameters:
modifyDbClusterRequest- AConsumerthat will call methods onModifyDbClusterRequest.Builderto create a request.- Returns:
- Result of the ModifyDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDbClusterStateException- The DB cluster is not in a valid state.StorageQuotaExceededException- Request would result in user exceeding the allowed amount of storage available across all DB instances.DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.InvalidVpcNetworkStateException- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidDbSubnetGroupStateException- The DB subnet group cannot be deleted because it is in use.InvalidSubnetException- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.DbClusterParameterGroupNotFoundException- DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.InvalidDbSecurityGroupStateException- The state of the DB security group does not allow deletion.InvalidDbInstanceStateException- The specified DB instance is not in the available state.DbClusterAlreadyExistsException- User already has a DB cluster with the given identifier.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.AwsServiceException- See Also:
- AWS API Documentation
-
modifyDBClusterEndpoint
default ModifyDbClusterEndpointResponse modifyDBClusterEndpoint(ModifyDbClusterEndpointRequest modifyDbClusterEndpointRequest) throws InvalidDbClusterStateException, InvalidDbClusterEndpointStateException, DbClusterEndpointNotFoundException, DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException
Modifies the properties of an endpoint in an Amazon Neptune DB cluster.
- Parameters:
modifyDbClusterEndpointRequest-- Returns:
- Result of the ModifyDBClusterEndpoint operation returned by the service.
- Throws:
InvalidDbClusterStateException- The DB cluster is not in a valid state.InvalidDbClusterEndpointStateException- The requested operation cannot be performed on the endpoint while the endpoint is in this state.DbClusterEndpointNotFoundException- The specified custom endpoint doesn't exist.DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDbInstanceStateException- The specified DB instance is not in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
modifyDBClusterEndpoint
default ModifyDbClusterEndpointResponse modifyDBClusterEndpoint(Consumer<ModifyDbClusterEndpointRequest.Builder> modifyDbClusterEndpointRequest) throws InvalidDbClusterStateException, InvalidDbClusterEndpointStateException, DbClusterEndpointNotFoundException, DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException
Modifies the properties of an endpoint in an Amazon Neptune DB cluster.
This is a convenience which creates an instance of the
ModifyDbClusterEndpointRequest.Builderavoiding the need to create one manually viaModifyDbClusterEndpointRequest.builder()- Parameters:
modifyDbClusterEndpointRequest- AConsumerthat will call methods onModifyDbClusterEndpointRequest.Builderto create a request.- Returns:
- Result of the ModifyDBClusterEndpoint operation returned by the service.
- Throws:
InvalidDbClusterStateException- The DB cluster is not in a valid state.InvalidDbClusterEndpointStateException- The requested operation cannot be performed on the endpoint while the endpoint is in this state.DbClusterEndpointNotFoundException- The specified custom endpoint doesn't exist.DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDbInstanceStateException- The specified DB instance is not in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
modifyDBClusterParameterGroup
default ModifyDbClusterParameterGroupResponse modifyDBClusterParameterGroup(ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, NeptuneException
Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following:
ParameterName,ParameterValue, 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_databaseparameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.- Parameters:
modifyDbClusterParameterGroupRequest-- Returns:
- Result of the ModifyDBClusterParameterGroup operation returned by the service.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.InvalidDbParameterGroupStateException- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
modifyDBClusterParameterGroup
default ModifyDbClusterParameterGroupResponse modifyDBClusterParameterGroup(Consumer<ModifyDbClusterParameterGroupRequest.Builder> modifyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, NeptuneException
Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following:
ParameterName,ParameterValue, 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_databaseparameter. 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.Builderavoiding the need to create one manually viaModifyDbClusterParameterGroupRequest.builder()- Parameters:
modifyDbClusterParameterGroupRequest- AConsumerthat will call methods onModifyDbClusterParameterGroupRequest.Builderto create a request.- Returns:
- Result of the ModifyDBClusterParameterGroup operation returned by the service.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.InvalidDbParameterGroupStateException- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
modifyDBClusterSnapshotAttribute
default ModifyDbClusterSnapshotAttributeResponse modifyDBClusterSnapshotAttribute(ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest) throws DbClusterSnapshotNotFoundException, InvalidDbClusterSnapshotStateException, SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other Amazon accounts, specify
restoreas theAttributeNameand use theValuesToAddparameter to add a list of IDs of the Amazon accounts that are authorized to restore the manual DB cluster snapshot. Use the valueallto make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon accounts. Do not add theallvalue 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 theValuesToAddparameter. You can't useallas a value for that parameter in this case.To view which Amazon accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.
- Parameters:
modifyDbClusterSnapshotAttributeRequest-- Returns:
- Result of the ModifyDBClusterSnapshotAttribute operation returned by the service.
- Throws:
DbClusterSnapshotNotFoundException- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.InvalidDbClusterSnapshotStateException- The supplied value is not a valid DB cluster snapshot state.SharedSnapshotQuotaExceededException- You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
modifyDBClusterSnapshotAttribute
default ModifyDbClusterSnapshotAttributeResponse modifyDBClusterSnapshotAttribute(Consumer<ModifyDbClusterSnapshotAttributeRequest.Builder> modifyDbClusterSnapshotAttributeRequest) throws DbClusterSnapshotNotFoundException, InvalidDbClusterSnapshotStateException, SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other Amazon accounts, specify
restoreas theAttributeNameand use theValuesToAddparameter to add a list of IDs of the Amazon accounts that are authorized to restore the manual DB cluster snapshot. Use the valueallto make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon accounts. Do not add theallvalue 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 theValuesToAddparameter. You can't useallas 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.Builderavoiding the need to create one manually viaModifyDbClusterSnapshotAttributeRequest.builder()- Parameters:
modifyDbClusterSnapshotAttributeRequest- AConsumerthat will call methods onModifyDbClusterSnapshotAttributeRequest.Builderto create a request.- Returns:
- Result of the ModifyDBClusterSnapshotAttribute operation returned by the service.
- Throws:
DbClusterSnapshotNotFoundException- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.InvalidDbClusterSnapshotStateException- The supplied value is not a valid DB cluster snapshot state.SharedSnapshotQuotaExceededException- You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
modifyDBInstance
default ModifyDbInstanceResponse modifyDBInstance(ModifyDbInstanceRequest modifyDbInstanceRequest) throws InvalidDbInstanceStateException, InvalidDbSecurityGroupStateException, DbInstanceAlreadyExistsException, DbInstanceNotFoundException, DbSecurityGroupNotFoundException, DbParameterGroupNotFoundException, InsufficientDbInstanceCapacityException, StorageQuotaExceededException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbUpgradeDependencyFailureException, StorageTypeNotSupportedException, AuthorizationNotFoundException, CertificateNotFoundException, DomainNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.
- Parameters:
modifyDbInstanceRequest-- Returns:
- Result of the ModifyDBInstance operation returned by the service.
- Throws:
InvalidDbInstanceStateException- The specified DB instance is not in the available state.InvalidDbSecurityGroupStateException- The state of the DB security group does not allow deletion.DbInstanceAlreadyExistsException- User already has a DB instance with the given identifier.DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.DbSecurityGroupNotFoundException- DBSecurityGroupName does not refer to an existing DB security group.DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.InsufficientDbInstanceCapacityException- Specified DB instance class is not available in the specified Availability Zone.StorageQuotaExceededException- Request would result in user exceeding the allowed amount of storage available across all DB instances.InvalidVpcNetworkStateException- DB subnet group does not cover all Availability Zones after it is created because users' change.ProvisionedIopsNotAvailableInAzException- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException- The designated option group could not be found.DbUpgradeDependencyFailureException- The DB upgrade failed because a resource the DB depends on could not be modified.StorageTypeNotSupportedException- StorageType specified cannot be associated with the DB Instance.AuthorizationNotFoundException- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.Neptune may not also be authorized via IAM to perform necessary actions on your behalf.
CertificateNotFoundException- CertificateIdentifier does not refer to an existing certificate.DomainNotFoundException- Domain does not refer to an existing Active Directory Domain.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
modifyDBInstance
default ModifyDbInstanceResponse modifyDBInstance(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest) throws InvalidDbInstanceStateException, InvalidDbSecurityGroupStateException, DbInstanceAlreadyExistsException, DbInstanceNotFoundException, DbSecurityGroupNotFoundException, DbParameterGroupNotFoundException, InsufficientDbInstanceCapacityException, StorageQuotaExceededException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbUpgradeDependencyFailureException, StorageTypeNotSupportedException, AuthorizationNotFoundException, CertificateNotFoundException, DomainNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.
This is a convenience which creates an instance of the
ModifyDbInstanceRequest.Builderavoiding the need to create one manually viaModifyDbInstanceRequest.builder()- Parameters:
modifyDbInstanceRequest- AConsumerthat will call methods onModifyDbInstanceRequest.Builderto create a request.- Returns:
- Result of the ModifyDBInstance operation returned by the service.
- Throws:
InvalidDbInstanceStateException- The specified DB instance is not in the available state.InvalidDbSecurityGroupStateException- The state of the DB security group does not allow deletion.DbInstanceAlreadyExistsException- User already has a DB instance with the given identifier.DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.DbSecurityGroupNotFoundException- DBSecurityGroupName does not refer to an existing DB security group.DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.InsufficientDbInstanceCapacityException- Specified DB instance class is not available in the specified Availability Zone.StorageQuotaExceededException- Request would result in user exceeding the allowed amount of storage available across all DB instances.InvalidVpcNetworkStateException- DB subnet group does not cover all Availability Zones after it is created because users' change.ProvisionedIopsNotAvailableInAzException- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException- The designated option group could not be found.DbUpgradeDependencyFailureException- The DB upgrade failed because a resource the DB depends on could not be modified.StorageTypeNotSupportedException- StorageType specified cannot be associated with the DB Instance.AuthorizationNotFoundException- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.Neptune may not also be authorized via IAM to perform necessary actions on your behalf.
CertificateNotFoundException- CertificateIdentifier does not refer to an existing certificate.DomainNotFoundException- Domain does not refer to an existing Active Directory Domain.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
modifyDBParameterGroup
default ModifyDbParameterGroupResponse modifyDBParameterGroup(ModifyDbParameterGroupRequest modifyDbParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, NeptuneException
Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following:
ParameterName,ParameterValue, 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_databaseparameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.- Parameters:
modifyDbParameterGroupRequest-- Returns:
- Result of the ModifyDBParameterGroup operation returned by the service.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.InvalidDbParameterGroupStateException- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
modifyDBParameterGroup
default ModifyDbParameterGroupResponse modifyDBParameterGroup(Consumer<ModifyDbParameterGroupRequest.Builder> modifyDbParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, NeptuneException
Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following:
ParameterName,ParameterValue, 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_databaseparameter. 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.Builderavoiding the need to create one manually viaModifyDbParameterGroupRequest.builder()- Parameters:
modifyDbParameterGroupRequest- AConsumerthat will call methods onModifyDbParameterGroupRequest.Builderto create a request.- Returns:
- Result of the ModifyDBParameterGroup operation returned by the service.
- Throws:
DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.InvalidDbParameterGroupStateException- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
modifyDBSubnetGroup
default ModifyDbSubnetGroupResponse modifyDBSubnetGroup(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest) throws DbSubnetGroupNotFoundException, DbSubnetQuotaExceededException, SubnetAlreadyInUseException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, NeptuneException
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.
- Parameters:
modifyDbSubnetGroupRequest-- Returns:
- Result of the ModifyDBSubnetGroup operation returned by the service.
- Throws:
DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.DbSubnetQuotaExceededException- Request would result in user exceeding the allowed number of subnets in a DB subnet groups.SubnetAlreadyInUseException- The DB subnet is already in use in the Availability Zone.DbSubnetGroupDoesNotCoverEnoughAZsException- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidSubnetException- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
modifyDBSubnetGroup
default ModifyDbSubnetGroupResponse modifyDBSubnetGroup(Consumer<ModifyDbSubnetGroupRequest.Builder> modifyDbSubnetGroupRequest) throws DbSubnetGroupNotFoundException, DbSubnetQuotaExceededException, SubnetAlreadyInUseException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, NeptuneException
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.
This is a convenience which creates an instance of the
ModifyDbSubnetGroupRequest.Builderavoiding the need to create one manually viaModifyDbSubnetGroupRequest.builder()- Parameters:
modifyDbSubnetGroupRequest- AConsumerthat will call methods onModifyDbSubnetGroupRequest.Builderto create a request.- Returns:
- Result of the ModifyDBSubnetGroup operation returned by the service.
- Throws:
DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.DbSubnetQuotaExceededException- Request would result in user exceeding the allowed number of subnets in a DB subnet groups.SubnetAlreadyInUseException- The DB subnet is already in use in the Availability Zone.DbSubnetGroupDoesNotCoverEnoughAZsException- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidSubnetException- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
modifyEventSubscription
default ModifyEventSubscriptionResponse modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionNotFoundException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action.
- Parameters:
modifyEventSubscriptionRequest-- Returns:
- Result of the ModifyEventSubscription operation returned by the service.
- Throws:
EventSubscriptionQuotaExceededException- You have exceeded the number of events you can subscribe to.SubscriptionNotFoundException- The designated subscription could not be found.SnsInvalidTopicException- The SNS topic is invalid.SnsNoAuthorizationException- There is no SNS authorization.SnsTopicArnNotFoundException- The ARN of the SNS topic could not be found.SubscriptionCategoryNotFoundException- The designated subscription category could not be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
modifyEventSubscription
default ModifyEventSubscriptionResponse modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionNotFoundException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action.
This is a convenience which creates an instance of the
ModifyEventSubscriptionRequest.Builderavoiding the need to create one manually viaModifyEventSubscriptionRequest.builder()- Parameters:
modifyEventSubscriptionRequest- AConsumerthat will call methods onModifyEventSubscriptionRequest.Builderto create a request.- Returns:
- Result of the ModifyEventSubscription operation returned by the service.
- Throws:
EventSubscriptionQuotaExceededException- You have exceeded the number of events you can subscribe to.SubscriptionNotFoundException- The designated subscription could not be found.SnsInvalidTopicException- The SNS topic is invalid.SnsNoAuthorizationException- There is no SNS authorization.SnsTopicArnNotFoundException- The ARN of the SNS topic could not be found.SubscriptionCategoryNotFoundException- The designated subscription category could not be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
modifyGlobalCluster
default ModifyGlobalClusterResponse modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, NeptuneException
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:
- Result of the ModifyGlobalCluster operation returned by the service.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn'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.AwsServiceException- See Also:
- AWS API Documentation
-
modifyGlobalCluster
default ModifyGlobalClusterResponse modifyGlobalCluster(Consumer<ModifyGlobalClusterRequest.Builder> modifyGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, NeptuneException
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.Builderavoiding the need to create one manually viaModifyGlobalClusterRequest.builder()- Parameters:
modifyGlobalClusterRequest- AConsumerthat will call methods onModifyGlobalClusterRequest.Builderto create a request.- Returns:
- Result of the ModifyGlobalCluster operation returned by the service.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn'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.AwsServiceException- See Also:
- AWS API Documentation
-
promoteReadReplicaDBCluster
default PromoteReadReplicaDbClusterResponse promoteReadReplicaDBCluster(PromoteReadReplicaDbClusterRequest promoteReadReplicaDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException
Not supported.
- Parameters:
promoteReadReplicaDbClusterRequest-- Returns:
- Result of the PromoteReadReplicaDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDbClusterStateException- The DB cluster is not in a valid state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
promoteReadReplicaDBCluster
default PromoteReadReplicaDbClusterResponse promoteReadReplicaDBCluster(Consumer<PromoteReadReplicaDbClusterRequest.Builder> promoteReadReplicaDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException
Not supported.
This is a convenience which creates an instance of the
PromoteReadReplicaDbClusterRequest.Builderavoiding the need to create one manually viaPromoteReadReplicaDbClusterRequest.builder()- Parameters:
promoteReadReplicaDbClusterRequest- AConsumerthat will call methods onPromoteReadReplicaDbClusterRequest.Builderto create a request.- Returns:
- Result of the PromoteReadReplicaDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDbClusterStateException- The DB cluster is not in a valid state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
rebootDBInstance
default RebootDbInstanceResponse rebootDBInstance(RebootDbInstanceRequest rebootDbInstanceRequest) throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
- Parameters:
rebootDbInstanceRequest-- Returns:
- Result of the RebootDBInstance operation returned by the service.
- Throws:
InvalidDbInstanceStateException- The specified DB instance is not in the available state.DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
rebootDBInstance
default RebootDbInstanceResponse rebootDBInstance(Consumer<RebootDbInstanceRequest.Builder> rebootDbInstanceRequest) throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
This is a convenience which creates an instance of the
RebootDbInstanceRequest.Builderavoiding the need to create one manually viaRebootDbInstanceRequest.builder()- Parameters:
rebootDbInstanceRequest- AConsumerthat will call methods onRebootDbInstanceRequest.Builderto create a request.- Returns:
- Result of the RebootDBInstance operation returned by the service.
- Throws:
InvalidDbInstanceStateException- The specified DB instance is not in the available state.DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
removeFromGlobalCluster
default RemoveFromGlobalClusterResponse removeFromGlobalCluster(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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:
- Result of the RemoveFromGlobalCluster operation returned by the service.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn'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.AwsServiceException- See Also:
- AWS API Documentation
-
removeFromGlobalCluster
default RemoveFromGlobalClusterResponse removeFromGlobalCluster(Consumer<RemoveFromGlobalClusterRequest.Builder> removeFromGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.Builderavoiding the need to create one manually viaRemoveFromGlobalClusterRequest.builder()- Parameters:
removeFromGlobalClusterRequest- AConsumerthat will call methods onRemoveFromGlobalClusterRequest.Builderto create a request.- Returns:
- Result of the RemoveFromGlobalCluster operation returned by the service.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn'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.AwsServiceException- See Also:
- AWS API Documentation
-
removeRoleFromDBCluster
default RemoveRoleFromDbClusterResponse removeRoleFromDBCluster(RemoveRoleFromDbClusterRequest removeRoleFromDbClusterRequest) throws DbClusterNotFoundException, DbClusterRoleNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException
Disassociates an Identity and Access Management (IAM) role from a DB cluster.
- Parameters:
removeRoleFromDbClusterRequest-- Returns:
- Result of the RemoveRoleFromDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.DbClusterRoleNotFoundException- The specified IAM role Amazon Resource Name (ARN) is not associated with the specified DB cluster.InvalidDbClusterStateException- The DB cluster is not in a valid state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
removeRoleFromDBCluster
default RemoveRoleFromDbClusterResponse removeRoleFromDBCluster(Consumer<RemoveRoleFromDbClusterRequest.Builder> removeRoleFromDbClusterRequest) throws DbClusterNotFoundException, DbClusterRoleNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException
Disassociates an Identity and Access Management (IAM) role from a DB cluster.
This is a convenience which creates an instance of the
RemoveRoleFromDbClusterRequest.Builderavoiding the need to create one manually viaRemoveRoleFromDbClusterRequest.builder()- Parameters:
removeRoleFromDbClusterRequest- AConsumerthat will call methods onRemoveRoleFromDbClusterRequest.Builderto create a request.- Returns:
- Result of the RemoveRoleFromDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.DbClusterRoleNotFoundException- The specified IAM role Amazon Resource Name (ARN) is not associated with the specified DB cluster.InvalidDbClusterStateException- The DB cluster is not in a valid state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
removeSourceIdentifierFromSubscription
default RemoveSourceIdentifierFromSubscriptionResponse removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Removes a source identifier from an existing event notification subscription.
- Parameters:
removeSourceIdentifierFromSubscriptionRequest-- Returns:
- Result of the RemoveSourceIdentifierFromSubscription operation returned by the service.
- Throws:
SubscriptionNotFoundException- The designated subscription could not be found.SourceNotFoundException- The source could not be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
removeSourceIdentifierFromSubscription
default RemoveSourceIdentifierFromSubscriptionResponse removeSourceIdentifierFromSubscription(Consumer<RemoveSourceIdentifierFromSubscriptionRequest.Builder> removeSourceIdentifierFromSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Removes a source identifier from an existing event notification subscription.
This is a convenience which creates an instance of the
RemoveSourceIdentifierFromSubscriptionRequest.Builderavoiding the need to create one manually viaRemoveSourceIdentifierFromSubscriptionRequest.builder()- Parameters:
removeSourceIdentifierFromSubscriptionRequest- AConsumerthat will call methods onRemoveSourceIdentifierFromSubscriptionRequest.Builderto create a request.- Returns:
- Result of the RemoveSourceIdentifierFromSubscription operation returned by the service.
- Throws:
SubscriptionNotFoundException- The designated subscription could not be found.SourceNotFoundException- The source could not be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
removeTagsFromResource
default RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Removes metadata tags from an Amazon Neptune resource.
- Parameters:
removeTagsFromResourceRequest-- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- Throws:
DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.DbSnapshotNotFoundException- DBSnapshotIdentifier does not refer to an existing DB snapshot.DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
removeTagsFromResource
default RemoveTagsFromResourceResponse removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Removes metadata tags from an Amazon Neptune resource.
This is a convenience which creates an instance of the
RemoveTagsFromResourceRequest.Builderavoiding the need to create one manually viaRemoveTagsFromResourceRequest.builder()- Parameters:
removeTagsFromResourceRequest- AConsumerthat will call methods onRemoveTagsFromResourceRequest.Builderto create a request.- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- Throws:
DbInstanceNotFoundException- DBInstanceIdentifier does not refer to an existing DB instance.DbSnapshotNotFoundException- DBSnapshotIdentifier does not refer to an existing DB snapshot.DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
resetDBClusterParameterGroup
default ResetDbClusterParameterGroupResponse resetDBClusterParameterGroup(ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following:
ParameterNameandApplyMethod. To reset the entire DB cluster parameter group, specify theDBClusterParameterGroupNameandResetAllParametersparameters.When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to
pending-rebootto take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.- Parameters:
resetDbClusterParameterGroupRequest-- Returns:
- Result of the ResetDBClusterParameterGroup operation returned by the service.
- Throws:
InvalidDbParameterGroupStateException- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
resetDBClusterParameterGroup
default ResetDbClusterParameterGroupResponse resetDBClusterParameterGroup(Consumer<ResetDbClusterParameterGroupRequest.Builder> resetDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following:
ParameterNameandApplyMethod. To reset the entire DB cluster parameter group, specify theDBClusterParameterGroupNameandResetAllParametersparameters.When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to
pending-rebootto 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.Builderavoiding the need to create one manually viaResetDbClusterParameterGroupRequest.builder()- Parameters:
resetDbClusterParameterGroupRequest- AConsumerthat will call methods onResetDbClusterParameterGroupRequest.Builderto create a request.- Returns:
- Result of the ResetDBClusterParameterGroup operation returned by the service.
- Throws:
InvalidDbParameterGroupStateException- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
resetDBParameterGroup
default ResetDbParameterGroupResponse resetDBParameterGroup(ResetDbParameterGroupRequest resetDbParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following:
ParameterNameandApplyMethod. To reset the entire DB parameter group, specify theDBParameterGroupname andResetAllParametersparameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set topending-rebootto take effect on the next DB instance restart orRebootDBInstancerequest.- Parameters:
resetDbParameterGroupRequest-- Returns:
- Result of the ResetDBParameterGroup operation returned by the service.
- Throws:
InvalidDbParameterGroupStateException- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
resetDBParameterGroup
default ResetDbParameterGroupResponse resetDBParameterGroup(Consumer<ResetDbParameterGroupRequest.Builder> resetDbParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following:
ParameterNameandApplyMethod. To reset the entire DB parameter group, specify theDBParameterGroupname andResetAllParametersparameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set topending-rebootto take effect on the next DB instance restart orRebootDBInstancerequest.
This is a convenience which creates an instance of the
ResetDbParameterGroupRequest.Builderavoiding the need to create one manually viaResetDbParameterGroupRequest.builder()- Parameters:
resetDbParameterGroupRequest- AConsumerthat will call methods onResetDbParameterGroupRequest.Builderto create a request.- Returns:
- Result of the ResetDBParameterGroup operation returned by the service.
- Throws:
InvalidDbParameterGroupStateException- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.DbParameterGroupNotFoundException- DBParameterGroupName does not refer to an existing DB parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
restoreDBClusterFromSnapshot
default RestoreDbClusterFromSnapshotResponse restoreDBClusterFromSnapshot(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest) throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbSnapshotStateException, InvalidDbClusterSnapshotStateException, InvalidVpcNetworkStateException, InvalidRestoreException, InvalidSubnetException, OptionGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- Parameters:
restoreDbClusterFromSnapshotRequest-- Returns:
- Result of the RestoreDBClusterFromSnapshot operation returned by the service.
- Throws:
DbClusterAlreadyExistsException- User already has a DB cluster with the given identifier.DbClusterQuotaExceededException- User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.StorageQuotaExceededException- Request would result in user exceeding the allowed amount of storage available across all DB instances.DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.DbSnapshotNotFoundException- DBSnapshotIdentifier does not refer to an existing DB snapshot.DbClusterSnapshotNotFoundException- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.InsufficientDbClusterCapacityException- The DB cluster does not have enough capacity for the current operation.InsufficientStorageClusterCapacityException- There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.InvalidDbSnapshotStateException- The state of the DB snapshot does not allow deletion.InvalidDbClusterSnapshotStateException- The supplied value is not a valid DB cluster snapshot state.StorageQuotaExceededException- Request would result in user exceeding the allowed amount of storage available across all DB instances.InvalidVpcNetworkStateException- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidRestoreException- Cannot restore from vpc backup to non-vpc DB instance.DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.InvalidSubnetException- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.OptionGroupNotFoundException- The designated option group could not be found.KmsKeyNotAccessibleException- Error accessing KMS key.DbClusterParameterGroupNotFoundException- DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
restoreDBClusterFromSnapshot
default RestoreDbClusterFromSnapshotResponse restoreDBClusterFromSnapshot(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest) throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbSnapshotStateException, InvalidDbClusterSnapshotStateException, InvalidVpcNetworkStateException, InvalidRestoreException, InvalidSubnetException, OptionGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
This is a convenience which creates an instance of the
RestoreDbClusterFromSnapshotRequest.Builderavoiding the need to create one manually viaRestoreDbClusterFromSnapshotRequest.builder()- Parameters:
restoreDbClusterFromSnapshotRequest- AConsumerthat will call methods onRestoreDbClusterFromSnapshotRequest.Builderto create a request.- Returns:
- Result of the RestoreDBClusterFromSnapshot operation returned by the service.
- Throws:
DbClusterAlreadyExistsException- User already has a DB cluster with the given identifier.DbClusterQuotaExceededException- User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.StorageQuotaExceededException- Request would result in user exceeding the allowed amount of storage available across all DB instances.DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.DbSnapshotNotFoundException- DBSnapshotIdentifier does not refer to an existing DB snapshot.DbClusterSnapshotNotFoundException- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.InsufficientDbClusterCapacityException- The DB cluster does not have enough capacity for the current operation.InsufficientStorageClusterCapacityException- There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.InvalidDbSnapshotStateException- The state of the DB snapshot does not allow deletion.InvalidDbClusterSnapshotStateException- The supplied value is not a valid DB cluster snapshot state.StorageQuotaExceededException- Request would result in user exceeding the allowed amount of storage available across all DB instances.InvalidVpcNetworkStateException- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidRestoreException- Cannot restore from vpc backup to non-vpc DB instance.DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.InvalidSubnetException- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.OptionGroupNotFoundException- The designated option group could not be found.KmsKeyNotAccessibleException- Error accessing KMS key.DbClusterParameterGroupNotFoundException- DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
restoreDBClusterToPointInTime
default RestoreDbClusterToPointInTimeResponse restoreDBClusterToPointInTime(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest) throws DbClusterAlreadyExistsException, DbClusterNotFoundException, DbClusterQuotaExceededException, DbClusterSnapshotNotFoundException, DbSubnetGroupNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbClusterSnapshotStateException, InvalidDbClusterStateException, InvalidDbSnapshotStateException, InvalidRestoreException, InvalidSubnetException, InvalidVpcNetworkStateException, KmsKeyNotAccessibleException, OptionGroupNotFoundException, StorageQuotaExceededException, DbClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTimefor up toBackupRetentionPerioddays. 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 theRestoreDBClusterToPointInTimeaction has completed and the DB cluster is available.- Parameters:
restoreDbClusterToPointInTimeRequest-- Returns:
- Result of the RestoreDBClusterToPointInTime operation returned by the service.
- Throws:
DbClusterAlreadyExistsException- User already has a DB cluster with the given identifier.DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.DbClusterQuotaExceededException- User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.DbClusterSnapshotNotFoundException- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.InsufficientDbClusterCapacityException- The DB cluster does not have enough capacity for the current operation.InsufficientStorageClusterCapacityException- There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.InvalidDbClusterSnapshotStateException- The supplied value is not a valid DB cluster snapshot state.InvalidDbClusterStateException- The DB cluster is not in a valid state.InvalidDbSnapshotStateException- The state of the DB snapshot does not allow deletion.InvalidRestoreException- Cannot restore from vpc backup to non-vpc DB instance.InvalidSubnetException- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVpcNetworkStateException- DB subnet group does not cover all Availability Zones after it is created because users' change.KmsKeyNotAccessibleException- Error accessing KMS key.OptionGroupNotFoundException- The designated option group could not be found.StorageQuotaExceededException- Request would result in user exceeding the allowed amount of storage available across all DB instances.DbClusterParameterGroupNotFoundException- DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
restoreDBClusterToPointInTime
default RestoreDbClusterToPointInTimeResponse restoreDBClusterToPointInTime(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest) throws DbClusterAlreadyExistsException, DbClusterNotFoundException, DbClusterQuotaExceededException, DbClusterSnapshotNotFoundException, DbSubnetGroupNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbClusterSnapshotStateException, InvalidDbClusterStateException, InvalidDbSnapshotStateException, InvalidRestoreException, InvalidSubnetException, InvalidVpcNetworkStateException, KmsKeyNotAccessibleException, OptionGroupNotFoundException, StorageQuotaExceededException, DbClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTimefor up toBackupRetentionPerioddays. 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 theRestoreDBClusterToPointInTimeaction has completed and the DB cluster is available.
This is a convenience which creates an instance of the
RestoreDbClusterToPointInTimeRequest.Builderavoiding the need to create one manually viaRestoreDbClusterToPointInTimeRequest.builder()- Parameters:
restoreDbClusterToPointInTimeRequest- AConsumerthat will call methods onRestoreDbClusterToPointInTimeRequest.Builderto create a request.- Returns:
- Result of the RestoreDBClusterToPointInTime operation returned by the service.
- Throws:
DbClusterAlreadyExistsException- User already has a DB cluster with the given identifier.DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.DbClusterQuotaExceededException- User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.DbClusterSnapshotNotFoundException- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.DbSubnetGroupNotFoundException- DBSubnetGroupName does not refer to an existing DB subnet group.InsufficientDbClusterCapacityException- The DB cluster does not have enough capacity for the current operation.InsufficientStorageClusterCapacityException- There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.InvalidDbClusterSnapshotStateException- The supplied value is not a valid DB cluster snapshot state.InvalidDbClusterStateException- The DB cluster is not in a valid state.InvalidDbSnapshotStateException- The state of the DB snapshot does not allow deletion.InvalidRestoreException- Cannot restore from vpc backup to non-vpc DB instance.InvalidSubnetException- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVpcNetworkStateException- DB subnet group does not cover all Availability Zones after it is created because users' change.KmsKeyNotAccessibleException- Error accessing KMS key.OptionGroupNotFoundException- The designated option group could not be found.StorageQuotaExceededException- Request would result in user exceeding the allowed amount of storage available across all DB instances.DbClusterParameterGroupNotFoundException- DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startDBCluster
default StartDbClusterResponse startDBCluster(StartDbClusterRequest startDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException
Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.
- Parameters:
startDbClusterRequest-- Returns:
- Result of the StartDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDbClusterStateException- The DB cluster is not in a valid state.InvalidDbInstanceStateException- The specified DB instance is not in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startDBCluster
default StartDbClusterResponse startDBCluster(Consumer<StartDbClusterRequest.Builder> startDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException
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.Builderavoiding the need to create one manually viaStartDbClusterRequest.builder()- Parameters:
startDbClusterRequest- AConsumerthat will call methods onStartDbClusterRequest.Builderto create a request.- Returns:
- Result of the StartDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDbClusterStateException- The DB cluster is not in a valid state.InvalidDbInstanceStateException- The specified DB instance is not in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopDBCluster
default StopDbClusterResponse stopDBCluster(StopDbClusterRequest stopDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException
Stops an Amazon Neptune DB cluster. When you stop a DB cluster, Neptune retains the DB cluster's metadata, including its endpoints and DB parameter groups.
Neptune also retains the transaction logs so you can do a point-in-time restore if necessary.
- Parameters:
stopDbClusterRequest-- Returns:
- Result of the StopDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDbClusterStateException- The DB cluster is not in a valid state.InvalidDbInstanceStateException- The specified DB instance is not in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopDBCluster
default StopDbClusterResponse stopDBCluster(Consumer<StopDbClusterRequest.Builder> stopDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException
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.Builderavoiding the need to create one manually viaStopDbClusterRequest.builder()- Parameters:
stopDbClusterRequest- AConsumerthat will call methods onStopDbClusterRequest.Builderto create a request.- Returns:
- Result of the StopDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDbClusterStateException- The DB cluster is not in a valid state.InvalidDbInstanceStateException- The specified DB instance is not in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
waiter
default NeptuneWaiter waiter()
Create an instance ofNeptuneWaiterusing 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
NeptuneWaiter
-
create
static NeptuneClient create()
Create aNeptuneClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static NeptuneClientBuilder builder()
Create a builder that can be used to configure and create aNeptuneClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default NeptuneServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-