neptunegraph/aws.sdk.kotlin.services.neptunegraph/NeptuneGraphClient

NeptuneGraphClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<NeptuneGraphClient.Config, NeptuneGraphClient.Config.Builder, NeptuneGraphClient>

Companion

object Companion : AbstractAwsSdkClientFactory<NeptuneGraphClient.Config, NeptuneGraphClient.Config.Builder, NeptuneGraphClient, NeptuneGraphClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: NeptuneGraphClient.Config

NeptuneGraphClient's configuration

Functions

cancelExportTask

abstract suspend fun cancelExportTask(input: CancelExportTaskRequest): CancelExportTaskResponse

Cancel the specified export task.

cancelImportTask

abstract suspend fun cancelImportTask(input: CancelImportTaskRequest): CancelImportTaskResponse

Deletes the specified import task.

cancelQuery

abstract suspend fun cancelQuery(input: CancelQueryRequest): CancelQueryResponse

Cancels a specified query.

createGraph

abstract suspend fun createGraph(input: CreateGraphRequest): CreateGraphResponse

Creates a new Neptune Analytics graph.

createGraphSnapshot

abstract suspend fun createGraphSnapshot(input: CreateGraphSnapshotRequest): CreateGraphSnapshotResponse

Creates a snapshot of the specific graph.

createGraphUsingImportTask

abstract suspend fun createGraphUsingImportTask(input: CreateGraphUsingImportTaskRequest): 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

abstract suspend fun createPrivateGraphEndpoint(input: CreatePrivateGraphEndpointRequest): 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

abstract suspend fun deleteGraph(input: DeleteGraphRequest): DeleteGraphResponse

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

deleteGraphSnapshot

abstract suspend fun deleteGraphSnapshot(input: DeleteGraphSnapshotRequest): DeleteGraphSnapshotResponse

Deletes the specifed graph snapshot.

deletePrivateGraphEndpoint

abstract suspend fun deletePrivateGraphEndpoint(input: DeletePrivateGraphEndpointRequest): DeletePrivateGraphEndpointResponse

Deletes a private graph endpoint.

executeQuery

abstract suspend fun <T> executeQuery(input: ExecuteQueryRequest, block: suspend (ExecuteQueryResponse) -> T): T

Execute an openCypher query.

getExportTask

abstract suspend fun getExportTask(input: GetExportTaskRequest): GetExportTaskResponse

Retrieves a specified export task.

getGraph

abstract suspend fun getGraph(input: GetGraphRequest): GetGraphResponse

Gets information about a specified graph.

getGraphSnapshot

abstract suspend fun getGraphSnapshot(input: GetGraphSnapshotRequest): GetGraphSnapshotResponse

Retrieves a specified graph snapshot.

getGraphSummary

abstract suspend fun getGraphSummary(input: GetGraphSummaryRequest): GetGraphSummaryResponse

Gets a graph summary for a property graph.

getImportTask

abstract suspend fun getImportTask(input: GetImportTaskRequest): GetImportTaskResponse

Retrieves a specified import task.

getPrivateGraphEndpoint

abstract suspend fun getPrivateGraphEndpoint(input: GetPrivateGraphEndpointRequest): GetPrivateGraphEndpointResponse

Retrieves information about a specified private endpoint.

getQuery

abstract suspend fun getQuery(input: GetQueryRequest): GetQueryResponse

Retrieves the status of a specified query.

listExportTasks

abstract suspend fun listExportTasks(input: ListExportTasksRequest = ListExportTasksRequest { }): ListExportTasksResponse

Retrieves a list of export tasks.

listGraphs

abstract suspend fun listGraphs(input: ListGraphsRequest = ListGraphsRequest { }): ListGraphsResponse

Lists available Neptune Analytics graphs.

listGraphSnapshots

abstract suspend fun listGraphSnapshots(input: ListGraphSnapshotsRequest = ListGraphSnapshotsRequest { }): ListGraphSnapshotsResponse

Lists available snapshots of a specified Neptune Analytics graph.

listImportTasks

abstract suspend fun listImportTasks(input: ListImportTasksRequest = ListImportTasksRequest { }): ListImportTasksResponse

Lists import tasks.

listPrivateGraphEndpoints

