neptune/aws.sdk.kotlin.services.neptune

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

addRoleToDbCluster

inline suspend fun NeptuneClient.addRoleToDbCluster(crossinline block: AddRoleToDbClusterRequest.Builder.() -> Unit): AddRoleToDbClusterResponse

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

addSourceIdentifierToSubscription

inline suspend fun NeptuneClient.addSourceIdentifierToSubscription(crossinline block: AddSourceIdentifierToSubscriptionRequest.Builder.() -> Unit): AddSourceIdentifierToSubscriptionResponse

Adds a source identifier to an existing event notification subscription.

addTagsToResource

inline suspend fun NeptuneClient.addTagsToResource(crossinline block: AddTagsToResourceRequest.Builder.() -> Unit): AddTagsToResourceResponse

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.

applyPendingMaintenanceAction

inline suspend fun NeptuneClient.applyPendingMaintenanceAction(crossinline block: ApplyPendingMaintenanceActionRequest.Builder.() -> Unit): ApplyPendingMaintenanceActionResponse

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

copyDbClusterParameterGroup

inline suspend fun NeptuneClient.copyDbClusterParameterGroup(crossinline block: CopyDbClusterParameterGroupRequest.Builder.() -> Unit): CopyDbClusterParameterGroupResponse

Copies the specified DB cluster parameter group.

copyDbClusterSnapshot

inline suspend fun NeptuneClient.copyDbClusterSnapshot(crossinline block: CopyDbClusterSnapshotRequest.Builder.() -> Unit): CopyDbClusterSnapshotResponse

Copies a snapshot of a DB cluster.

copyDbParameterGroup

inline suspend fun NeptuneClient.copyDbParameterGroup(crossinline block: CopyDbParameterGroupRequest.Builder.() -> Unit): CopyDbParameterGroupResponse

Copies the specified DB parameter group.

createDbCluster

inline suspend fun NeptuneClient.createDbCluster(crossinline block: CreateDbClusterRequest.Builder.() -> Unit): CreateDbClusterResponse

Creates a new Amazon Neptune DB cluster.

createDbClusterEndpoint

inline suspend fun NeptuneClient.createDbClusterEndpoint(crossinline block: CreateDbClusterEndpointRequest.Builder.() -> Unit): CreateDbClusterEndpointResponse

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

createDbClusterParameterGroup

inline suspend fun NeptuneClient.createDbClusterParameterGroup(crossinline block: CreateDbClusterParameterGroupRequest.Builder.() -> Unit): CreateDbClusterParameterGroupResponse

Creates a new DB cluster parameter group.

createDbClusterSnapshot

inline suspend fun NeptuneClient.createDbClusterSnapshot(crossinline block: CreateDbClusterSnapshotRequest.Builder.() -> Unit): CreateDbClusterSnapshotResponse

Creates a snapshot of a DB cluster.

createDbInstance

inline suspend fun NeptuneClient.createDbInstance(crossinline block: CreateDbInstanceRequest.Builder.() -> Unit): CreateDbInstanceResponse

Creates a new DB instance.

createDbParameterGroup

inline suspend fun NeptuneClient.createDbParameterGroup(crossinline block: CreateDbParameterGroupRequest.Builder.() -> Unit): CreateDbParameterGroupResponse

Creates a new DB parameter group.

createDbSubnetGroup

inline suspend fun NeptuneClient.createDbSubnetGroup(crossinline block: CreateDbSubnetGroupRequest.Builder.() -> Unit): CreateDbSubnetGroupResponse

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.

createEventSubscription

inline suspend fun NeptuneClient.createEventSubscription(crossinline block: CreateEventSubscriptionRequest.Builder.() -> Unit): CreateEventSubscriptionResponse

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.

createGlobalCluster

inline suspend fun NeptuneClient.createGlobalCluster(crossinline block: CreateGlobalClusterRequest.Builder.() -> Unit): CreateGlobalClusterResponse

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.

deleteDbCluster

inline suspend fun NeptuneClient.deleteDbCluster(crossinline block: DeleteDbClusterRequest.Builder.() -> Unit): DeleteDbClusterResponse

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.

deleteDbClusterEndpoint

