neptunegraph/aws.sdk.kotlin.services.neptunegraph

Package-level declarations

Types

interface NeptuneGraphClient : SdkClient

Neptune Analytics is a new analytics database engine for Amazon Neptune that helps customers get to insights faster by quickly processing large amounts of graph data, invoking popular graph analytic algorithms in low-latency queries, and getting analytics results in seconds.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

cancelExportTask

inline suspend fun NeptuneGraphClient.cancelExportTask(crossinline block: CancelExportTaskRequest.Builder.() -> Unit): CancelExportTaskResponse

Cancel the specified export task.

cancelImportTask

inline suspend fun NeptuneGraphClient.cancelImportTask(crossinline block: CancelImportTaskRequest.Builder.() -> Unit): CancelImportTaskResponse

Deletes the specified import task.

cancelQuery

inline suspend fun NeptuneGraphClient.cancelQuery(crossinline block: CancelQueryRequest.Builder.() -> Unit): CancelQueryResponse

Cancels a specified query.

createGraph

inline suspend fun NeptuneGraphClient.createGraph(crossinline block: CreateGraphRequest.Builder.() -> Unit): CreateGraphResponse

Creates a new Neptune Analytics graph.

createGraphSnapshot

inline suspend fun NeptuneGraphClient.createGraphSnapshot(crossinline block: CreateGraphSnapshotRequest.Builder.() -> Unit): CreateGraphSnapshotResponse

Creates a snapshot of the specific graph.

createGraphUsingImportTask

inline suspend fun NeptuneGraphClient.createGraphUsingImportTask(crossinline block: CreateGraphUsingImportTaskRequest.Builder.() -> Unit): CreateGraphUsingImportTaskResponse

Creates a new Neptune Analytics graph and imports data into it, either from Amazon Simple Storage Service (S3) or from a Neptune database or a Neptune database snapshot.

createPrivateGraphEndpoint

inline suspend fun NeptuneGraphClient.createPrivateGraphEndpoint(crossinline block: CreatePrivateGraphEndpointRequest.Builder.() -> Unit): CreatePrivateGraphEndpointResponse

Create a private graph endpoint to allow private access from to the graph from within a VPC. You can attach security groups to the private graph endpoint.

deleteGraph

inline suspend fun NeptuneGraphClient.deleteGraph(crossinline block: DeleteGraphRequest.Builder.() -> Unit): DeleteGraphResponse

Deletes the specified graph. Graphs cannot be deleted if delete-protection is enabled.

deleteGraphSnapshot

inline suspend fun NeptuneGraphClient.deleteGraphSnapshot(crossinline block: DeleteGraphSnapshotRequest.Builder.() -> Unit): DeleteGraphSnapshotResponse

Deletes the specifed graph snapshot.

deletePrivateGraphEndpoint

inline suspend fun NeptuneGraphClient.deletePrivateGraphEndpoint(crossinline block: DeletePrivateGraphEndpointRequest.Builder.() -> Unit): DeletePrivateGraphEndpointResponse

Deletes a private graph endpoint.

getExportTask

inline suspend fun NeptuneGraphClient.getExportTask(crossinline block: GetExportTaskRequest.Builder.() -> Unit): GetExportTaskResponse

Retrieves a specified export task.

getGraph

inline suspend fun NeptuneGraphClient.getGraph(crossinline block: GetGraphRequest.Builder.() -> Unit): GetGraphResponse

Gets information about a specified graph.

getGraphSnapshot

inline suspend fun NeptuneGraphClient.getGraphSnapshot(crossinline block: GetGraphSnapshotRequest.Builder.() -> Unit): GetGraphSnapshotResponse

Retrieves a specified graph snapshot.

getGraphSummary

inline suspend fun NeptuneGraphClient.getGraphSummary(crossinline block: GetGraphSummaryRequest.Builder.() -> Unit): GetGraphSummaryResponse

Gets a graph summary for a property graph.

getImportTask

inline suspend fun NeptuneGraphClient.getImportTask(crossinline block: GetImportTaskRequest.Builder.() -> Unit): GetImportTaskResponse

Retrieves a specified import task.

getPrivateGraphEndpoint

inline suspend fun NeptuneGraphClient.getPrivateGraphEndpoint(crossinline block: GetPrivateGraphEndpointRequest.Builder.() -> Unit): GetPrivateGraphEndpointResponse

Retrieves information about a specified private endpoint.

getQuery

inline suspend fun NeptuneGraphClient.getQuery(crossinline block: GetQueryRequest.Builder.() -> Unit): GetQueryResponse

Retrieves the status of a specified query.

listExportTasks

inline suspend fun NeptuneGraphClient.listExportTasks(crossinline block: ListExportTasksRequest.Builder.() -> Unit): ListExportTasksResponse

Retrieves a list of export tasks.

listGraphs

inline suspend fun NeptuneGraphClient.listGraphs(crossinline block: ListGraphsRequest.Builder.() -> Unit): ListGraphsResponse

Lists available Neptune Analytics graphs.

listGraphSnapshots

inline suspend fun NeptuneGraphClient.listGraphSnapshots(crossinline block: ListGraphSnapshotsRequest.Builder.() -> Unit): ListGraphSnapshotsResponse

Lists available snapshots of a specified Neptune Analytics graph.

listImportTasks

inline suspend fun NeptuneGraphClient.listImportTasks(crossinline block: ListImportTasksRequest.Builder.() -> Unit): ListImportTasksResponse

Lists import tasks.

listPrivateGraphEndpoints

inline suspend fun NeptuneGraphClient.listPrivateGraphEndpoints(crossinline block: ListPrivateGraphEndpointsRequest.Builder.() -> Unit): ListPrivateGraphEndpointsResponse

Lists private endpoints for a specified Neptune Analytics graph.

listQueries

inline suspend fun NeptuneGraphClient.listQueries(crossinline block: ListQueriesRequest.Builder.() -> Unit): ListQueriesResponse

Lists active openCypher queries.

listTagsForResource

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

Lists tags associated with a specified resource.

resetGraph

inline suspend fun NeptuneGraphClient.resetGraph(crossinline block: ResetGraphRequest.Builder.() -> Unit): ResetGraphResponse

Empties the data from a specified Neptune Analytics graph.

restoreGraphFromSnapshot

inline suspend fun NeptuneGraphClient.restoreGraphFromSnapshot(crossinline block: RestoreGraphFromSnapshotRequest.Builder.() -> Unit): RestoreGraphFromSnapshotResponse

Restores a graph from a snapshot.

startExportTask

inline suspend fun NeptuneGraphClient.startExportTask(crossinline block: StartExportTaskRequest.Builder.() -> Unit): StartExportTaskResponse

Export data from an existing Neptune Analytics graph to Amazon S3. The graph state should be AVAILABLE.

startImportTask

inline suspend fun NeptuneGraphClient.startImportTask(crossinline block: StartImportTaskRequest.Builder.() -> Unit): StartImportTaskResponse

Import data into existing Neptune Analytics graph from Amazon Simple Storage Service (S3). The graph needs to be empty and in the AVAILABLE state.

tagResource

inline suspend fun NeptuneGraphClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds tags to the specified resource.

untagResource

inline suspend fun NeptuneGraphClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the specified tags from the specified resource.

updateGraph

inline suspend fun NeptuneGraphClient.updateGraph(crossinline block: UpdateGraphRequest.Builder.() -> Unit): UpdateGraphResponse

Updates the configuration of a specified Neptune Analytics graph

withConfig

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

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.