Skip to content

NeptuneDataClient#

Index > NeptuneData > NeptuneDataClient

Auto-generated documentation for NeptuneData type annotations stubs module mypy-boto3-neptunedata.

NeptuneDataClient#

Type annotations and code completion for boto3.client("neptunedata"). boto3 documentation

# NeptuneDataClient usage example

from boto3.session import Session
from mypy_boto3_neptunedata.client import NeptuneDataClient

def get_neptunedata_client() -> NeptuneDataClient:
    return Session().client("neptunedata")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("neptunedata").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("neptunedata")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.BadRequestException,
    client.exceptions.BulkLoadIdNotFoundException,
    client.exceptions.CancelledByUserException,
    client.exceptions.ClientError,
    client.exceptions.ClientTimeoutException,
    client.exceptions.ConcurrentModificationException,
    client.exceptions.ConstraintViolationException,
    client.exceptions.ExpiredStreamException,
    client.exceptions.FailureByQueryException,
    client.exceptions.IllegalArgumentException,
    client.exceptions.InternalFailureException,
    client.exceptions.InvalidArgumentException,
    client.exceptions.InvalidNumericDataException,
    client.exceptions.InvalidParameterException,
    client.exceptions.LoadUrlAccessDeniedException,
    client.exceptions.MLResourceNotFoundException,
    client.exceptions.MalformedQueryException,
    client.exceptions.MemoryLimitExceededException,
    client.exceptions.MethodNotAllowedException,
    client.exceptions.MissingParameterException,
    client.exceptions.ParsingException,
    client.exceptions.PreconditionsFailedException,
    client.exceptions.QueryLimitExceededException,
    client.exceptions.QueryLimitException,
    client.exceptions.QueryTooLargeException,
    client.exceptions.ReadOnlyViolationException,
    client.exceptions.S3Exception,
    client.exceptions.ServerShutdownException,
    client.exceptions.StatisticsNotAvailableException,
    client.exceptions.StreamRecordsNotFoundException,
    client.exceptions.ThrottlingException,
    client.exceptions.TimeLimitExceededException,
    client.exceptions.TooManyRequestsException,
    client.exceptions.UnsupportedOperationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_neptunedata.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("neptunedata").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_gremlin_query#

Cancels a Gremlin query.

Type annotations and code completion for boto3.client("neptunedata").cancel_gremlin_query method. boto3 documentation

# cancel_gremlin_query method definition

def cancel_gremlin_query(
    self,
    *,
    queryId: str,
) -> CancelGremlinQueryOutputTypeDef:  # (1)
    ...
  1. See CancelGremlinQueryOutputTypeDef
# cancel_gremlin_query method usage example with argument unpacking

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

parent.cancel_gremlin_query(**kwargs)
  1. See CancelGremlinQueryInputRequestTypeDef

cancel_loader_job#

Cancels a specified load job.

Type annotations and code completion for boto3.client("neptunedata").cancel_loader_job method. boto3 documentation

# cancel_loader_job method definition

def cancel_loader_job(
    self,
    *,
    loadId: str,
) -> CancelLoaderJobOutputTypeDef:  # (1)
    ...
  1. See CancelLoaderJobOutputTypeDef
# cancel_loader_job method usage example with argument unpacking

kwargs: CancelLoaderJobInputRequestTypeDef = {  # (1)
    "loadId": ...,
}

parent.cancel_loader_job(**kwargs)
  1. See CancelLoaderJobInputRequestTypeDef

cancel_ml_data_processing_job#

Cancels a Neptune ML data processing job.

Type annotations and code completion for boto3.client("neptunedata").cancel_ml_data_processing_job method. boto3 documentation

# cancel_ml_data_processing_job method definition

def cancel_ml_data_processing_job(
    self,
    *,
    id: str,
    neptuneIamRoleArn: str = ...,
    clean: bool = ...,
) -> CancelMLDataProcessingJobOutputTypeDef:  # (1)
    ...
  1. See CancelMLDataProcessingJobOutputTypeDef
# cancel_ml_data_processing_job method usage example with argument unpacking

kwargs: CancelMLDataProcessingJobInputRequestTypeDef = {  # (1)
    "id": ...,
}

parent.cancel_ml_data_processing_job(**kwargs)
  1. See CancelMLDataProcessingJobInputRequestTypeDef

cancel_ml_model_training_job#