inline suspend fun NeptuneClient.deleteDbClusterEndpoint(crossinline block: DeleteDbClusterEndpointRequest.Builder.() -> Unit): DeleteDbClusterEndpointResponse

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

deleteDbClusterParameterGroup

inline suspend fun NeptuneClient.deleteDbClusterParameterGroup(crossinline block: DeleteDbClusterParameterGroupRequest.Builder.() -> Unit): DeleteDbClusterParameterGroupResponse

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

deleteDbClusterSnapshot

inline suspend fun NeptuneClient.deleteDbClusterSnapshot(crossinline block: DeleteDbClusterSnapshotRequest.Builder.() -> Unit): DeleteDbClusterSnapshotResponse

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

deleteDbInstance

inline suspend fun NeptuneClient.deleteDbInstance(crossinline block: DeleteDbInstanceRequest.Builder.() -> Unit): DeleteDbInstanceResponse

The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

deleteDbParameterGroup

inline suspend fun NeptuneClient.deleteDbParameterGroup(crossinline block: DeleteDbParameterGroupRequest.Builder.() -> Unit): DeleteDbParameterGroupResponse

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

deleteDbSubnetGroup

inline suspend fun NeptuneClient.deleteDbSubnetGroup(crossinline block: DeleteDbSubnetGroupRequest.Builder.() -> Unit): DeleteDbSubnetGroupResponse

Deletes a DB subnet group.

deleteEventSubscription

inline suspend fun NeptuneClient.deleteEventSubscription(crossinline block: DeleteEventSubscriptionRequest.Builder.() -> Unit): DeleteEventSubscriptionResponse

Deletes an event notification subscription.

deleteGlobalCluster

inline suspend fun NeptuneClient.deleteGlobalCluster(crossinline block: DeleteGlobalClusterRequest.Builder.() -> Unit): DeleteGlobalClusterResponse

Deletes a global database. The primary and all secondary clusters must already be detached or deleted first.

describeDbClusterEndpoints

inline suspend fun NeptuneClient.describeDbClusterEndpoints(crossinline block: DescribeDbClusterEndpointsRequest.Builder.() -> Unit): DescribeDbClusterEndpointsResponse

Returns information about endpoints for an Amazon Neptune DB cluster.

describeDbClusterParameterGroups

inline suspend fun NeptuneClient.describeDbClusterParameterGroups(crossinline block: DescribeDbClusterParameterGroupsRequest.Builder.() -> Unit): DescribeDbClusterParameterGroupsResponse

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

describeDbClusterParameters

inline suspend fun NeptuneClient.describeDbClusterParameters(crossinline block: DescribeDbClusterParametersRequest.Builder.() -> Unit): DescribeDbClusterParametersResponse

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

describeDbClusters

inline suspend fun NeptuneClient.describeDbClusters(crossinline block: DescribeDbClustersRequest.Builder.() -> Unit): DescribeDbClustersResponse

Returns information about provisioned DB clusters, and supports pagination.

describeDbClusterSnapshotAttributes

inline suspend fun NeptuneClient.describeDbClusterSnapshotAttributes(crossinline block: DescribeDbClusterSnapshotAttributesRequest.Builder.() -> Unit): DescribeDbClusterSnapshotAttributesResponse

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

describeDbClusterSnapshots

inline suspend fun NeptuneClient.describeDbClusterSnapshots(crossinline block: DescribeDbClusterSnapshotsRequest.Builder.() -> Unit): DescribeDbClusterSnapshotsResponse

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

describeDbEngineVersions

inline suspend fun NeptuneClient.describeDbEngineVersions(crossinline block: DescribeDbEngineVersionsRequest.Builder.() -> Unit): DescribeDbEngineVersionsResponse

Returns a list of the available DB engines.

describeDbInstances

inline suspend fun NeptuneClient.describeDbInstances(crossinline block: DescribeDbInstancesRequest.Builder.() -> Unit): DescribeDbInstancesResponse

Returns information about provisioned instances, and supports pagination.

describeDbParameterGroups

inline suspend fun NeptuneClient.describeDbParameterGroups(crossinline block: DescribeDbParameterGroupsRequest.Builder.() -> Unit): DescribeDbParameterGroupsResponse

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