abstract suspend fun listPrivateGraphEndpoints(input: ListPrivateGraphEndpointsRequest): ListPrivateGraphEndpointsResponse

Lists private endpoints for a specified Neptune Analytics graph.

listQueries

abstract suspend fun listQueries(input: ListQueriesRequest): ListQueriesResponse

Lists active openCypher queries.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists tags associated with a specified resource.

resetGraph

abstract suspend fun resetGraph(input: ResetGraphRequest): ResetGraphResponse

Empties the data from a specified Neptune Analytics graph.

restoreGraphFromSnapshot

abstract suspend fun restoreGraphFromSnapshot(input: RestoreGraphFromSnapshotRequest): RestoreGraphFromSnapshotResponse

Restores a graph from a snapshot.

startExportTask

abstract suspend fun startExportTask(input: StartExportTaskRequest): StartExportTaskResponse

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

startImportTask

abstract suspend fun startImportTask(input: StartImportTaskRequest): 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

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds tags to the specified resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes the specified tags from the specified resource.

updateGraph

abstract suspend fun updateGraph(input: UpdateGraphRequest): UpdateGraphResponse

Updates the configuration of a specified Neptune Analytics graph

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.

expect abstract fun close()

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.

listExportTasksPaginated

fun NeptuneGraphClient.listExportTasksPaginated(initialRequest: ListExportTasksRequest = ListExportTasksRequest { }): Flow<ListExportTasksResponse>

fun NeptuneGraphClient.listExportTasksPaginated(block: ListExportTasksRequest.Builder.() -> Unit): Flow<ListExportTasksResponse>

Paginate over ListExportTasksResponse results.

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.

listGraphSnapshotsPaginated

fun NeptuneGraphClient.listGraphSnapshotsPaginated(initialRequest: ListGraphSnapshotsRequest = ListGraphSnapshotsRequest { }): Flow<ListGraphSnapshotsResponse>

fun NeptuneGraphClient.listGraphSnapshotsPaginated(block: ListGraphSnapshotsRequest.Builder.() -> Unit): Flow<ListGraphSnapshotsResponse>

Paginate over ListGraphSnapshotsResponse results.

listGraphsPaginated

fun NeptuneGraphClient.listGraphsPaginated(initialRequest: ListGraphsRequest = ListGraphsRequest { }): Flow<ListGraphsResponse>

fun NeptuneGraphClient.listGraphsPaginated(block: ListGraphsRequest.Builder.() -> Unit): Flow<ListGraphsResponse>

Paginate over ListGraphsResponse results.

listImportTasks

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

Lists import tasks.

listImportTasksPaginated

fun NeptuneGraphClient.listImportTasksPaginated(initialRequest: ListImportTasksRequest = ListImportTasksRequest { }): Flow<ListImportTasksResponse>

fun NeptuneGraphClient.listImportTasksPaginated(block: ListImportTasksRequest.Builder.() -> Unit): Flow<ListImportTasksResponse>

Paginate over ListImportTasksResponse results.

listPrivateGraphEndpoints

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

Lists private endpoints for a specified Neptune Analytics graph.

listPrivateGraphEndpointsPaginated

fun NeptuneGraphClient.listPrivateGraphEndpointsPaginated(initialRequest: ListPrivateGraphEndpointsRequest): Flow<ListPrivateGraphEndpointsResponse>

fun NeptuneGraphClient.listPrivateGraphEndpointsPaginated(block: ListPrivateGraphEndpointsRequest.Builder.() -> Unit): Flow<ListPrivateGraphEndpointsResponse>

Paginate over ListPrivateGraphEndpointsResponse results.

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

waitUntilExportTaskCancelled

suspend fun NeptuneGraphClient.waitUntilExportTaskCancelled(block: GetExportTaskRequest.Builder.() -> Unit): Outcome<GetExportTaskResponse>

suspend fun NeptuneGraphClient.waitUntilExportTaskCancelled(request: GetExportTaskRequest, retryStrategy: RetryStrategy? = null): Outcome<GetExportTaskResponse>

Wait until Export Task is Cancelled

waitUntilExportTaskSuccessful

suspend fun NeptuneGraphClient.waitUntilExportTaskSuccessful(block: GetExportTaskRequest.Builder.() -> Unit): Outcome<GetExportTaskResponse>