Cancels a Neptune ML model training job.

Type annotations and code completion for boto3.client("neptunedata").cancel_ml_model_training_job method. boto3 documentation

# cancel_ml_model_training_job method definition

def cancel_ml_model_training_job(
    self,
    *,
    id: str,
    neptuneIamRoleArn: str = ...,
    clean: bool = ...,
) -> CancelMLModelTrainingJobOutputTypeDef:  # (1)
    ...
  1. See CancelMLModelTrainingJobOutputTypeDef
# cancel_ml_model_training_job method usage example with argument unpacking

kwargs: CancelMLModelTrainingJobInputRequestTypeDef = {  # (1)
    "id": ...,
}

parent.cancel_ml_model_training_job(**kwargs)
  1. See CancelMLModelTrainingJobInputRequestTypeDef

cancel_ml_model_transform_job#

Cancels a specified model transform job.

Type annotations and code completion for boto3.client("neptunedata").cancel_ml_model_transform_job method. boto3 documentation

# cancel_ml_model_transform_job method definition

def cancel_ml_model_transform_job(
    self,
    *,
    id: str,
    neptuneIamRoleArn: str = ...,
    clean: bool = ...,
) -> CancelMLModelTransformJobOutputTypeDef:  # (1)
    ...
  1. See CancelMLModelTransformJobOutputTypeDef
# cancel_ml_model_transform_job method usage example with argument unpacking

kwargs: CancelMLModelTransformJobInputRequestTypeDef = {  # (1)
    "id": ...,
}

parent.cancel_ml_model_transform_job(**kwargs)
  1. See CancelMLModelTransformJobInputRequestTypeDef

cancel_open_cypher_query#

Cancels a specified openCypher query.

Type annotations and code completion for boto3.client("neptunedata").cancel_open_cypher_query method. boto3 documentation

# cancel_open_cypher_query method definition

def cancel_open_cypher_query(
    self,
    *,
    queryId: str,
    silent: bool = ...,
) -> CancelOpenCypherQueryOutputTypeDef:  # (1)
    ...
  1. See CancelOpenCypherQueryOutputTypeDef
# cancel_open_cypher_query method usage example with argument unpacking

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

parent.cancel_open_cypher_query(**kwargs)
  1. See CancelOpenCypherQueryInputRequestTypeDef

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("neptunedata").close method. boto3 documentation

# close method definition

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

create_ml_endpoint#

Creates a new Neptune ML inference endpoint that lets you query one specific model that the model-training process constructed.

Type annotations and code completion for boto3.client("neptunedata").create_ml_endpoint method. boto3 documentation

# create_ml_endpoint method definition

def create_ml_endpoint(
    self,
    *,
    id: str = ...,
    mlModelTrainingJobId: str = ...,
    mlModelTransformJobId: str = ...,
    update: bool = ...,
    neptuneIamRoleArn: str = ...,
    modelName: str = ...,
    instanceType: str = ...,
    instanceCount: int = ...,
    volumeEncryptionKMSKey: str = ...,
) -> CreateMLEndpointOutputTypeDef:  # (1)
    ...
  1. See CreateMLEndpointOutputTypeDef
# create_ml_endpoint method usage example with argument unpacking

kwargs: CreateMLEndpointInputRequestTypeDef = {  # (1)
    "id": ...,
}

parent.create_ml_endpoint(**kwargs)
  1. See CreateMLEndpointInputRequestTypeDef

delete_ml_endpoint#

Cancels the creation of a Neptune ML inference endpoint.

Type annotations and code completion for boto3.client("neptunedata").delete_ml_endpoint method. boto3 documentation

# delete_ml_endpoint method definition

def delete_ml_endpoint(
    self,
    *,
    id: str,
    neptuneIamRoleArn: str = ...,
    clean: bool = ...,
) -> DeleteMLEndpointOutputTypeDef:  # (1)
    ...
  1. See DeleteMLEndpointOutputTypeDef
# delete_ml_endpoint method usage example with argument unpacking

kwargs: DeleteMLEndpointInputRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_ml_endpoint(**kwargs)
  1. See DeleteMLEndpointInputRequestTypeDef

delete_propertygraph_statistics#

Deletes statistics for Gremlin and openCypher (property graph) data.

Type annotations and code completion for boto3.client("neptunedata").delete_propertygraph_statistics method.