Skip to content

Type definitions#

Index > NeptuneData > Type definitions

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

CancelGremlinQueryInputRequestTypeDef#

# CancelGremlinQueryInputRequestTypeDef definition

class CancelGremlinQueryInputRequestTypeDef(TypedDict):
    queryId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CancelLoaderJobInputRequestTypeDef#

# CancelLoaderJobInputRequestTypeDef definition

class CancelLoaderJobInputRequestTypeDef(TypedDict):
    loadId: str,

CancelMLDataProcessingJobInputRequestTypeDef#

# CancelMLDataProcessingJobInputRequestTypeDef definition

class CancelMLDataProcessingJobInputRequestTypeDef(TypedDict):
    id: str,
    neptuneIamRoleArn: NotRequired[str],
    clean: NotRequired[bool],

CancelMLModelTrainingJobInputRequestTypeDef#

# CancelMLModelTrainingJobInputRequestTypeDef definition

class CancelMLModelTrainingJobInputRequestTypeDef(TypedDict):
    id: str,
    neptuneIamRoleArn: NotRequired[str],
    clean: NotRequired[bool],

CancelMLModelTransformJobInputRequestTypeDef#

# CancelMLModelTransformJobInputRequestTypeDef definition

class CancelMLModelTransformJobInputRequestTypeDef(TypedDict):
    id: str,
    neptuneIamRoleArn: NotRequired[str],
    clean: NotRequired[bool],

CancelOpenCypherQueryInputRequestTypeDef#

# CancelOpenCypherQueryInputRequestTypeDef definition

class CancelOpenCypherQueryInputRequestTypeDef(TypedDict):
    queryId: str,
    silent: NotRequired[bool],

CreateMLEndpointInputRequestTypeDef#

# CreateMLEndpointInputRequestTypeDef definition

class CreateMLEndpointInputRequestTypeDef(TypedDict):
    id: NotRequired[str],
    mlModelTrainingJobId: NotRequired[str],
    mlModelTransformJobId: NotRequired[str],
    update: NotRequired[bool],
    neptuneIamRoleArn: NotRequired[str],
    modelName: NotRequired[str],
    instanceType: NotRequired[str],
    instanceCount: NotRequired[int],
    volumeEncryptionKMSKey: NotRequired[str],

CustomModelTrainingParametersTypeDef#

# CustomModelTrainingParametersTypeDef definition

class CustomModelTrainingParametersTypeDef(TypedDict):
    sourceS3DirectoryPath: str,
    trainingEntryPointScript: NotRequired[str],
    transformEntryPointScript: NotRequired[str],

CustomModelTransformParametersTypeDef#

# CustomModelTransformParametersTypeDef definition

class CustomModelTransformParametersTypeDef(TypedDict):
    sourceS3DirectoryPath: str,
    transformEntryPointScript: NotRequired[str],

DeleteMLEndpointInputRequestTypeDef#

# DeleteMLEndpointInputRequestTypeDef definition

class DeleteMLEndpointInputRequestTypeDef(TypedDict):
    id: str,
    neptuneIamRoleArn: NotRequired[str],
    clean: NotRequired[bool],

DeleteStatisticsValueMapTypeDef#

# DeleteStatisticsValueMapTypeDef definition

class DeleteStatisticsValueMapTypeDef(TypedDict):
    active: NotRequired[bool],
    statisticsId: NotRequired[str],

EdgeStructureTypeDef#

# EdgeStructureTypeDef definition

class EdgeStructureTypeDef(TypedDict):
    count: NotRequired[int],
    edgeProperties: NotRequired[List[str]],

ExecuteFastResetInputRequestTypeDef#

# ExecuteFastResetInputRequestTypeDef definition

class ExecuteFastResetInputRequestTypeDef(TypedDict):
    action: ActionType,  # (1)
    token: NotRequired[str],
  1. See ActionType

FastResetTokenTypeDef#

# FastResetTokenTypeDef definition

class FastResetTokenTypeDef(TypedDict):
    token: NotRequired[str],

ExecuteGremlinExplainQueryInputRequestTypeDef#

