NeptuneGraphClient#
Index > NeptuneGraph > NeptuneGraphClient
Auto-generated documentation for NeptuneGraph type annotations stubs module types-boto3-neptune-graph.
NeptuneGraphClient#
Type annotations and code completion for boto3.client("neptune-graph")
.
boto3 documentation
# NeptuneGraphClient usage example
from boto3.session import Session
from types_boto3_neptune_graph.client import NeptuneGraphClient
def get_neptune-graph_client() -> NeptuneGraphClient:
return Session().client("neptune-graph")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("neptune-graph").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("neptune-graph")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.UnprocessableException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from types_boto3_neptune_graph.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
can_paginate#
Type annotations and code completion for boto3.client("neptune-graph").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
generate_presigned_url#
Type annotations and code completion for boto3.client("neptune-graph").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
cancel_export_task#
Cancel the specified export task.
Type annotations and code completion for boto3.client("neptune-graph").cancel_export_task
method.
boto3 documentation
# cancel_export_task method definition
def cancel_export_task(
self,
*,
taskIdentifier: str,
) -> CancelExportTaskOutputTypeDef: # (1)
...
# cancel_export_task method usage example with argument unpacking
kwargs: CancelExportTaskInputRequestTypeDef = { # (1)
"taskIdentifier": ...,
}
parent.cancel_export_task(**kwargs)
cancel_import_task#
Deletes the specified import task.
Type annotations and code completion for boto3.client("neptune-graph").cancel_import_task
method.
boto3 documentation
# cancel_import_task method definition
def cancel_import_task(
self,
*,
taskIdentifier: str,
) -> CancelImportTaskOutputTypeDef: # (1)
...
# cancel_import_task method usage example with argument unpacking
kwargs: CancelImportTaskInputRequestTypeDef = { # (1)
"taskIdentifier": ...,
}
parent.cancel_import_task(**kwargs)
cancel_query#
Cancels a specified query.
Type annotations and code completion for boto3.client("neptune-graph").cancel_query
method.
boto3 documentation
# cancel_query method definition
def cancel_query(
self,
*,
graphIdentifier: str,
queryId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# cancel_query method usage example with argument unpacking
kwargs: CancelQueryInputRequestTypeDef = { # (1)
"graphIdentifier": ...,
"queryId": ...,
}
parent.cancel_query(**kwargs)
create_graph#
Creates a new Neptune Analytics graph.
Type annotations and code completion for boto3.client("neptune-graph").create_graph
method.
boto3 documentation
# create_graph method definition
def create_graph(
self,
*,
graphName: str,
provisionedMemory: int,
tags: Mapping[str, str] = ...,
publicConnectivity: bool = ...,
kmsKeyIdentifier: str = ...,
vectorSearchConfiguration: VectorSearchConfigurationTypeDef = ..., # (1)
replicaCount: int = ...,
deletionProtection: bool = ...,
) -> CreateGraphOutputTypeDef: # (2)
...
# create_graph method usage example with argument unpacking
kwargs: CreateGraphInputRequestTypeDef = { # (1)
"graphName": ...,
"provisionedMemory": ...,
}
parent.create_graph(**kwargs)
create_graph_snapshot#
Creates a snapshot of the specific graph.
Type annotations and code completion for boto3.client("neptune-graph").create_graph_snapshot
method.
boto3 documentation
# create_graph_snapshot method definition
def create_graph_snapshot(
self,
*,
graphIdentifier: str,
snapshotName: str,
tags: Mapping[str, str] = ...,
) -> CreateGraphSnapshotOutputTypeDef: # (1)
...
# create_graph_snapshot method usage example with argument unpacking
kwargs: CreateGraphSnapshotInputRequestTypeDef = { # (1)
"graphIdentifier": ...,
"snapshotName": ...,
}
parent.create_graph_snapshot(**kwargs)
create_graph_using_import_task#
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.
Type annotations and code completion for boto3.client("neptune-graph").create_graph_using_import_task
method.
boto3 documentation
# create_graph_using_import_task method definition
def create_graph_using_import_task(
self,
*,
graphName: str,
source: str,
roleArn: str,
tags: Mapping[str, str] = ...,
publicConnectivity: bool = ...,
kmsKeyIdentifier: str = ...,
vectorSearchConfiguration: VectorSearchConfigurationTypeDef = ..., # (1)
replicaCount: int = ...,
deletionProtection: bool = ...,
importOptions: ImportOptionsTypeDef = ..., # (2)
maxProvisionedMemory: int = ...,
minProvisionedMemory: int = ...,
failOnError: bool = ...,
format: FormatType = ..., # (3)
parquetType: ParquetTypeType = ..., # (4)
blankNodeHandling: BlankNodeHandlingType = ..., # (5)
) -> CreateGraphUsingImportTaskOutputTypeDef: # (6)
...
- See VectorSearchConfigurationTypeDef
- See ImportOptionsTypeDef
- See FormatType
- See ParquetTypeType
- See BlankNodeHandlingType
- See CreateGraphUsingImportTaskOutputTypeDef
# create_graph_using_import_task method usage example with argument unpacking
kwargs: CreateGraphUsingImportTaskInputRequestTypeDef = { # (1)
"graphName": ...,
"source": ...,
"roleArn": ...,
}
parent.create_graph_using_import_task(**kwargs)
create_private_graph_endpoint#
Create a private graph endpoint to allow private access from to the graph from within a VPC.
Type annotations and code completion for boto3.client("neptune-graph").create_private_graph_endpoint
method.
boto3 documentation
# create_private_graph_endpoint method definition
def create_private_graph_endpoint(
self,
*,
graphIdentifier: str,
vpcId: str = ...,
subnetIds: Sequence[str] = ...,
vpcSecurityGroupIds: Sequence[str] = ...,
) -> CreatePrivateGraphEndpointOutputTypeDef: # (1)
...
# create_private_graph_endpoint method usage example with argument unpacking
kwargs: CreatePrivateGraphEndpointInputRequestTypeDef = { # (1)
"graphIdentifier": ...,
}
parent.create_private_graph_endpoint(**kwargs)
delete_graph#
Deletes the specified graph.
Type annotations and code completion for boto3.client("neptune-graph").delete_graph
method.
boto3 documentation
# delete_graph method definition
def delete_graph(
self,
*,
graphIdentifier: str,
skipSnapshot: bool,
) -> DeleteGraphOutputTypeDef: # (1)
...
# delete_graph method usage example with argument unpacking
kwargs: DeleteGraphInputRequestTypeDef = { # (1)
"graphIdentifier": ...,
"skipSnapshot": ...,
}
parent.delete_graph(**kwargs)
delete_graph_snapshot#
Deletes the specifed graph snapshot.
Type annotations and code completion for boto3.client("neptune-graph").delete_graph_snapshot
method.
boto3 documentation
# delete_graph_snapshot method definition
def delete_graph_snapshot(
self,
*,
snapshotIdentifier: str,
) -> DeleteGraphSnapshotOutputTypeDef: # (1)
...
# delete_graph_snapshot method usage example with argument unpacking
kwargs: DeleteGraphSnapshotInputRequestTypeDef = { # (1)
"snapshotIdentifier": ...,
}
parent.delete_graph_snapshot(**kwargs)
delete_private_graph_endpoint#
Deletes a private graph endpoint.
Type annotations and code completion for boto3.client("neptune-graph").delete_private_graph_endpoint
method.
boto3 documentation
# delete_private_graph_endpoint method definition
def delete_private_graph_endpoint(
self,
*,
graphIdentifier: str,
vpcId: str,
) -> DeletePrivateGraphEndpointOutputTypeDef: # (1)
...
# delete_private_graph_endpoint method usage example with argument unpacking
kwargs: DeletePrivateGraphEndpointInputRequestTypeDef = { # (1)
"graphIdentifier": ...,
"vpcId": ...,
}
parent.delete_private_graph_endpoint(**kwargs)
execute_query#
Execute an openCypher query.
Type annotations and code completion for boto3.client("neptune-graph").execute_query
method.
boto3 documentation
# execute_query method definition
def execute_query(
self,
*,
graphIdentifier: str,
queryString: str,
language: QueryLanguageType, # (1)
parameters: Mapping[str, Mapping[str, Any]] = ...,
planCache: PlanCacheTypeType = ..., # (2)
explainMode: ExplainModeType = ..., # (3)
queryTimeoutMilliseconds: int = ...,
) -> ExecuteQueryOutputTypeDef: # (4)
...
- See QueryLanguageType
- See PlanCacheTypeType
- See ExplainModeType
- See ExecuteQueryOutputTypeDef
# execute_query method usage example with argument unpacking
kwargs: ExecuteQueryInputRequestTypeDef = { # (1)
"graphIdentifier": ...,
"queryString": ...,
"language": ...,
}
parent.execute_query(**kwargs)
get_export_task#
Retrieves a specified export task.
Type annotations and code completion for boto3.client("neptune-graph").get_export_task
method.
boto3 documentation
# get_export_task method definition
def get_export_task(
self,
*,
taskIdentifier: str,
) -> GetExportTaskOutputTypeDef: # (1)
...
# get_export_task method usage example with argument unpacking
kwargs: GetExportTaskInputRequestTypeDef = { # (1)
"taskIdentifier": ...,
}
parent.get_export_task(**kwargs)
get_graph#
Gets information about a specified graph.
Type annotations and code completion for boto3.client("neptune-graph").get_graph
method.
boto3 documentation
# get_graph method definition
def get_graph(
self,
*,
graphIdentifier: str,
) -> GetGraphOutputTypeDef: # (1)
...
# get_graph method usage example with argument unpacking
kwargs: GetGraphInputRequestTypeDef = { # (1)
"graphIdentifier": ...,
}
parent.get_graph(**kwargs)
get_graph_snapshot#
Retrieves a specified graph snapshot.
Type annotations and code completion for boto3.client("neptune-graph").get_graph_snapshot
method.
boto3 documentation
# get_graph_snapshot method definition
def get_graph_snapshot(
self,
*,
snapshotIdentifier: str,
) -> GetGraphSnapshotOutputTypeDef: # (1)
...
# get_graph_snapshot method usage example with argument unpacking
kwargs: GetGraphSnapshotInputRequestTypeDef = { # (1)
"snapshotIdentifier": ...,
}
parent.get_graph_snapshot(**kwargs)
get_graph_summary#
Gets a graph summary for a property graph.
Type annotations and code completion for boto3.client("neptune-graph").get_graph_summary
method.
boto3 documentation
# get_graph_summary method definition
def get_graph_summary(
self,
*,
graphIdentifier: str,
mode: GraphSummaryModeType = ..., # (1)
) -> GetGraphSummaryOutputTypeDef: # (2)
...
# get_graph_summary method usage example with argument unpacking
kwargs: GetGraphSummaryInputRequestTypeDef = { # (1)
"graphIdentifier": ...,
}
parent.get_graph_summary(**kwargs)
get_import_task#
Retrieves a specified import task.
Type annotations and code completion for boto3.client("neptune-graph").get_import_task
method.
boto3 documentation
# get_import_task method definition
def get_import_task(
self,
*,
taskIdentifier: str,
) -> GetImportTaskOutputTypeDef: # (1)
...
# get_import_task method usage example with argument unpacking
kwargs: GetImportTaskInputRequestTypeDef = { # (1)
"taskIdentifier": ...,
}
parent.get_import_task(**kwargs)
get_private_graph_endpoint#
Retrieves information about a specified private endpoint.
Type annotations and code completion for boto3.client("neptune-graph").get_private_graph_endpoint
method.
boto3 documentation
# get_private_graph_endpoint method definition
def get_private_graph_endpoint(
self,
*,
graphIdentifier: str,
vpcId: str,
) -> GetPrivateGraphEndpointOutputTypeDef: # (1)
...
# get_private_graph_endpoint method usage example with argument unpacking
kwargs: GetPrivateGraphEndpointInputRequestTypeDef = { # (1)
"graphIdentifier": ...,
"vpcId": ...,
}
parent.get_private_graph_endpoint(**kwargs)
get_query#
Retrieves the status of a specified query.
Type annotations and code completion for boto3.client("neptune-graph").get_query
method.
boto3 documentation
# get_query method definition
def get_query(
self,
*,
graphIdentifier: str,
queryId: str,
) -> GetQueryOutputTypeDef: # (1)
...
# get_query method usage example with argument unpacking
kwargs: GetQueryInputRequestTypeDef = { # (1)
"graphIdentifier": ...,
"queryId": ...,
}
parent.get_query(**kwargs)
list_export_tasks#
Retrieves a list of export tasks.
Type annotations and code completion for boto3.client("neptune-graph").list_export_tasks
method.
boto3 documentation
# list_export_tasks method definition
def list_export_tasks(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListExportTasksOutputTypeDef: # (1)
...
# list_export_tasks method usage example with argument unpacking
kwargs: ListExportTasksInputRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_export_tasks(**kwargs)
list_graph_snapshots#
Lists available snapshots of a specified Neptune Analytics graph.
Type annotations and code completion for boto3.client("neptune-graph").list_graph_snapshots
method.
boto3 documentation
# list_graph_snapshots method definition
def list_graph_snapshots(
self,
*,
graphIdentifier: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> ListGraphSnapshotsOutputTypeDef: # (1)
...
# list_graph_snapshots method usage example with argument unpacking
kwargs: ListGraphSnapshotsInputRequestTypeDef = { # (1)
"graphIdentifier": ...,
}
parent.list_graph_snapshots(**kwargs)
list_graphs#
Lists available Neptune Analytics graphs.
Type annotations and code completion for boto3.client("neptune-graph").list_graphs
method.
boto3 documentation
# list_graphs method definition
def list_graphs(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListGraphsOutputTypeDef: # (1)
...
# list_graphs method usage example with argument unpacking
kwargs: ListGraphsInputRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_graphs(**kwargs)
list_import_tasks#
Lists import tasks.
Type annotations and code completion for boto3.client("neptune-graph").list_import_tasks
method.
boto3 documentation
# list_import_tasks method definition
def list_import_tasks(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListImportTasksOutputTypeDef: # (1)
...
# list_import_tasks method usage example with argument unpacking
kwargs: ListImportTasksInputRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_import_tasks(**kwargs)
list_private_graph_endpoints#
Lists private endpoints for a specified Neptune Analytics graph.
Type annotations and code completion for boto3.client("neptune-graph").list_private_graph_endpoints
method.
boto3 documentation
# list_private_graph_endpoints method definition
def list_private_graph_endpoints(
self,
*,
graphIdentifier: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListPrivateGraphEndpointsOutputTypeDef: # (1)
...
# list_private_graph_endpoints method usage example with argument unpacking
kwargs: ListPrivateGraphEndpointsInputRequestTypeDef = { # (1)
"graphIdentifier": ...,
}
parent.list_private_graph_endpoints(**kwargs)
list_queries#
Lists active openCypher queries.
Type annotations and code completion for boto3.client("neptune-graph").list_queries
method.
boto3 documentation
# list_queries method definition
def list_queries(
self,
*,
graphIdentifier: str,
maxResults: int,
state: QueryStateInputType = ..., # (1)
) -> ListQueriesOutputTypeDef: # (2)
...
# list_queries method usage example with argument unpacking
kwargs: ListQueriesInputRequestTypeDef = { # (1)
"graphIdentifier": ...,
"maxResults": ...,
}
parent.list_queries(**kwargs)
list_tags_for_resource#
Lists tags associated with a specified resource.
Type annotations and code completion for boto3.client("neptune-graph").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
reset_graph#
Empties the data from a specified Neptune Analytics graph.
Type annotations and code completion for boto3.client("neptune-graph").reset_graph
method.
boto3 documentation
# reset_graph method definition
def reset_graph(
self,
*,
graphIdentifier: str,
skipSnapshot: bool,
) -> ResetGraphOutputTypeDef: # (1)
...
# reset_graph method usage example with argument unpacking
kwargs: ResetGraphInputRequestTypeDef = { # (1)
"graphIdentifier": ...,
"skipSnapshot": ...,
}
parent.reset_graph(**kwargs)
restore_graph_from_snapshot#
Restores a graph from a snapshot.
Type annotations and code completion for boto3.client("neptune-graph").restore_graph_from_snapshot
method.
boto3 documentation
# restore_graph_from_snapshot method definition
def restore_graph_from_snapshot(
self,
*,
snapshotIdentifier: str,
graphName: str,
provisionedMemory: int = ...,
deletionProtection: bool = ...,
tags: Mapping[str, str] = ...,
replicaCount: int = ...,
publicConnectivity: bool = ...,
) -> RestoreGraphFromSnapshotOutputTypeDef: # (1)
...
# restore_graph_from_snapshot method usage example with argument unpacking
kwargs: RestoreGraphFromSnapshotInputRequestTypeDef = { # (1)
"snapshotIdentifier": ...,
"graphName": ...,
}
parent.restore_graph_from_snapshot(**kwargs)
start_export_task#
Export data from an existing Neptune Analytics graph to Amazon S3.
Type annotations and code completion for boto3.client("neptune-graph").start_export_task
method.
boto3 documentation
# start_export_task method definition
def start_export_task(
self,
*,
graphIdentifier: str,
roleArn: str,
format: ExportFormatType, # (1)
destination: str,
kmsKeyIdentifier: str,
parquetType: ParquetTypeType = ..., # (2)
exportFilter: ExportFilterTypeDef = ..., # (3)
tags: Mapping[str, str] = ...,
) -> StartExportTaskOutputTypeDef: # (4)
...
# start_export_task method usage example with argument unpacking
kwargs: StartExportTaskInputRequestTypeDef = { # (1)
"graphIdentifier": ...,
"roleArn": ...,
"format": ...,
"destination": ...,
"kmsKeyIdentifier": ...,
}
parent.start_export_task(**kwargs)
start_import_task#
Import data into existing Neptune Analytics graph from Amazon Simple Storage Service (S3).
Type annotations and code completion for boto3.client("neptune-graph").start_import_task
method.
boto3 documentation
# start_import_task method definition
def start_import_task(
self,
*,
source: str,
graphIdentifier: str,
roleArn: str,
importOptions: ImportOptionsTypeDef = ..., # (1)
failOnError: bool = ...,
format: FormatType = ..., # (2)
parquetType: ParquetTypeType = ..., # (3)
blankNodeHandling: BlankNodeHandlingType = ..., # (4)
) -> StartImportTaskOutputTypeDef: # (5)
...
- See ImportOptionsTypeDef
- See FormatType
- See ParquetTypeType
- See BlankNodeHandlingType
- See StartImportTaskOutputTypeDef
# start_import_task method usage example with argument unpacking
kwargs: StartImportTaskInputRequestTypeDef = { # (1)
"source": ...,
"graphIdentifier": ...,
"roleArn": ...,
}
parent.start_import_task(**kwargs)
tag_resource#
Adds tags to the specified resource.
Type annotations and code completion for boto3.client("neptune-graph").tag_resource
method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> dict[str, Any]:
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes the specified tags from the specified resource.
Type annotations and code completion for boto3.client("neptune-graph").untag_resource
method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_graph#
Updates the configuration of a specified Neptune Analytics graph.
Type annotations and code completion for boto3.client("neptune-graph").update_graph
method.
boto3 documentation
# update_graph method definition
def update_graph(
self,
*,
graphIdentifier: str,
publicConnectivity: bool = ...,
provisionedMemory: int = ...,
deletionProtection: bool = ...,
) -> UpdateGraphOutputTypeDef: # (1)
...
# update_graph method usage example with argument unpacking
kwargs: UpdateGraphInputRequestTypeDef = { # (1)
"graphIdentifier": ...,
}
parent.update_graph(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("neptune-graph").get_paginator
method with overloads.
client.get_paginator("list_export_tasks")
-> ListExportTasksPaginatorclient.get_paginator("list_graph_snapshots")
-> ListGraphSnapshotsPaginatorclient.get_paginator("list_graphs")
-> ListGraphsPaginatorclient.get_paginator("list_import_tasks")
-> ListImportTasksPaginatorclient.get_paginator("list_private_graph_endpoints")
-> ListPrivateGraphEndpointsPaginator
get_waiter#
Type annotations and code completion for boto3.client("neptune-graph").get_waiter
method with overloads.
client.get_waiter("export_task_cancelled")
-> ExportTaskCancelledWaiterclient.get_waiter("export_task_successful")
-> ExportTaskSuccessfulWaiterclient.get_waiter("graph_available")
-> GraphAvailableWaiterclient.get_waiter("graph_deleted")
-> GraphDeletedWaiterclient.get_waiter("graph_snapshot_available")
-> GraphSnapshotAvailableWaiterclient.get_waiter("graph_snapshot_deleted")
-> GraphSnapshotDeletedWaiterclient.get_waiter("import_task_cancelled")
-> ImportTaskCancelledWaiterclient.get_waiter("import_task_successful")
-> ImportTaskSuccessfulWaiterclient.get_waiter("private_graph_endpoint_available")
-> PrivateGraphEndpointAvailableWaiterclient.get_waiter("private_graph_endpoint_deleted")
-> PrivateGraphEndpointDeletedWaiter