describeDbParameters

inline suspend fun NeptuneClient.describeDbParameters(crossinline block: DescribeDbParametersRequest.Builder.() -> Unit): DescribeDbParametersResponse

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

describeDbSubnetGroups

inline suspend fun NeptuneClient.describeDbSubnetGroups(crossinline block: DescribeDbSubnetGroupsRequest.Builder.() -> Unit): DescribeDbSubnetGroupsResponse

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

describeEngineDefaultClusterParameters

inline suspend fun NeptuneClient.describeEngineDefaultClusterParameters(crossinline block: DescribeEngineDefaultClusterParametersRequest.Builder.() -> Unit): DescribeEngineDefaultClusterParametersResponse

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

describeEngineDefaultParameters

inline suspend fun NeptuneClient.describeEngineDefaultParameters(crossinline block: DescribeEngineDefaultParametersRequest.Builder.() -> Unit): DescribeEngineDefaultParametersResponse

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

describeEventCategories

inline suspend fun NeptuneClient.describeEventCategories(crossinline block: DescribeEventCategoriesRequest.Builder.() -> Unit): DescribeEventCategoriesResponse

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

describeEvents

inline suspend fun NeptuneClient.describeEvents(crossinline block: DescribeEventsRequest.Builder.() -> Unit): DescribeEventsResponse

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.

describeEventSubscriptions

inline suspend fun NeptuneClient.describeEventSubscriptions(crossinline block: DescribeEventSubscriptionsRequest.Builder.() -> Unit): DescribeEventSubscriptionsResponse

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

describeGlobalClusters

inline suspend fun NeptuneClient.describeGlobalClusters(crossinline block: DescribeGlobalClustersRequest.Builder.() -> Unit): DescribeGlobalClustersResponse

Returns information about Neptune global database clusters. This API supports pagination.

describeOrderableDbInstanceOptions

inline suspend fun NeptuneClient.describeOrderableDbInstanceOptions(crossinline block: DescribeOrderableDbInstanceOptionsRequest.Builder.() -> Unit): DescribeOrderableDbInstanceOptionsResponse

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

describePendingMaintenanceActions

inline suspend fun NeptuneClient.describePendingMaintenanceActions(crossinline block: DescribePendingMaintenanceActionsRequest.Builder.() -> Unit): DescribePendingMaintenanceActionsResponse

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

describeValidDbInstanceModifications

inline suspend fun NeptuneClient.describeValidDbInstanceModifications(crossinline block: DescribeValidDbInstanceModificationsRequest.Builder.() -> Unit): DescribeValidDbInstanceModificationsResponse

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.

failoverDbCluster

inline suspend fun NeptuneClient.failoverDbCluster(crossinline block: FailoverDbClusterRequest.Builder.() -> Unit): FailoverDbClusterResponse

Forces a failover for a DB cluster.

failoverGlobalCluster

inline suspend fun NeptuneClient.failoverGlobalCluster(crossinline block: FailoverGlobalClusterRequest.Builder.() -> Unit): FailoverGlobalClusterResponse

Initiates the failover process for a Neptune global database.

listTagsForResource

inline suspend fun NeptuneClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists all tags on an Amazon Neptune resource.

modifyDbCluster

inline suspend fun NeptuneClient.modifyDbCluster(crossinline block: ModifyDbClusterRequest.Builder.() -> Unit): ModifyDbClusterResponse

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.

modifyDbClusterEndpoint

inline suspend fun NeptuneClient.modifyDbClusterEndpoint(crossinline block: ModifyDbClusterEndpointRequest.Builder.() -> Unit): ModifyDbClusterEndpointResponse

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

modifyDbClusterParameterGroup

inline suspend fun NeptuneClient.modifyDbClusterParameterGroup(crossinline block: ModifyDbClusterParameterGroupRequest.Builder.() -> Unit): ModifyDbClusterParameterGroupResponse

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

modifyDbClusterSnapshotAttribute

inline suspend fun NeptuneClient.modifyDbClusterSnapshotAttribute(crossinline block: ModifyDbClusterSnapshotAttributeRequest.Builder.() -> Unit): ModifyDbClusterSnapshotAttributeResponse

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