# ExecuteGremlinExplainQueryInputRequestTypeDef definition

class ExecuteGremlinExplainQueryInputRequestTypeDef(TypedDict):
    gremlinQuery: str,

ExecuteGremlinProfileQueryInputRequestTypeDef#

# ExecuteGremlinProfileQueryInputRequestTypeDef definition

class ExecuteGremlinProfileQueryInputRequestTypeDef(TypedDict):
    gremlinQuery: str,
    results: NotRequired[bool],
    chop: NotRequired[int],
    serializer: NotRequired[str],
    indexOps: NotRequired[bool],

ExecuteGremlinQueryInputRequestTypeDef#

# ExecuteGremlinQueryInputRequestTypeDef definition

class ExecuteGremlinQueryInputRequestTypeDef(TypedDict):
    gremlinQuery: str,
    serializer: NotRequired[str],

GremlinQueryStatusAttributesTypeDef#

# GremlinQueryStatusAttributesTypeDef definition

class GremlinQueryStatusAttributesTypeDef(TypedDict):
    message: NotRequired[str],
    code: NotRequired[int],
    attributes: NotRequired[Dict[str, Any]],

ExecuteOpenCypherExplainQueryInputRequestTypeDef#

# ExecuteOpenCypherExplainQueryInputRequestTypeDef definition

class ExecuteOpenCypherExplainQueryInputRequestTypeDef(TypedDict):
    openCypherQuery: str,
    explainMode: OpenCypherExplainModeType,  # (1)
    parameters: NotRequired[str],
  1. See OpenCypherExplainModeType

ExecuteOpenCypherQueryInputRequestTypeDef#

# ExecuteOpenCypherQueryInputRequestTypeDef definition

class ExecuteOpenCypherQueryInputRequestTypeDef(TypedDict):
    openCypherQuery: str,
    parameters: NotRequired[str],

QueryLanguageVersionTypeDef#

# QueryLanguageVersionTypeDef definition

class QueryLanguageVersionTypeDef(TypedDict):
    version: str,

GetGremlinQueryStatusInputRequestTypeDef#

# GetGremlinQueryStatusInputRequestTypeDef definition

class GetGremlinQueryStatusInputRequestTypeDef(TypedDict):
    queryId: str,

QueryEvalStatsTypeDef#

# QueryEvalStatsTypeDef definition

class QueryEvalStatsTypeDef(TypedDict):
    waited: NotRequired[int],
    elapsed: NotRequired[int],
    cancelled: NotRequired[bool],
    subqueries: NotRequired[Dict[str, Any]],

GetLoaderJobStatusInputRequestTypeDef#

# GetLoaderJobStatusInputRequestTypeDef definition

class GetLoaderJobStatusInputRequestTypeDef(TypedDict):
    loadId: str,
    details: NotRequired[bool],
    errors: NotRequired[bool],
    page: NotRequired[int],
    errorsPerPage: NotRequired[int],

GetMLDataProcessingJobInputRequestTypeDef#

# GetMLDataProcessingJobInputRequestTypeDef definition

class GetMLDataProcessingJobInputRequestTypeDef(TypedDict):
    id: str,
    neptuneIamRoleArn: NotRequired[str],

MlResourceDefinitionTypeDef#

# MlResourceDefinitionTypeDef definition

class MlResourceDefinitionTypeDef(TypedDict):
    name: NotRequired[str],
    arn: NotRequired[str],
    status: NotRequired[str],
    outputLocation: NotRequired[str],
    failureReason: NotRequired[str],
    cloudwatchLogUrl: NotRequired[str],

GetMLEndpointInputRequestTypeDef#

# GetMLEndpointInputRequestTypeDef definition

class GetMLEndpointInputRequestTypeDef(TypedDict):
    id: str,
    neptuneIamRoleArn: NotRequired[str],

MlConfigDefinitionTypeDef#

# MlConfigDefinitionTypeDef definition

class MlConfigDefinitionTypeDef(TypedDict):
    name: NotRequired[str],
    arn: NotRequired[str],

