2023/12/14 - Amazon Neptune Graph - 22 new api methods
Changes Exclude Neptune Graph
Empties the data from a specified Neptune Analytics graph.
See also: AWS API Documentation
Request Syntax
client.reset_graph(
graphIdentifier='string',
skipSnapshot=True|False
)
string
[REQUIRED]
ID of the graph to reset.
boolean
[REQUIRED]
Determines whether a final graph snapshot is created before the graph data is deleted. If set to true , no graph snapshot is created. If set to false , a graph snapshot is created before the data is deleted.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'RESETTING'|'UPDATING'|'SNAPSHOTTING'|'FAILED',
'statusReason': 'string',
'createTime': datetime(2015, 1, 1),
'provisionedMemory': 123,
'endpoint': 'string',
'publicConnectivity': True|False,
'vectorSearchConfiguration': {
'dimension': 123
},
'replicaCount': 123,
'kmsKeyIdentifier': 'string',
'sourceSnapshotId': 'string',
'deletionProtection': True|False,
'buildNumber': 'string'
}
Response Structure
(dict) --
id (string) --
The unique identifier of the graph.
name (string) --
The name of the graph.
arn (string) --
The ARN associated with the graph.
status (string) --
The status of the graph.
statusReason (string) --
The reason that the graph has this status.
createTime (datetime) --
The time at which the graph was created.
provisionedMemory (integer) --
The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.
endpoint (string) --
The graph endpoint.
publicConnectivity (boolean) --
If true , the graph has a public endpoint, otherwise not.
vectorSearchConfiguration (dict) --
Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535
dimension (integer) --
The number of dimensions.
replicaCount (integer) --
The number of replicas for the graph.
kmsKeyIdentifier (string) --
The ID of the KMS key used to encrypt and decrypt graph data.
sourceSnapshotId (string) --
The ID of the snapshot from which the graph was created, if any.
deletionProtection (boolean) --
If true , deletion protection is enabled for the graph.
buildNumber (string) --
The build number of the graph.
Deletes the specifed graph snapshot.
See also: AWS API Documentation
Request Syntax
client.delete_graph_snapshot(
snapshotIdentifier='string'
)
string
[REQUIRED]
ID of the graph snapshot to be deleted.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'sourceGraphId': 'string',
'snapshotCreateTime': datetime(2015, 1, 1),
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'FAILED',
'kmsKeyIdentifier': 'string'
}
Response Structure
(dict) --
id (string) --
The unique identifier of the graph snapshot.
name (string) --
The snapshot name. For example: my-snapshot-1 .
The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.
arn (string) --
The ARN of the graph snapshot.
sourceGraphId (string) --
The graph identifier for the graph from which the snapshot was created.
snapshotCreateTime (datetime) --
The time when the snapshot was created.
status (string) --
The status of the graph snapshot.
kmsKeyIdentifier (string) --
The ID of the KMS key used to encrypt and decrypt the snapshot.
Retrieves information about a specified private endpoint.
See also: AWS API Documentation
Request Syntax
client.get_private_graph_endpoint(
graphIdentifier='string',
vpcId='string'
)
string
[REQUIRED]
The unique identifier of the Neptune Analytics graph.
string
[REQUIRED]
The ID of the VPC where the private endpoint is located.
dict
Response Syntax
{
'vpcId': 'string',
'subnetIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'FAILED',
'vpcEndpointId': 'string'
}
Response Structure
(dict) --
vpcId (string) --
The ID of the VPC where the private endpoint is located.
subnetIds (list) --
The subnet IDs involved.
(string) --
status (string) --
The current status of the private endpoint.
vpcEndpointId (string) --
The ID of the private endpoint.
Restores a graph from a snapshot.
See also: AWS API Documentation
Request Syntax
client.restore_graph_from_snapshot(
snapshotIdentifier='string',
graphName='string',
provisionedMemory=123,
deletionProtection=True|False,
tags={
'string': 'string'
},
replicaCount=123,
publicConnectivity=True|False
)
string
[REQUIRED]
The ID of the snapshot in question.
string
[REQUIRED]
A name for the new Neptune Analytics graph to be created from the snapshot.
The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.
integer
The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128
boolean
A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
dict
Adds metadata tags to the snapshot. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.
(string) --
(string) --
integer
The number of replicas in other AZs. Min =0, Max = 2, Default =1
boolean
Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated. ( true to enable, or false to disable).
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'RESETTING'|'UPDATING'|'SNAPSHOTTING'|'FAILED',
'statusReason': 'string',
'createTime': datetime(2015, 1, 1),
'provisionedMemory': 123,
'endpoint': 'string',
'publicConnectivity': True|False,
'vectorSearchConfiguration': {
'dimension': 123
},
'replicaCount': 123,
'kmsKeyIdentifier': 'string',
'sourceSnapshotId': 'string',
'deletionProtection': True|False,
'buildNumber': 'string'
}
Response Structure
(dict) --
id (string) --
The unique identifier of the graph.
name (string) --
The name of the graph.
arn (string) --
The ARN associated with the graph.
status (string) --
The status of the graph.
statusReason (string) --
The reason that the graph has this status.
createTime (datetime) --
The time at which the graph was created.
provisionedMemory (integer) --
The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.
endpoint (string) --
The graph endpoint.
publicConnectivity (boolean) --
If true , the graph has a public endpoint, otherwise not.
vectorSearchConfiguration (dict) --
Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535
dimension (integer) --
The number of dimensions.
replicaCount (integer) --
The number of replicas for the graph.
kmsKeyIdentifier (string) --
The ID of the KMS key used to encrypt and decrypt graph data.
sourceSnapshotId (string) --
The ID of the snapshot from which the graph was created, if any.
deletionProtection (boolean) --
If true , deletion protection is enabled for the graph.
buildNumber (string) --
The build number of the graph.
Lists available Neptune Analytics graphs.
See also: AWS API Documentation
Request Syntax
client.list_graphs(
nextToken='string',
maxResults=123
)
string
Pagination token used to paginate output.
When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.
integer
The total number of records to return in the command's output.
If the total number of records available is more than the value specified, nextToken is provided in the command's output. To resume pagination, provide the nextToken output value in the nextToken argument of a subsequent command. Do not use the nextToken response element directly outside of the Amazon CLI.
dict
Response Syntax
{
'graphs': [
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'RESETTING'|'UPDATING'|'SNAPSHOTTING'|'FAILED',
'provisionedMemory': 123,
'publicConnectivity': True|False,
'endpoint': 'string',
'replicaCount': 123,
'kmsKeyIdentifier': 'string',
'deletionProtection': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
graphs (list) --
A list of the graphs.
(dict) --
Summary details about a graph.
id (string) --
The unique identifier of the graph.
name (string) --
The name of the graph.
arn (string) --
The ARN associated with the graph.
status (string) --
The status of the graph.
provisionedMemory (integer) --
The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.
publicConnectivity (boolean) --
If true , the graph has a public endpoint, otherwise not.
endpoint (string) --
The graph endpoint.
replicaCount (integer) --
The number of replicas for the graph.
kmsKeyIdentifier (string) --
The ID of the KMS key used to encrypt and decrypt graph data.
deletionProtection (boolean) --
If true , deletion protection is enabled for the graph.
nextToken (string) --
Pagination token used to paginate output.
When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.
Deletes the specified graph. Graphs cannot be deleted if delete-protection is enabled.
See also: AWS API Documentation
Request Syntax
client.delete_graph(
graphIdentifier='string',
skipSnapshot=True|False
)
string
[REQUIRED]
The unique identifier of the Neptune Analytics graph.
boolean
[REQUIRED]
Determines whether a final graph snapshot is created before the graph is deleted. If true is specified, no graph snapshot is created. If false is specified, a graph snapshot is created before the graph is deleted.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'RESETTING'|'UPDATING'|'SNAPSHOTTING'|'FAILED',
'statusReason': 'string',
'createTime': datetime(2015, 1, 1),
'provisionedMemory': 123,
'endpoint': 'string',
'publicConnectivity': True|False,
'vectorSearchConfiguration': {
'dimension': 123
},
'replicaCount': 123,
'kmsKeyIdentifier': 'string',
'sourceSnapshotId': 'string',
'deletionProtection': True|False,
'buildNumber': 'string'
}
Response Structure
(dict) --
id (string) --
The unique identifier of the graph.
name (string) --
The name of the graph.
arn (string) --
The ARN associated with the graph.
status (string) --
The status of the graph.
statusReason (string) --
The reason for the status of the graph.
createTime (datetime) --
The time at which the graph was created.
provisionedMemory (integer) --
The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.
endpoint (string) --
The graph endpoint.
publicConnectivity (boolean) --
If true , the graph has a public endpoint, otherwise not.
vectorSearchConfiguration (dict) --
Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535
dimension (integer) --
The number of dimensions.
replicaCount (integer) --
The number of replicas for the graph.
kmsKeyIdentifier (string) --
The ID of the KMS key used to encrypt and decrypt graph data.
sourceSnapshotId (string) --
The ID of the snapshot from which the graph was created, if the graph was recovered from a snapshot.
deletionProtection (boolean) --
If true , deletion protection was enabled for the graph.
buildNumber (string) --
The build number associated with the graph.
Removes the specified tags from the specified resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
ARN of the resource whose tag needs to be removed.
list
[REQUIRED]
Tag keys for the tags to be removed.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a snapshot of the specific graph.
See also: AWS API Documentation
Request Syntax
client.create_graph_snapshot(
graphIdentifier='string',
snapshotName='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique identifier of the Neptune Analytics graph.
string
[REQUIRED]
The snapshot name. For example: my-snapshot-1 .
The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.
dict
Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.
(string) --
(string) --
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'sourceGraphId': 'string',
'snapshotCreateTime': datetime(2015, 1, 1),
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'FAILED',
'kmsKeyIdentifier': 'string'
}
Response Structure
(dict) --
id (string) --
The ID of the snapshot created.
name (string) --
The name of the snapshot created.
arn (string) --
The ARN of the snapshot created.
sourceGraphId (string) --
The Id of the Neptune Analytics graph from which the snapshot is created.
snapshotCreateTime (datetime) --
The snapshot creation time
status (string) --
The current state of the snapshot.
kmsKeyIdentifier (string) --
The ID of the KMS key used to encrypt and decrypt graph data.
Deletes the specified import task
See also: AWS API Documentation
Request Syntax
client.cancel_import_task(
taskIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the import task.
dict
Response Syntax
{
'graphId': 'string',
'taskId': 'string',
'source': 'string',
'format': 'CSV'|'OPEN_CYPHER',
'roleArn': 'string',
'status': 'INITIALIZING'|'EXPORTING'|'ANALYZING_DATA'|'IMPORTING'|'REPROVISIONING'|'ROLLING_BACK'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED'
}
Response Structure
(dict) --
graphId (string) --
The unique identifier of the Neptune Analytics graph.
taskId (string) --
The unique identifier of the import task.
source (string) --
A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot
format (string) --
Specifies the format of S3 data to be imported. Valid values are CSV , which identifies the Gremlin CSV format or OPENCYPHER , which identies the openCypher load format.
roleArn (string) --
The ARN of the IAM role that will allow access to the data that is to be imported.
status (string) --
Current status of the task. Status is CANCELLING when the import task is cancelled.
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.
See also: AWS API Documentation
Request Syntax
client.create_private_graph_endpoint(
graphIdentifier='string',
vpcId='string',
subnetIds=[
'string',
],
vpcSecurityGroupIds=[
'string',
]
)
string
[REQUIRED]
The unique identifier of the Neptune Analytics graph.
string
The VPC in which the private graph endpoint needs to be created.
list
Subnets in which private graph endpoint ENIs are created.
(string) --
list
Security groups to be attached to the private graph endpoint..
(string) --
dict
Response Syntax
{
'vpcId': 'string',
'subnetIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'FAILED',
'vpcEndpointId': 'string'
}
Response Structure
(dict) --
vpcId (string) --
VPC in which the private graph endpoint is created.
subnetIds (list) --
Subnets in which the private graph endpoint ENIs are created.
(string) --
status (string) --
Status of the private graph endpoint.
vpcEndpointId (string) --
Endpoint ID of the prviate grpah endpoint.
Lists import tasks.
See also: AWS API Documentation
Request Syntax
client.list_import_tasks(
nextToken='string',
maxResults=123
)
string
Pagination token used to paginate output.
When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.
integer
The total number of records to return in the command's output.
If the total number of records available is more than the value specified, nextToken is provided in the command's output. To resume pagination, provide the nextToken output value in the nextToken argument of a subsequent command. Do not use the nextToken response element directly outside of the Amazon CLI.
dict
Response Syntax
{
'tasks': [
{
'graphId': 'string',
'taskId': 'string',
'source': 'string',
'format': 'CSV'|'OPEN_CYPHER',
'roleArn': 'string',
'status': 'INITIALIZING'|'EXPORTING'|'ANALYZING_DATA'|'IMPORTING'|'REPROVISIONING'|'ROLLING_BACK'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
tasks (list) --
The requested list of import tasks.
(dict) --
Details about an import task.
graphId (string) --
The unique identifier of the Neptune Analytics graph.
taskId (string) --
The unique identifier of the import task.
source (string) --
A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot
format (string) --
Specifies the format of S3 data to be imported. Valid values are CSV , which identifies the Gremlin CSV format or OPENCYPHER , which identies the openCypher load format.
roleArn (string) --
The ARN of the IAM role that will allow access to the data that is to be imported.
status (string) --
Status of the import task.
nextToken (string) --
Pagination token used to paginate output.
When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.
Gets information about a specified graph.
See also: AWS API Documentation
Request Syntax
client.get_graph(
graphIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the Neptune Analytics graph.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'RESETTING'|'UPDATING'|'SNAPSHOTTING'|'FAILED',
'statusReason': 'string',
'createTime': datetime(2015, 1, 1),
'provisionedMemory': 123,
'endpoint': 'string',
'publicConnectivity': True|False,
'vectorSearchConfiguration': {
'dimension': 123
},
'replicaCount': 123,
'kmsKeyIdentifier': 'string',
'sourceSnapshotId': 'string',
'deletionProtection': True|False,
'buildNumber': 'string'
}
Response Structure
(dict) --
id (string) --
The unique identifier of the graph.
name (string) --
The name of the graph.
arn (string) --
The ARN associated with the graph.
status (string) --
The status of the graph.
statusReason (string) --
The reason that the graph has this status.
createTime (datetime) --
The time at which the graph was created.
provisionedMemory (integer) --
The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.
endpoint (string) --
The graph endpoint.
publicConnectivity (boolean) --
If true , the graph has a public endpoint, otherwise not.
vectorSearchConfiguration (dict) --
Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535
dimension (integer) --
The number of dimensions.
replicaCount (integer) --
The number of replicas for the graph.
kmsKeyIdentifier (string) --
The ID of the KMS key used to encrypt and decrypt graph data.
sourceSnapshotId (string) --
The ID of the snapshot from which the graph was created, if it was created from a snapshot.
deletionProtection (boolean) --
If true , deletion protection is enabled for the graph.
buildNumber (string) --
The build number of the graph.
Lists private endpoints for a specified Neptune Analytics graph.
See also: AWS API Documentation
Request Syntax
client.list_private_graph_endpoints(
graphIdentifier='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique identifier of the Neptune Analytics graph.
string
Pagination token used to paginate output.
When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.
integer
The total number of records to return in the command's output.
If the total number of records available is more than the value specified, nextToken is provided in the command's output. To resume pagination, provide the nextToken output value in the nextToken argument of a subsequent command. Do not use the nextToken response element directly outside of the Amazon CLI.
dict
Response Syntax
{
'privateGraphEndpoints': [
{
'vpcId': 'string',
'subnetIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'FAILED',
'vpcEndpointId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
privateGraphEndpoints (list) --
A list of private endpoints for the specified Neptune Analytics graph.
(dict) --
Details about a private graph endpoint.
vpcId (string) --
The ID of the VPC in which the private graph endpoint is located.
subnetIds (list) --
The subnet IDs associated with the private graph endpoint.
(string) --
status (string) --
The status of the private graph endpoint.
vpcEndpointId (string) --
The ID of the VPC endpoint.
nextToken (string) --
Pagination token used to paginate output.
When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.
Retrieves a specified import task.
See also: AWS API Documentation
Request Syntax
client.get_import_task(
taskIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the import task.
dict
Response Syntax
{
'graphId': 'string',
'taskId': 'string',
'source': 'string',
'format': 'CSV'|'OPEN_CYPHER',
'roleArn': 'string',
'status': 'INITIALIZING'|'EXPORTING'|'ANALYZING_DATA'|'IMPORTING'|'REPROVISIONING'|'ROLLING_BACK'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED',
'importOptions': {
'neptune': {
's3ExportPath': 'string',
's3ExportKmsKeyId': 'string',
'preserveDefaultVertexLabels': True|False,
'preserveEdgeIds': True|False
}
},
'importTaskDetails': {
'status': 'string',
'startTime': datetime(2015, 1, 1),
'timeElapsedSeconds': 123,
'progressPercentage': 123,
'errorCount': 123,
'errorDetails': 'string',
'statementCount': 123,
'dictionaryEntryCount': 123
},
'attemptNumber': 123,
'statusReason': 'string'
}
Response Structure
(dict) --
graphId (string) --
The unique identifier of the Neptune Analytics graph.
taskId (string) --
The unique identifier of the import task.
source (string) --
A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot
format (string) --
Specifies the format of S3 data to be imported. Valid values are CSV , which identifies the Gremlin CSV format or OPENCYPHER , which identies the openCypher load format.
roleArn (string) --
The ARN of the IAM role that will allow access to the data that is to be imported.
status (string) --
The status of the import task:
INITIALIZING – The necessary resources needed to create the graph are being prepared.
ANALYZING_DATA – The data is being analyzed to determine the optimal infrastructure configuration for the new graph.
RE_PROVISIONING – The data did not fit into the provisioned graph, so it is being re-provisioned with more capacity.
IMPORTING – The data is being loaded.
ERROR_ENCOUNTERED – An error has been encountered while trying to create the graph and import the data.
ERROR_ENCOUNTERED_ROLLING_BACK – Because of the error that was encountered, the graph is being rolled back and all its resources released.
SUCCEEDED – Graph creation and data loading succeeded.
FAILED – Graph creation or data loading failed. When the status is FAILED , you can use get-graphs to get more information about the state of the graph.
CANCELLING – Because you cancelled the import task, cancellation is in progress.
CANCELLED – You have successfully cancelled the import task.
importOptions (dict) --
Contains options for controlling the import process. For example, if the failOnError key is set to false , the import skips problem data and attempts to continue (whereas if set to true , the default, or if omitted, the import operation halts immediately when an error is encountered.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: neptune. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
neptune (dict) --
Options for importing data from a Neptune database.
s3ExportPath (string) --
The path to an S3 bucket from which to import data.
s3ExportKmsKeyId (string) --
The KMS key to use to encrypt data in the S3 bucket where the graph data is exported
preserveDefaultVertexLabels (boolean) --
Neptune Analytics supports label-less vertices and no labels are assigned unless one is explicitly provided. Neptune assigns default labels when none is explicitly provided. When importing the data into Neptune Analytics, the default vertex labels can be omitted by setting preserveDefaultVertexLabels to false. Note that if the vertex only has default labels, and has no other properties or edges, then the vertex will effectively not get imported into Neptune Analytics when preserveDefaultVertexLabels is set to false.
preserveEdgeIds (boolean) --
Neptune Analytics currently does not support user defined edge ids. The edge ids are not imported by default. They are imported if preserveEdgeIds is set to true, and ids are stored as properties on the relationships with the property name neptuneEdgeId.
importTaskDetails (dict) --
Contains details about the specified import task.
status (string) --
Status of the import task.
startTime (datetime) --
Time at which the import task started.
timeElapsedSeconds (integer) --
Seconds elapsed since the import task started.
progressPercentage (integer) --
The percentage progress so far.
errorCount (integer) --
The number of errors encountered so far.
errorDetails (string) --
Details about the errors that have been encountered.
statementCount (integer) --
The number of statements in the import task.
dictionaryEntryCount (integer) --
The number of dictionary entries in the import task.
attemptNumber (integer) --
The number of the current attempt to execute the import task.
statusReason (string) --
The reason that the import task has this status value.
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.
See also: AWS API Documentation
Request Syntax
client.create_graph_using_import_task(
graphName='string',
tags={
'string': 'string'
},
publicConnectivity=True|False,
kmsKeyIdentifier='string',
vectorSearchConfiguration={
'dimension': 123
},
replicaCount=123,
deletionProtection=True|False,
importOptions={
'neptune': {
's3ExportPath': 'string',
's3ExportKmsKeyId': 'string',
'preserveDefaultVertexLabels': True|False,
'preserveEdgeIds': True|False
}
},
maxProvisionedMemory=123,
minProvisionedMemory=123,
failOnError=True|False,
source='string',
format='CSV'|'OPEN_CYPHER',
roleArn='string'
)
string
[REQUIRED]
A name for the new Neptune Analytics graph to be created.
The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.
dict
Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.
(string) --
(string) --
boolean
Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated. ( true to enable, or false to disable.
string
Specifies a KMS key to use to encrypt data imported into the new graph.
dict
Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified as dimension= value. Max = 65,535
dimension (integer) -- [REQUIRED]
The number of dimensions.
integer
The number of replicas in other AZs to provision on the new graph after import. Default = 0, Min = 0, Max = 2.
boolean
Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. ( true or false ).
dict
Contains options for controlling the import process. For example, if the failOnError key is set to false , the import skips problem data and attempts to continue (whereas if set to true , the default, or if omitted, the import operation halts immediately when an error is encountered.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: neptune.
neptune (dict) --
Options for importing data from a Neptune database.
s3ExportPath (string) -- [REQUIRED]
The path to an S3 bucket from which to import data.
s3ExportKmsKeyId (string) -- [REQUIRED]
The KMS key to use to encrypt data in the S3 bucket where the graph data is exported
preserveDefaultVertexLabels (boolean) --
Neptune Analytics supports label-less vertices and no labels are assigned unless one is explicitly provided. Neptune assigns default labels when none is explicitly provided. When importing the data into Neptune Analytics, the default vertex labels can be omitted by setting preserveDefaultVertexLabels to false. Note that if the vertex only has default labels, and has no other properties or edges, then the vertex will effectively not get imported into Neptune Analytics when preserveDefaultVertexLabels is set to false.
preserveEdgeIds (boolean) --
Neptune Analytics currently does not support user defined edge ids. The edge ids are not imported by default. They are imported if preserveEdgeIds is set to true, and ids are stored as properties on the relationships with the property name neptuneEdgeId.
integer
The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 1024, or the approved upper limit for your account.
If both the minimum and maximum values are specified, the max of the min-provisioned-memory and max-provisioned memory is used to create the graph. If neither value is specified 128 m-NCUs are used.
integer
The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 128
boolean
If set to true , the task halts when an import error is encountered. If set to false , the task skips the data that caused the error and continues if possible.
string
[REQUIRED]
A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.
string
Specifies the format of S3 data to be imported. Valid values are CSV , which identifies the Gremlin CSV format or OPENCYPHER , which identies the openCypher load format.
string
[REQUIRED]
The ARN of the IAM role that will allow access to the data that is to be imported.
dict
Response Syntax
{
'graphId': 'string',
'taskId': 'string',
'source': 'string',
'format': 'CSV'|'OPEN_CYPHER',
'roleArn': 'string',
'status': 'INITIALIZING'|'EXPORTING'|'ANALYZING_DATA'|'IMPORTING'|'REPROVISIONING'|'ROLLING_BACK'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED',
'importOptions': {
'neptune': {
's3ExportPath': 'string',
's3ExportKmsKeyId': 'string',
'preserveDefaultVertexLabels': True|False,
'preserveEdgeIds': True|False
}
}
}
Response Structure
(dict) --
graphId (string) --
The unique identifier of the Neptune Analytics graph.
taskId (string) --
The unique identifier of the import task.
source (string) --
A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.
format (string) --
Specifies the format of S3 data to be imported. Valid values are CSV , which identifies the Gremlin CSV format or OPENCYPHER , which identies the openCypher load format.
roleArn (string) --
The ARN of the IAM role that will allow access to the data that is to be imported.
status (string) --
The status of the import task.
importOptions (dict) --
Contains options for controlling the import process. For example, if the failOnError key is set to false , the import skips problem data and attempts to continue (whereas if set to true , the default, or if omitted, the import operation halts immediately when an error is encountered.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: neptune. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
neptune (dict) --
Options for importing data from a Neptune database.
s3ExportPath (string) --
The path to an S3 bucket from which to import data.
s3ExportKmsKeyId (string) --
The KMS key to use to encrypt data in the S3 bucket where the graph data is exported
preserveDefaultVertexLabels (boolean) --
Neptune Analytics supports label-less vertices and no labels are assigned unless one is explicitly provided. Neptune assigns default labels when none is explicitly provided. When importing the data into Neptune Analytics, the default vertex labels can be omitted by setting preserveDefaultVertexLabels to false. Note that if the vertex only has default labels, and has no other properties or edges, then the vertex will effectively not get imported into Neptune Analytics when preserveDefaultVertexLabels is set to false.
preserveEdgeIds (boolean) --
Neptune Analytics currently does not support user defined edge ids. The edge ids are not imported by default. They are imported if preserveEdgeIds is set to true, and ids are stored as properties on the relationships with the property name neptuneEdgeId.
Retrieves a specified graph snapshot.
See also: AWS API Documentation
Request Syntax
client.get_graph_snapshot(
snapshotIdentifier='string'
)
string
[REQUIRED]
The ID of the snapshot to retrieve.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'sourceGraphId': 'string',
'snapshotCreateTime': datetime(2015, 1, 1),
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'FAILED',
'kmsKeyIdentifier': 'string'
}
Response Structure
(dict) --
id (string) --
The unique identifier of the graph snapshot.
name (string) --
The snapshot name. For example: my-snapshot-1 .
The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.
arn (string) --
The ARN of the graph snapshot.
sourceGraphId (string) --
The graph identifier for the graph for which a snapshot is to be created.
snapshotCreateTime (datetime) --
The time when the snapshot was created.
status (string) --
The status of the graph snapshot.
kmsKeyIdentifier (string) --
The ID of the KMS key used to encrypt and decrypt the snapshot.
Lists available snapshots of a specified Neptune Analytics graph.
See also: AWS API Documentation
Request Syntax
client.list_graph_snapshots(
graphIdentifier='string',
nextToken='string',
maxResults=123
)
string
The unique identifier of the Neptune Analytics graph.
string
Pagination token used to paginate output.
When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.
integer
The total number of records to return in the command's output.
If the total number of records available is more than the value specified, nextToken is provided in the command's output. To resume pagination, provide the nextToken output value in the nextToken argument of a subsequent command. Do not use the nextToken response element directly outside of the Amazon CLI.
dict
Response Syntax
{
'graphSnapshots': [
{
'id': 'string',
'name': 'string',
'arn': 'string',
'sourceGraphId': 'string',
'snapshotCreateTime': datetime(2015, 1, 1),
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'FAILED',
'kmsKeyIdentifier': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
graphSnapshots (list) --
The requested list of snapshots.
(dict) --
Details about a graph snapshot.
id (string) --
The unique identifier of the graph snapshot.
name (string) --
The snapshot name. For example: my-snapshot-1 .
The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.
arn (string) --
The ARN of the graph snapshot.
sourceGraphId (string) --
The graph identifier for the graph for which a snapshot is to be created.
snapshotCreateTime (datetime) --
The time when the snapshot was created.
status (string) --
The status of the graph snapshot.
kmsKeyIdentifier (string) --
The ID of the KMS key used to encrypt and decrypt the snapshot.
nextToken (string) --
Pagination token used to paginate output.
When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.
Adds tags to the specified resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
ARN of the resource for which tags need to be added.
dict
[REQUIRED]
The tags to be assigned to the Neptune Analytics resource.
The tags are metadata that are specified as a list of key-value pairs:
Key (string) – A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length. It can't be prefixed with aws: and can only contain the set of Unicode characters specified by this Java regular expression: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$") .
Value (string) – A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length. It can't be prefixed with aws: and can only contain the set of Unicode characters specified by this Java regular expression: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$") .
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a new Neptune Analytics graph.
See also: AWS API Documentation
Request Syntax
client.create_graph(
graphName='string',
tags={
'string': 'string'
},
publicConnectivity=True|False,
kmsKeyIdentifier='string',
vectorSearchConfiguration={
'dimension': 123
},
replicaCount=123,
deletionProtection=True|False,
provisionedMemory=123
)
string
[REQUIRED]
A name for the new Neptune Analytics graph to be created.
The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.
dict
Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.
(string) --
(string) --
boolean
Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated. ( true to enable, or false to disable.
string
Specifies a KMS key to use to encrypt data in the new graph.
dict
Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified as dimension= value. Max = 65,535
dimension (integer) -- [REQUIRED]
The number of dimensions.
integer
The number of replicas in other AZs. Min =0, Max = 2, Default =1
boolean
Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. ( true or false ).
integer
[REQUIRED]
The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'RESETTING'|'UPDATING'|'SNAPSHOTTING'|'FAILED',
'statusReason': 'string',
'createTime': datetime(2015, 1, 1),
'provisionedMemory': 123,
'endpoint': 'string',
'publicConnectivity': True|False,
'vectorSearchConfiguration': {
'dimension': 123
},
'replicaCount': 123,
'kmsKeyIdentifier': 'string',
'sourceSnapshotId': 'string',
'deletionProtection': True|False,
'buildNumber': 'string'
}
Response Structure
(dict) --
id (string) --
The ID of the graph.
name (string) --
The graph name. For example: my-graph-1 .
The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.
arn (string) --
The ARN of the graph.
status (string) --
The current status of the graph.
statusReason (string) --
The reason the status was given.
createTime (datetime) --
The time when the graph was created.
provisionedMemory (integer) --
The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128
endpoint (string) --
The graph endpoint.
publicConnectivity (boolean) --
Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.
vectorSearchConfiguration (dict) --
The vector-search configuration for the graph, which specifies the vector dimension to use in the vector index, if any.
dimension (integer) --
The number of dimensions.
replicaCount (integer) --
The number of replicas in other AZs.
kmsKeyIdentifier (string) --
Specifies the KMS key used to encrypt data in the new graph.
sourceSnapshotId (string) --
The ID of the source graph.
deletionProtection (boolean) --
A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
buildNumber (string) --
The build number of the graph software.
Deletes a private graph endpoint.
See also: AWS API Documentation
Request Syntax
client.delete_private_graph_endpoint(
graphIdentifier='string',
vpcId='string'
)
string
[REQUIRED]
The unique identifier of the Neptune Analytics graph.
string
[REQUIRED]
The ID of the VPC where the private endpoint is located.
dict
Response Syntax
{
'vpcId': 'string',
'subnetIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'FAILED',
'vpcEndpointId': 'string'
}
Response Structure
(dict) --
vpcId (string) --
The ID of the VPC where the private endpoint was deleted.
subnetIds (list) --
The subnet IDs involved.
(string) --
status (string) --
The status of the delete operation.
vpcEndpointId (string) --
The ID of the VPC endpoint that was deleted.
Updates the configuration of a specified Neptune Analytics graph
See also: AWS API Documentation
Request Syntax
client.update_graph(
graphIdentifier='string',
publicConnectivity=True|False,
provisionedMemory=123,
deletionProtection=True|False
)
string
[REQUIRED]
The unique identifier of the Neptune Analytics graph.
boolean
Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated. ( true to enable, or false to disable.
integer
The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128
boolean
A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'RESETTING'|'UPDATING'|'SNAPSHOTTING'|'FAILED',
'statusReason': 'string',
'createTime': datetime(2015, 1, 1),
'provisionedMemory': 123,
'endpoint': 'string',
'publicConnectivity': True|False,
'vectorSearchConfiguration': {
'dimension': 123
},
'replicaCount': 123,
'kmsKeyIdentifier': 'string',
'sourceSnapshotId': 'string',
'deletionProtection': True|False,
'buildNumber': 'string'
}
Response Structure
(dict) --
id (string) --
The unique identifier of the graph.
name (string) --
The name of the graph.
arn (string) --
The ARN associated with the graph.
status (string) --
The status of the graph.
statusReason (string) --
The reason that the graph has this status.
createTime (datetime) --
The time at which the graph was created.
provisionedMemory (integer) --
The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.
endpoint (string) --
The graph endpoint.
publicConnectivity (boolean) --
If true , the graph has a public endpoint, otherwise not.
vectorSearchConfiguration (dict) --
Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535
dimension (integer) --
The number of dimensions.
replicaCount (integer) --
The number of replicas for the graph.
kmsKeyIdentifier (string) --
The ID of the KMS key used to encrypt and decrypt graph data.
sourceSnapshotId (string) --
The ID of the snapshot from which the graph was created, if any.
deletionProtection (boolean) --
If true , deletion protection is enabled for the graph.
buildNumber (string) --
The build number of the graph.
Lists tags associated with a specified resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The ARN of the resource.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
The list of metadata tags associated with the resource.
(string) --
(string) --