modifyDbInstance

inline suspend fun NeptuneClient.modifyDbInstance(crossinline block: ModifyDbInstanceRequest.Builder.() -> Unit): ModifyDbInstanceResponse

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.

modifyDbParameterGroup

inline suspend fun NeptuneClient.modifyDbParameterGroup(crossinline block: ModifyDbParameterGroupRequest.Builder.() -> Unit): ModifyDbParameterGroupResponse

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

modifyDbSubnetGroup

inline suspend fun NeptuneClient.modifyDbSubnetGroup(crossinline block: ModifyDbSubnetGroupRequest.Builder.() -> Unit): ModifyDbSubnetGroupResponse

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.

modifyEventSubscription

inline suspend fun NeptuneClient.modifyEventSubscription(crossinline block: ModifyEventSubscriptionRequest.Builder.() -> Unit): ModifyEventSubscriptionResponse

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.

modifyGlobalCluster

inline suspend fun NeptuneClient.modifyGlobalCluster(crossinline block: ModifyGlobalClusterRequest.Builder.() -> Unit): ModifyGlobalClusterResponse

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.

promoteReadReplicaDbCluster

inline suspend fun NeptuneClient.promoteReadReplicaDbCluster(crossinline block: PromoteReadReplicaDbClusterRequest.Builder.() -> Unit): PromoteReadReplicaDbClusterResponse

Not supported.

rebootDbInstance

inline suspend fun NeptuneClient.rebootDbInstance(crossinline block: RebootDbInstanceRequest.Builder.() -> Unit): RebootDbInstanceResponse

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.

removeFromGlobalCluster

inline suspend fun NeptuneClient.removeFromGlobalCluster(crossinline block: RemoveFromGlobalClusterRequest.Builder.() -> Unit): RemoveFromGlobalClusterResponse

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.

removeRoleFromDbCluster

inline suspend fun NeptuneClient.removeRoleFromDbCluster(crossinline block: RemoveRoleFromDbClusterRequest.Builder.() -> Unit): RemoveRoleFromDbClusterResponse

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

removeSourceIdentifierFromSubscription

inline suspend fun NeptuneClient.removeSourceIdentifierFromSubscription(crossinline block: RemoveSourceIdentifierFromSubscriptionRequest.Builder.() -> Unit): RemoveSourceIdentifierFromSubscriptionResponse

Removes a source identifier from an existing event notification subscription.

removeTagsFromResource

inline suspend fun NeptuneClient.removeTagsFromResource(crossinline block: RemoveTagsFromResourceRequest.Builder.() -> Unit): RemoveTagsFromResourceResponse

Removes metadata tags from an Amazon Neptune resource.

resetDbClusterParameterGroup

inline suspend fun NeptuneClient.resetDbClusterParameterGroup(crossinline block: ResetDbClusterParameterGroupRequest.Builder.() -> Unit): ResetDbClusterParameterGroupResponse

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

resetDbParameterGroup

inline suspend fun NeptuneClient.resetDbParameterGroup(crossinline block: ResetDbParameterGroupRequest.Builder.() -> Unit): ResetDbParameterGroupResponse

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

restoreDbClusterFromSnapshot

inline suspend fun NeptuneClient.restoreDbClusterFromSnapshot(crossinline block: RestoreDbClusterFromSnapshotRequest.Builder.() -> Unit): RestoreDbClusterFromSnapshotResponse

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

restoreDbClusterToPointInTime

inline suspend fun NeptuneClient.restoreDbClusterToPointInTime(crossinline block: RestoreDbClusterToPointInTimeRequest.Builder.() -> Unit): RestoreDbClusterToPointInTimeResponse

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

startDbCluster

inline suspend fun NeptuneClient.startDbCluster(crossinline block: StartDbClusterRequest.Builder.() -> Unit): StartDbClusterResponse

Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.

stopDbCluster

inline suspend fun NeptuneClient.stopDbCluster(crossinline block: StopDbClusterRequest.Builder.() -> Unit): StopDbClusterResponse

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.

withConfig

fun NeptuneClient.withConfig(block: NeptuneClient.Config.Builder.() -> Unit): NeptuneClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.