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. boto3 documentation

# get_graph method definition

def get_graph(
    self,
    *,
    graphIdentifier: str,
) -> GetGraphOutputTypeDef:  # (1)
    ...

1. See GetGraphOutputTypeDef

# get_graph method usage example with argument unpacking

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

parent.get_graph(**kwargs)

1. See GetGraphInputRequestTypeDef

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

1. See GetGraphSnapshotOutputTypeDef

# get_graph_snapshot method usage example with argument unpacking

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

parent.get_graph_snapshot(**kwargs)

1. See GetGraphSnapshotInputRequestTypeDef

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

1. See GraphSummaryModeType
2. See GetGraphSummaryOutputTypeDef

# get_graph_summary method usage example with argument unpacking

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

parent.get_graph_summary(**kwargs)

1. See GetGraphSummaryInputRequestTypeDef

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

1. See GetImportTaskOutputTypeDef

# get_import_task method usage example with argument unpacking

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

parent.get_import_task(**kwargs)

1. See GetImportTaskInputRequestTypeDef

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

1. See GetPrivateGraphEndpointOutputTypeDef

# get_private_graph_endpoint method usage example with argument unpacking

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

parent.get_private_graph_endpoint(**kwargs)

1. See GetPrivateGraphEndpointInputRequestTypeDef

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

1. See GetQueryOutputTypeDef

# get_query method usage example with argument unpacking

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

parent.get_query(**kwargs)

1. See GetQueryInputRequestTypeDef

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

1. See ListGraphSnapshotsOutputTypeDef

# list_graph_snapshots method usage example with argument unpacking

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

parent.list_graph_snapshots(**kwargs)

1. See ListGraphSnapshotsInputRequestTypeDef

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

1. See ListGraphsOutputTypeDef

# list_graphs method usage example with argument unpacking

kwargs: ListGraphsInputRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_graphs(**kwargs)

1. See ListGraphsInputRequestTypeDef

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

1. See ListImportTasksOutputTypeDef

# list_import_tasks method usage example with argument unpacking

kwargs: ListImportTasksInputRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_import_tasks(**kwargs)

1. See ListImportTasksInputRequestTypeDef

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

1. See ListPrivateGraphEndpointsOutputTypeDef

# list_private_graph_endpoints method usage example with argument unpacking

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

parent.list_private_graph_endpoints(**kwargs)

1. See ListPrivateGraphEndpointsInputRequestTypeDef

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

1. See QueryStateInputType
2. See ListQueriesOutputTypeDef

# list_queries method usage example with argument unpacking

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

parent.list_queries(**kwargs)

1. See ListQueriesInputRequestTypeDef

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

1. See ListTagsForResourceOutputTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceInputRequestTypeDef

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

1. See ResetGraphOutputTypeDef

# reset_graph method usage example with argument unpacking

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

parent.reset_graph(**kwargs)

1. See ResetGraphInputRequestTypeDef

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

1. See RestoreGraphFromSnapshotOutputTypeDef

# restore_graph_from_snapshot method usage example with argument unpacking

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

parent.restore_graph_from_snapshot(**kwargs)

1. See RestoreGraphFromSnapshotInputRequestTypeDef

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)
) -> StartImportTaskOutputTypeDef:  # (3)
    ...

1. See ImportOptionsTypeDef
2. See FormatType
3. See StartImportTaskOutputTypeDef

# start_import_task method usage example with argument unpacking

kwargs: StartImportTaskInputRequestTypeDef = {  # (1)
    "source": ...,
    "graphIdentifier": ...,
    "roleArn": ...,
}

parent.start_import_task(**kwargs)

1. See StartImportTaskInputRequestTypeDef

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)

1. See TagResourceInputRequestTypeDef

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)

1. See UntagResourceInputRequestTypeDef

update_graph

Updates the configuration of a specified Neptune Analytics graph See also: AWS API Documentation.

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

1. See UpdateGraphOutputTypeDef

# update_graph method usage example with argument unpacking

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

parent.update_graph(**kwargs)

1. See UpdateGraphInputRequestTypeDef

get_paginator

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

• client.get_paginator("list_graph_snapshots") -> ListGraphSnapshotsPaginator
• client.get_paginator("list_graphs") -> ListGraphsPaginator
• client.get_paginator("list_import_tasks") -> ListImportTasksPaginator
• client.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("graph_available") -> GraphAvailableWaiter
• client.get_waiter("graph_deleted") -> GraphDeletedWaiter
• client.get_waiter("graph_snapshot_available") -> GraphSnapshotAvailableWaiter
• client.get_waiter("graph_snapshot_deleted") -> GraphSnapshotDeletedWaiter
• client.get_waiter("import_task_cancelled") -> ImportTaskCancelledWaiter
• client.get_waiter("import_task_successful") -> ImportTaskSuccessfulWaiter
• client.get_waiter("private_graph_endpoint_available") -> PrivateGraphEndpointAvailableWaiter
• client.get_waiter("private_graph_endpoint_deleted") -> PrivateGraphEndpointDeletedWaiter