Skip to content

NeptuneGraphClient#

Index > NeptuneGraph > NeptuneGraphClient

Auto-generated documentation for NeptuneGraph type annotations stubs module mypy-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 mypy_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 mypy_boto3_neptune_graph.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

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:
    ...

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)
    ...
  1. See CancelImportTaskOutputTypeDef
# cancel_import_task method usage example with argument unpacking

kwargs: CancelImportTaskInputRequestTypeDef = {  # (1)
    "taskIdentifier": ...,
}

parent.cancel_import_task(**kwargs)
  1. See CancelImportTaskInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# cancel_query method usage example with argument unpacking

kwargs: CancelQueryInputRequestTypeDef = {  # (1)
    "graphIdentifier": ...,
    "queryId": ...,
}

parent.cancel_query(**kwargs)
  1. See CancelQueryInputRequestTypeDef

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("neptune-graph").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

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)
    ...
  1. See VectorSearchConfigurationTypeDef
  2. See CreateGraphOutputTypeDef
# create_graph method usage example with argument unpacking

kwargs: CreateGraphInputRequestTypeDef = {  # (1)
    "graphName": ...,
    "provisionedMemory": ...,
}

parent.create_graph(**kwargs)
  1. See CreateGraphInputRequestTypeDef

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)
    ...
  1. See CreateGraphSnapshotOutputTypeDef
# create_graph_snapshot method usage example with argument unpacking

kwargs: CreateGraphSnapshotInputRequestTypeDef = {  # (1)
    "graphIdentifier": ...,
    "snapshotName": ...,
}

parent.create_graph_snapshot(**kwargs)
  1. See CreateGraphSnapshotInputRequestTypeDef

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)
) -> CreateGraphUsingImportTaskOutputTypeDef:  # (4)
    ...
  1. See VectorSearchConfigurationTypeDef
  2. See ImportOptionsTypeDef
  3. See FormatType
  4. 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)
  1. See CreateGraphUsingImportTaskInputRequestTypeDef

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)
    ...
  1. See CreatePrivateGraphEndpointOutputTypeDef
# create_private_graph_endpoint method usage example with argument unpacking

kwargs: CreatePrivateGraphEndpointInputRequestTypeDef = {  # (1)
    "graphIdentifier": ...,
}

parent.create_private_graph_endpoint(**kwargs)
  1. See CreatePrivateGraphEndpointInputRequestTypeDef

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)
    ...
  1. See DeleteGraphOutputTypeDef
# delete_graph method usage example with argument unpacking

kwargs: DeleteGraphInputRequestTypeDef = {  # (1)
    "graphIdentifier": ...,
    "skipSnapshot": ...,
}

parent.delete_graph(**kwargs)
  1. See DeleteGraphInputRequestTypeDef

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)
    ...
  1. See DeleteGraphSnapshotOutputTypeDef
# delete_graph_snapshot method usage example with argument unpacking

kwargs: DeleteGraphSnapshotInputRequestTypeDef = {  # (1)
    "snapshotIdentifier": ...,
}

parent.delete_graph_snapshot(**kwargs)
  1. See DeleteGraphSnapshotInputRequestTypeDef

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)
    ...
  1. See DeletePrivateGraphEndpointOutputTypeDef
# delete_private_graph_endpoint method usage example with argument unpacking

kwargs: DeletePrivateGraphEndpointInputRequestTypeDef = {  # (1)
    "graphIdentifier": ...,
    "vpcId": ...,
}

parent.delete_private_graph_endpoint(**kwargs)
  1. See DeletePrivateGraphEndpointInputRequestTypeDef

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)
    ...
  1. See QueryLanguageType
  2. See PlanCacheTypeType
  3. See ExplainModeType
  4. See ExecuteQueryOutputTypeDef
# execute_query method usage example with argument unpacking

kwargs: ExecuteQueryInputRequestTypeDef = {  # (1)
    "graphIdentifier": ...,
    "queryString": ...,
    "language": ...,
}

parent.execute_query(**kwargs)
  1. See ExecuteQueryInputRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

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:
    ...

get_graph#

Gets information about a specified graph.

Type annotations and code completion for boto3.client("neptune-graph").get_graph method.