GetMLModelTrainingJobInputRequestTypeDef#

# GetMLModelTrainingJobInputRequestTypeDef definition

class GetMLModelTrainingJobInputRequestTypeDef(TypedDict):
    id: str,
    neptuneIamRoleArn: NotRequired[str],

GetMLModelTransformJobInputRequestTypeDef#

# GetMLModelTransformJobInputRequestTypeDef definition

class GetMLModelTransformJobInputRequestTypeDef(TypedDict):
    id: str,
    neptuneIamRoleArn: NotRequired[str],

GetOpenCypherQueryStatusInputRequestTypeDef#

# GetOpenCypherQueryStatusInputRequestTypeDef definition

class GetOpenCypherQueryStatusInputRequestTypeDef(TypedDict):
    queryId: str,

GetPropertygraphStreamInputRequestTypeDef#

# GetPropertygraphStreamInputRequestTypeDef definition

class GetPropertygraphStreamInputRequestTypeDef(TypedDict):
    limit: NotRequired[int],
    iteratorType: NotRequired[IteratorTypeType],  # (1)
    commitNum: NotRequired[int],
    opNum: NotRequired[int],
    encoding: NotRequired[EncodingType],  # (2)
  1. See IteratorTypeType
  2. See EncodingType

GetPropertygraphSummaryInputRequestTypeDef#

# GetPropertygraphSummaryInputRequestTypeDef definition

class GetPropertygraphSummaryInputRequestTypeDef(TypedDict):
    mode: NotRequired[GraphSummaryTypeType],  # (1)
  1. See GraphSummaryTypeType

GetRDFGraphSummaryInputRequestTypeDef#

# GetRDFGraphSummaryInputRequestTypeDef definition

class GetRDFGraphSummaryInputRequestTypeDef(TypedDict):
    mode: NotRequired[GraphSummaryTypeType],  # (1)
  1. See GraphSummaryTypeType

GetSparqlStreamInputRequestTypeDef#

# GetSparqlStreamInputRequestTypeDef definition

class GetSparqlStreamInputRequestTypeDef(TypedDict):
    limit: NotRequired[int],
    iteratorType: NotRequired[IteratorTypeType],  # (1)
    commitNum: NotRequired[int],
    opNum: NotRequired[int],
    encoding: NotRequired[EncodingType],  # (2)
  1. See IteratorTypeType
  2. See EncodingType

ListGremlinQueriesInputRequestTypeDef#

# ListGremlinQueriesInputRequestTypeDef definition

class ListGremlinQueriesInputRequestTypeDef(TypedDict):
    includeWaiting: NotRequired[bool],

ListLoaderJobsInputRequestTypeDef#

# ListLoaderJobsInputRequestTypeDef definition

class ListLoaderJobsInputRequestTypeDef(TypedDict):
    limit: NotRequired[int],
    includeQueuedLoads: NotRequired[bool],

LoaderIdResultTypeDef#

# LoaderIdResultTypeDef definition

class LoaderIdResultTypeDef(TypedDict):
    loadIds: NotRequired[List[str]],

ListMLDataProcessingJobsInputRequestTypeDef#

# ListMLDataProcessingJobsInputRequestTypeDef definition

class ListMLDataProcessingJobsInputRequestTypeDef(TypedDict):
    maxItems: NotRequired[int],
    neptuneIamRoleArn: NotRequired[str],

ListMLEndpointsInputRequestTypeDef#

# ListMLEndpointsInputRequestTypeDef definition

class ListMLEndpointsInputRequestTypeDef(TypedDict):
    maxItems: NotRequired[int],
    neptuneIamRoleArn: NotRequired[str],

ListMLModelTrainingJobsInputRequestTypeDef#

# ListMLModelTrainingJobsInputRequestTypeDef definition

class ListMLModelTrainingJobsInputRequestTypeDef(TypedDict):
    maxItems: NotRequired[int],
    neptuneIamRoleArn: NotRequired[str],

ListMLModelTransformJobsInputRequestTypeDef#

# ListMLModelTransformJobsInputRequestTypeDef definition

