- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
NeptuneGraphClient
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.
Installation
npm install @aws-sdk/client-neptune-graphyarn add @aws-sdk/client-neptune-graphpnpm add @aws-sdk/client-neptune-graphNeptuneGraphClient Operations
Command | Summary |
|---|
Command | Summary |
|---|---|
| CancelExportTaskCommand | Cancel the specified export task. |
| CancelImportTaskCommand | Deletes the specified import task. |
| CancelQueryCommand | Cancels a specified query. |
| CreateGraphCommand | Creates a new Neptune Analytics graph. |
| CreateGraphSnapshotCommand | Creates a snapshot of the specific graph. |
| CreateGraphUsingImportTaskCommand | 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. The data can be loaded from files in S3 that in either the Gremlin CSV format or the openCypher load format . |
| CreatePrivateGraphEndpointCommand | 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. VPC endpoint charges apply. |
| DeleteGraphCommand | Deletes the specified graph. Graphs cannot be deleted if delete-protection is enabled. |
| DeleteGraphSnapshotCommand | Deletes the specifed graph snapshot. |
| DeletePrivateGraphEndpointCommand | Deletes a private graph endpoint. |
| ExecuteQueryCommand | Execute an openCypher query. When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached that allows one of the following IAM actions in that cluster, depending on the query:
|
| GetExportTaskCommand | Retrieves a specified export task. |
| GetGraphCommand | Gets information about a specified graph. |
| GetGraphSnapshotCommand | Retrieves a specified graph snapshot. |
| GetGraphSummaryCommand | Gets a graph summary for a property graph. |
| GetImportTaskCommand | Retrieves a specified import task. |
| GetPrivateGraphEndpointCommand | Retrieves information about a specified private endpoint. |
| GetQueryCommand | Retrieves the status of a specified query. When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the |
| ListExportTasksCommand | Retrieves a list of export tasks. |
| ListGraphSnapshotsCommand | Lists available snapshots of a specified Neptune Analytics graph. |
| ListGraphsCommand | Lists available Neptune Analytics graphs. |
| ListImportTasksCommand | Lists import tasks. |
| ListPrivateGraphEndpointsCommand | Lists private endpoints for a specified Neptune Analytics graph. |
| ListQueriesCommand | Lists active openCypher queries. |
| ListTagsForResourceCommand | Lists tags associated with a specified resource. |
| ResetGraphCommand | Empties the data from a specified Neptune Analytics graph. |
| RestoreGraphFromSnapshotCommand | Restores a graph from a snapshot. |
| StartExportTaskCommand | Export data from an existing Neptune Analytics graph to Amazon S3. The graph state should be |
| StartImportTaskCommand | Import data into existing Neptune Analytics graph from Amazon Simple Storage Service (S3). The graph needs to be empty and in the AVAILABLE state. |
| TagResourceCommand | Adds tags to the specified resource. |
| UntagResourceCommand | Removes the specified tags from the specified resource. |
| UpdateGraphCommand | Updates the configuration of a specified Neptune Analytics graph |
NeptuneGraphClient Configuration
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
defaultsModeOptional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefixOptional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensionsOptional | RuntimeExtension[] | Optional extensions |
loggerOptional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttemptsOptional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profileOptional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
regionOptional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandlerOptional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryModeOptional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpointOptional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpointOptional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: NeptuneGraphClientConfig