suspend fun NeptuneGraphClient.waitUntilExportTaskSuccessful(request: GetExportTaskRequest, retryStrategy: RetryStrategy? = null): Outcome<GetExportTaskResponse>

Wait until Export Task is Successful

waitUntilGraphAvailable

suspend fun NeptuneGraphClient.waitUntilGraphAvailable(block: GetGraphRequest.Builder.() -> Unit): Outcome<GetGraphResponse>

suspend fun NeptuneGraphClient.waitUntilGraphAvailable(request: GetGraphRequest, retryStrategy: RetryStrategy? = null): Outcome<GetGraphResponse>

Wait until Graph is Available

waitUntilGraphDeleted

suspend fun NeptuneGraphClient.waitUntilGraphDeleted(block: GetGraphRequest.Builder.() -> Unit): Outcome<GetGraphResponse>

suspend fun NeptuneGraphClient.waitUntilGraphDeleted(request: GetGraphRequest, retryStrategy: RetryStrategy? = null): Outcome<GetGraphResponse>

Wait until Graph is Deleted

waitUntilGraphSnapshotAvailable

suspend fun NeptuneGraphClient.waitUntilGraphSnapshotAvailable(block: GetGraphSnapshotRequest.Builder.() -> Unit): Outcome<GetGraphSnapshotResponse>

suspend fun NeptuneGraphClient.waitUntilGraphSnapshotAvailable(request: GetGraphSnapshotRequest, retryStrategy: RetryStrategy? = null): Outcome<GetGraphSnapshotResponse>

Wait until GraphSnapshot is Available

waitUntilGraphSnapshotDeleted

suspend fun NeptuneGraphClient.waitUntilGraphSnapshotDeleted(block: GetGraphSnapshotRequest.Builder.() -> Unit): Outcome<GetGraphSnapshotResponse>

suspend fun NeptuneGraphClient.waitUntilGraphSnapshotDeleted(request: GetGraphSnapshotRequest, retryStrategy: RetryStrategy? = null): Outcome<GetGraphSnapshotResponse>

Wait until GraphSnapshot is Deleted

waitUntilImportTaskCancelled

suspend fun NeptuneGraphClient.waitUntilImportTaskCancelled(block: GetImportTaskRequest.Builder.() -> Unit): Outcome<GetImportTaskResponse>

suspend fun NeptuneGraphClient.waitUntilImportTaskCancelled(request: GetImportTaskRequest, retryStrategy: RetryStrategy? = null): Outcome<GetImportTaskResponse>

Wait until Import Task is Cancelled

waitUntilImportTaskSuccessful

suspend fun NeptuneGraphClient.waitUntilImportTaskSuccessful(block: GetImportTaskRequest.Builder.() -> Unit): Outcome<GetImportTaskResponse>

suspend fun NeptuneGraphClient.waitUntilImportTaskSuccessful(request: GetImportTaskRequest, retryStrategy: RetryStrategy? = null): Outcome<GetImportTaskResponse>

Wait until Import Task is Successful

waitUntilPrivateGraphEndpointAvailable

suspend fun NeptuneGraphClient.waitUntilPrivateGraphEndpointAvailable(block: GetPrivateGraphEndpointRequest.Builder.() -> Unit): Outcome<GetPrivateGraphEndpointResponse>

suspend fun NeptuneGraphClient.waitUntilPrivateGraphEndpointAvailable(request: GetPrivateGraphEndpointRequest, retryStrategy: RetryStrategy? = null): Outcome<GetPrivateGraphEndpointResponse>

Wait until PrivateGraphEndpoint is Available

waitUntilPrivateGraphEndpointDeleted

suspend fun NeptuneGraphClient.waitUntilPrivateGraphEndpointDeleted(block: GetPrivateGraphEndpointRequest.Builder.() -> Unit): Outcome<GetPrivateGraphEndpointResponse>

suspend fun NeptuneGraphClient.waitUntilPrivateGraphEndpointDeleted(request: GetPrivateGraphEndpointRequest, retryStrategy: RetryStrategy? = null): Outcome<GetPrivateGraphEndpointResponse>

Wait until PrivateGraphEndpoint is Deleted

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.