class ListMLModelTransformJobsInputRequestTypeDef(TypedDict):
    maxItems: NotRequired[int],
    neptuneIamRoleArn: NotRequired[str],

ListOpenCypherQueriesInputRequestTypeDef#

# ListOpenCypherQueriesInputRequestTypeDef definition

class ListOpenCypherQueriesInputRequestTypeDef(TypedDict):
    includeWaiting: NotRequired[bool],

ManagePropertygraphStatisticsInputRequestTypeDef#

# ManagePropertygraphStatisticsInputRequestTypeDef definition

class ManagePropertygraphStatisticsInputRequestTypeDef(TypedDict):
    mode: NotRequired[StatisticsAutoGenerationModeType],  # (1)
  1. See StatisticsAutoGenerationModeType

RefreshStatisticsIdMapTypeDef#

# RefreshStatisticsIdMapTypeDef definition

class RefreshStatisticsIdMapTypeDef(TypedDict):
    statisticsId: NotRequired[str],

ManageSparqlStatisticsInputRequestTypeDef#

# ManageSparqlStatisticsInputRequestTypeDef definition

class ManageSparqlStatisticsInputRequestTypeDef(TypedDict):
    mode: NotRequired[StatisticsAutoGenerationModeType],  # (1)
  1. See StatisticsAutoGenerationModeType

NodeStructureTypeDef#

# NodeStructureTypeDef definition

class NodeStructureTypeDef(TypedDict):
    count: NotRequired[int],
    nodeProperties: NotRequired[List[str]],
    distinctOutgoingEdgeLabels: NotRequired[List[str]],

PropertygraphDataTypeDef#

# PropertygraphDataTypeDef definition

class PropertygraphDataTypeDef(TypedDict):
    id: str,
    type: str,
    key: str,
    value: Dict[str, Any],
    from: NotRequired[str],
    to: NotRequired[str],

SubjectStructureTypeDef#

# SubjectStructureTypeDef definition

class SubjectStructureTypeDef(TypedDict):
    count: NotRequired[int],
    predicates: NotRequired[List[str]],

SparqlDataTypeDef#

# SparqlDataTypeDef definition

class SparqlDataTypeDef(TypedDict):
    stmt: str,

StartLoaderJobInputRequestTypeDef#

# StartLoaderJobInputRequestTypeDef definition

class StartLoaderJobInputRequestTypeDef(TypedDict):
    source: str,
    format: FormatType,  # (1)
    s3BucketRegion: S3BucketRegionType,  # (2)
    iamRoleArn: str,
    mode: NotRequired[ModeType],  # (3)
    failOnError: NotRequired[bool],
    parallelism: NotRequired[ParallelismType],  # (4)
    parserConfiguration: NotRequired[Mapping[str, str]],
    updateSingleCardinalityProperties: NotRequired[bool],
    queueRequest: NotRequired[bool],
    dependencies: NotRequired[Sequence[str]],
    userProvidedEdgeIds: NotRequired[bool],
  1. See FormatType
  2. See S3BucketRegionType
  3. See ModeType
  4. See ParallelismType

StartMLDataProcessingJobInputRequestTypeDef#

# StartMLDataProcessingJobInputRequestTypeDef definition

class StartMLDataProcessingJobInputRequestTypeDef(TypedDict):
    inputDataS3Location: str,
    processedDataS3Location: str,
    id: NotRequired[str],
    previousDataProcessingJobId: NotRequired[str],
    sagemakerIamRoleArn: NotRequired[str],
    neptuneIamRoleArn: NotRequired[str],
    processingInstanceType: NotRequired[str],
    processingInstanceVolumeSizeInGB: NotRequired[int],
    processingTimeOutInSeconds: NotRequired[int],
    modelType: NotRequired[str],
    configFileName: NotRequired[str],
    subnets: NotRequired[Sequence[str]],
    securityGroupIds: NotRequired[Sequence[str]],
    volumeEncryptionKMSKey: NotRequired[str],
    s3OutputEncryptionKMSKey: NotRequired[str],

StatisticsSummaryTypeDef