Skip to content

Type definitions#

Index > NeptuneData > Type definitions

Auto-generated documentation for NeptuneData type annotations stubs module types-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#

# StatisticsSummaryTypeDef definition

class StatisticsSummaryTypeDef(TypedDict):
    signatureCount: NotRequired[int],
    instanceCount: NotRequired[int],
    predicateCount: NotRequired[int],

CancelGremlinQueryOutputTypeDef#

# CancelGremlinQueryOutputTypeDef definition

class CancelGremlinQueryOutputTypeDef(TypedDict):
    status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CancelLoaderJobOutputTypeDef#

# CancelLoaderJobOutputTypeDef definition

class CancelLoaderJobOutputTypeDef(TypedDict):
    status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CancelMLDataProcessingJobOutputTypeDef#

# CancelMLDataProcessingJobOutputTypeDef definition

class CancelMLDataProcessingJobOutputTypeDef(TypedDict):
    status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CancelMLModelTrainingJobOutputTypeDef#

# CancelMLModelTrainingJobOutputTypeDef definition

class CancelMLModelTrainingJobOutputTypeDef(TypedDict):
    status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CancelMLModelTransformJobOutputTypeDef#

# CancelMLModelTransformJobOutputTypeDef definition

class CancelMLModelTransformJobOutputTypeDef(TypedDict):
    status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CancelOpenCypherQueryOutputTypeDef#

# CancelOpenCypherQueryOutputTypeDef definition

class CancelOpenCypherQueryOutputTypeDef(TypedDict):
    status: str,
    payload: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateMLEndpointOutputTypeDef#

# CreateMLEndpointOutputTypeDef definition

class CreateMLEndpointOutputTypeDef(TypedDict):
    id: str,
    arn: str,
    creationTimeInMillis: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteMLEndpointOutputTypeDef#

# DeleteMLEndpointOutputTypeDef definition

class DeleteMLEndpointOutputTypeDef(TypedDict):
    status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ExecuteGremlinExplainQueryOutputTypeDef#

# ExecuteGremlinExplainQueryOutputTypeDef definition

class ExecuteGremlinExplainQueryOutputTypeDef(TypedDict):
    output: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ExecuteGremlinProfileQueryOutputTypeDef#

# ExecuteGremlinProfileQueryOutputTypeDef definition

class ExecuteGremlinProfileQueryOutputTypeDef(TypedDict):
    output: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ExecuteOpenCypherExplainQueryOutputTypeDef#

# ExecuteOpenCypherExplainQueryOutputTypeDef definition

class ExecuteOpenCypherExplainQueryOutputTypeDef(TypedDict):
    results: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ExecuteOpenCypherQueryOutputTypeDef#

# ExecuteOpenCypherQueryOutputTypeDef definition

class ExecuteOpenCypherQueryOutputTypeDef(TypedDict):
    results: dict[str, Any],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetLoaderJobStatusOutputTypeDef#

# GetLoaderJobStatusOutputTypeDef definition

class GetLoaderJobStatusOutputTypeDef(TypedDict):
    status: str,
    payload: dict[str, Any],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListMLDataProcessingJobsOutputTypeDef#

# ListMLDataProcessingJobsOutputTypeDef definition

class ListMLDataProcessingJobsOutputTypeDef(TypedDict):
    ids: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListMLEndpointsOutputTypeDef#

# ListMLEndpointsOutputTypeDef definition

class ListMLEndpointsOutputTypeDef(TypedDict):
    ids: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListMLModelTrainingJobsOutputTypeDef#

# ListMLModelTrainingJobsOutputTypeDef definition

class ListMLModelTrainingJobsOutputTypeDef(TypedDict):
    ids: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListMLModelTransformJobsOutputTypeDef#

# ListMLModelTransformJobsOutputTypeDef definition

class ListMLModelTransformJobsOutputTypeDef(TypedDict):
    ids: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartLoaderJobOutputTypeDef#

# StartLoaderJobOutputTypeDef definition

class StartLoaderJobOutputTypeDef(TypedDict):
    status: str,
    payload: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartMLDataProcessingJobOutputTypeDef#

# StartMLDataProcessingJobOutputTypeDef definition

class StartMLDataProcessingJobOutputTypeDef(TypedDict):
    id: str,
    arn: str,
    creationTimeInMillis: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartMLModelTrainingJobOutputTypeDef#

# StartMLModelTrainingJobOutputTypeDef definition

class StartMLModelTrainingJobOutputTypeDef(TypedDict):
    id: str,
    arn: str,
    creationTimeInMillis: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartMLModelTransformJobOutputTypeDef#

# StartMLModelTransformJobOutputTypeDef definition

class StartMLModelTransformJobOutputTypeDef(TypedDict):
    id: str,
    arn: str,
    creationTimeInMillis: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartMLModelTrainingJobInputRequestTypeDef#

# StartMLModelTrainingJobInputRequestTypeDef definition

class StartMLModelTrainingJobInputRequestTypeDef(TypedDict):
    dataProcessingJobId: str,
    trainModelS3Location: str,
    id: NotRequired[str],
    previousModelTrainingJobId: NotRequired[str],
    sagemakerIamRoleArn: NotRequired[str],
    neptuneIamRoleArn: NotRequired[str],
    baseProcessingInstanceType: NotRequired[str],
    trainingInstanceType: NotRequired[str],
    trainingInstanceVolumeSizeInGB: NotRequired[int],
    trainingTimeOutInSeconds: NotRequired[int],
    maxHPONumberOfTrainingJobs: NotRequired[int],
    maxHPOParallelTrainingJobs: NotRequired[int],
    subnets: NotRequired[Sequence[str]],
    securityGroupIds: NotRequired[Sequence[str]],
    volumeEncryptionKMSKey: NotRequired[str],
    s3OutputEncryptionKMSKey: NotRequired[str],
    enableManagedSpotTraining: NotRequired[bool],
    customModelTrainingParameters: NotRequired[CustomModelTrainingParametersTypeDef],  # (1)
  1. See CustomModelTrainingParametersTypeDef

StartMLModelTransformJobInputRequestTypeDef#

# StartMLModelTransformJobInputRequestTypeDef definition

class StartMLModelTransformJobInputRequestTypeDef(TypedDict):
    modelTransformOutputS3Location: str,
    id: NotRequired[str],
    dataProcessingJobId: NotRequired[str],
    mlModelTrainingJobId: NotRequired[str],
    trainingJobName: NotRequired[str],
    sagemakerIamRoleArn: NotRequired[str],
    neptuneIamRoleArn: NotRequired[str],
    customModelTransformParameters: NotRequired[CustomModelTransformParametersTypeDef],  # (1)
    baseProcessingInstanceType: NotRequired[str],
    baseProcessingInstanceVolumeSizeInGB: NotRequired[int],
    subnets: NotRequired[Sequence[str]],
    securityGroupIds: NotRequired[Sequence[str]],
    volumeEncryptionKMSKey: NotRequired[str],
    s3OutputEncryptionKMSKey: NotRequired[str],
  1. See CustomModelTransformParametersTypeDef

DeletePropertygraphStatisticsOutputTypeDef#

# DeletePropertygraphStatisticsOutputTypeDef definition

class DeletePropertygraphStatisticsOutputTypeDef(TypedDict):
    statusCode: int,
    status: str,
    payload: DeleteStatisticsValueMapTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeleteStatisticsValueMapTypeDef
  2. See ResponseMetadataTypeDef

DeleteSparqlStatisticsOutputTypeDef#

# DeleteSparqlStatisticsOutputTypeDef definition

class DeleteSparqlStatisticsOutputTypeDef(TypedDict):
    statusCode: int,
    status: str,
    payload: DeleteStatisticsValueMapTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeleteStatisticsValueMapTypeDef
  2. See ResponseMetadataTypeDef

ExecuteFastResetOutputTypeDef#

# ExecuteFastResetOutputTypeDef definition

class ExecuteFastResetOutputTypeDef(TypedDict):
    status: str,
    payload: FastResetTokenTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FastResetTokenTypeDef
  2. See ResponseMetadataTypeDef

ExecuteGremlinQueryOutputTypeDef#

# ExecuteGremlinQueryOutputTypeDef definition

class ExecuteGremlinQueryOutputTypeDef(TypedDict):
    requestId: str,
    status: GremlinQueryStatusAttributesTypeDef,  # (1)
    result: dict[str, Any],
    meta: dict[str, Any],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GremlinQueryStatusAttributesTypeDef
  2. See ResponseMetadataTypeDef

GetEngineStatusOutputTypeDef#

# GetEngineStatusOutputTypeDef definition

class GetEngineStatusOutputTypeDef(TypedDict):
    status: str,
    startTime: str,
    dbEngineVersion: str,
    role: str,
    dfeQueryEngine: str,
    gremlin: QueryLanguageVersionTypeDef,  # (1)
    sparql: QueryLanguageVersionTypeDef,  # (1)
    opencypher: QueryLanguageVersionTypeDef,  # (1)
    labMode: dict[str, str],
    rollingBackTrxCount: int,
    rollingBackTrxEarliestStartTime: str,
    features: dict[str, dict[str, Any]],
    settings: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See QueryLanguageVersionTypeDef
  2. See QueryLanguageVersionTypeDef
  3. See QueryLanguageVersionTypeDef
  4. See ResponseMetadataTypeDef

GetGremlinQueryStatusOutputTypeDef#

# GetGremlinQueryStatusOutputTypeDef definition

class GetGremlinQueryStatusOutputTypeDef(TypedDict):
    queryId: str,
    queryString: str,
    queryEvalStats: QueryEvalStatsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QueryEvalStatsTypeDef
  2. See ResponseMetadataTypeDef

GetOpenCypherQueryStatusOutputTypeDef#

# GetOpenCypherQueryStatusOutputTypeDef definition

class GetOpenCypherQueryStatusOutputTypeDef(TypedDict):
    queryId: str,
    queryString: str,
    queryEvalStats: QueryEvalStatsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QueryEvalStatsTypeDef
  2. See ResponseMetadataTypeDef

GremlinQueryStatusTypeDef#

# GremlinQueryStatusTypeDef definition

class GremlinQueryStatusTypeDef(TypedDict):
    queryId: NotRequired[str],
    queryString: NotRequired[str],
    queryEvalStats: NotRequired[QueryEvalStatsTypeDef],  # (1)
  1. See QueryEvalStatsTypeDef

GetMLDataProcessingJobOutputTypeDef#

# GetMLDataProcessingJobOutputTypeDef definition

class GetMLDataProcessingJobOutputTypeDef(TypedDict):
    status: str,
    id: str,
    processingJob: MlResourceDefinitionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MlResourceDefinitionTypeDef
  2. See ResponseMetadataTypeDef

GetMLEndpointOutputTypeDef#

# GetMLEndpointOutputTypeDef definition

class GetMLEndpointOutputTypeDef(TypedDict):
    status: str,
    id: str,
    endpoint: MlResourceDefinitionTypeDef,  # (1)
    endpointConfig: MlConfigDefinitionTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See MlResourceDefinitionTypeDef
  2. See MlConfigDefinitionTypeDef
  3. See ResponseMetadataTypeDef

GetMLModelTrainingJobOutputTypeDef#

# GetMLModelTrainingJobOutputTypeDef definition

class GetMLModelTrainingJobOutputTypeDef(TypedDict):
    status: str,
    id: str,
    processingJob: MlResourceDefinitionTypeDef,  # (1)
    hpoJob: MlResourceDefinitionTypeDef,  # (1)
    modelTransformJob: MlResourceDefinitionTypeDef,  # (1)
    mlModels: list[MlConfigDefinitionTypeDef],  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See MlResourceDefinitionTypeDef
  2. See MlResourceDefinitionTypeDef
  3. See MlResourceDefinitionTypeDef
  4. See MlConfigDefinitionTypeDef
  5. See ResponseMetadataTypeDef

GetMLModelTransformJobOutputTypeDef#

# GetMLModelTransformJobOutputTypeDef definition

class GetMLModelTransformJobOutputTypeDef(TypedDict):
    status: str,
    id: str,
    baseProcessingJob: MlResourceDefinitionTypeDef,  # (1)
    remoteModelTransformJob: MlResourceDefinitionTypeDef,  # (1)
    models: list[MlConfigDefinitionTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See MlResourceDefinitionTypeDef
  2. See MlResourceDefinitionTypeDef
  3. See MlConfigDefinitionTypeDef
  4. See ResponseMetadataTypeDef

ListLoaderJobsOutputTypeDef#

# ListLoaderJobsOutputTypeDef definition

class ListLoaderJobsOutputTypeDef(TypedDict):
    status: str,
    payload: LoaderIdResultTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LoaderIdResultTypeDef
  2. See ResponseMetadataTypeDef

ManagePropertygraphStatisticsOutputTypeDef#

# ManagePropertygraphStatisticsOutputTypeDef definition

class ManagePropertygraphStatisticsOutputTypeDef(TypedDict):
    status: str,
    payload: RefreshStatisticsIdMapTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RefreshStatisticsIdMapTypeDef
  2. See ResponseMetadataTypeDef

ManageSparqlStatisticsOutputTypeDef#

# ManageSparqlStatisticsOutputTypeDef definition

class ManageSparqlStatisticsOutputTypeDef(TypedDict):
    status: str,
    payload: RefreshStatisticsIdMapTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RefreshStatisticsIdMapTypeDef
  2. See ResponseMetadataTypeDef

PropertygraphSummaryTypeDef#

# PropertygraphSummaryTypeDef definition

class PropertygraphSummaryTypeDef(TypedDict):
    numNodes: NotRequired[int],
    numEdges: NotRequired[int],
    numNodeLabels: NotRequired[int],
    numEdgeLabels: NotRequired[int],
    nodeLabels: NotRequired[list[str]],
    edgeLabels: NotRequired[list[str]],
    numNodeProperties: NotRequired[int],
    numEdgeProperties: NotRequired[int],
    nodeProperties: NotRequired[list[dict[str, int]]],
    edgeProperties: NotRequired[list[dict[str, int]]],
    totalNodePropertyValues: NotRequired[int],
    totalEdgePropertyValues: NotRequired[int],
    nodeStructures: NotRequired[list[NodeStructureTypeDef]],  # (1)
    edgeStructures: NotRequired[list[EdgeStructureTypeDef]],  # (2)
  1. See NodeStructureTypeDef
  2. See EdgeStructureTypeDef

PropertygraphRecordTypeDef#

# PropertygraphRecordTypeDef definition

class PropertygraphRecordTypeDef(TypedDict):
    commitTimestampInMillis: int,
    eventId: dict[str, str],
    data: PropertygraphDataTypeDef,  # (1)
    op: str,
    isLastOp: NotRequired[bool],
  1. See PropertygraphDataTypeDef

RDFGraphSummaryTypeDef#

# RDFGraphSummaryTypeDef definition

class RDFGraphSummaryTypeDef(TypedDict):
    numDistinctSubjects: NotRequired[int],
    numDistinctPredicates: NotRequired[int],
    numQuads: NotRequired[int],
    numClasses: NotRequired[int],
    classes: NotRequired[list[str]],
    predicates: NotRequired[list[dict[str, int]]],
    subjectStructures: NotRequired[list[SubjectStructureTypeDef]],  # (1)
  1. See SubjectStructureTypeDef

SparqlRecordTypeDef#

# SparqlRecordTypeDef definition

class SparqlRecordTypeDef(TypedDict):
    commitTimestampInMillis: int,
    eventId: dict[str, str],
    data: SparqlDataTypeDef,  # (1)
    op: str,
    isLastOp: NotRequired[bool],
  1. See SparqlDataTypeDef

StatisticsTypeDef#

# StatisticsTypeDef definition

class StatisticsTypeDef(TypedDict):
    autoCompute: NotRequired[bool],
    active: NotRequired[bool],
    statisticsId: NotRequired[str],
    date: NotRequired[datetime],
    note: NotRequired[str],
    signatureInfo: NotRequired[StatisticsSummaryTypeDef],  # (1)
  1. See StatisticsSummaryTypeDef

ListGremlinQueriesOutputTypeDef#

# ListGremlinQueriesOutputTypeDef definition

class ListGremlinQueriesOutputTypeDef(TypedDict):
    acceptedQueryCount: int,
    runningQueryCount: int,
    queries: list[GremlinQueryStatusTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GremlinQueryStatusTypeDef
  2. See ResponseMetadataTypeDef

ListOpenCypherQueriesOutputTypeDef#

# ListOpenCypherQueriesOutputTypeDef definition

class ListOpenCypherQueriesOutputTypeDef(TypedDict):
    acceptedQueryCount: int,
    runningQueryCount: int,
    queries: list[GremlinQueryStatusTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GremlinQueryStatusTypeDef
  2. See ResponseMetadataTypeDef

PropertygraphSummaryValueMapTypeDef#

# PropertygraphSummaryValueMapTypeDef definition

class PropertygraphSummaryValueMapTypeDef(TypedDict):
    version: NotRequired[str],
    lastStatisticsComputationTime: NotRequired[datetime],
    graphSummary: NotRequired[PropertygraphSummaryTypeDef],  # (1)
  1. See PropertygraphSummaryTypeDef

GetPropertygraphStreamOutputTypeDef#

# GetPropertygraphStreamOutputTypeDef definition

class GetPropertygraphStreamOutputTypeDef(TypedDict):
    lastEventId: dict[str, str],
    lastTrxTimestampInMillis: int,
    format: str,
    records: list[PropertygraphRecordTypeDef],  # (1)
    totalRecords: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PropertygraphRecordTypeDef
  2. See ResponseMetadataTypeDef

RDFGraphSummaryValueMapTypeDef#

# RDFGraphSummaryValueMapTypeDef definition

class RDFGraphSummaryValueMapTypeDef(TypedDict):
    version: NotRequired[str],
    lastStatisticsComputationTime: NotRequired[datetime],
    graphSummary: NotRequired[RDFGraphSummaryTypeDef],  # (1)
  1. See RDFGraphSummaryTypeDef

GetSparqlStreamOutputTypeDef#

# GetSparqlStreamOutputTypeDef definition

class GetSparqlStreamOutputTypeDef(TypedDict):
    lastEventId: dict[str, str],
    lastTrxTimestampInMillis: int,
    format: str,
    records: list[SparqlRecordTypeDef],  # (1)
    totalRecords: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SparqlRecordTypeDef
  2. See ResponseMetadataTypeDef

GetPropertygraphStatisticsOutputTypeDef#

# GetPropertygraphStatisticsOutputTypeDef definition

class GetPropertygraphStatisticsOutputTypeDef(TypedDict):
    status: str,
    payload: StatisticsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StatisticsTypeDef
  2. See ResponseMetadataTypeDef

GetSparqlStatisticsOutputTypeDef#

# GetSparqlStatisticsOutputTypeDef definition

class GetSparqlStatisticsOutputTypeDef(TypedDict):
    status: str,
    payload: StatisticsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StatisticsTypeDef
  2. See ResponseMetadataTypeDef

GetPropertygraphSummaryOutputTypeDef#

# GetPropertygraphSummaryOutputTypeDef definition

class GetPropertygraphSummaryOutputTypeDef(TypedDict):
    statusCode: int,
    payload: PropertygraphSummaryValueMapTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PropertygraphSummaryValueMapTypeDef
  2. See ResponseMetadataTypeDef

GetRDFGraphSummaryOutputTypeDef#

# GetRDFGraphSummaryOutputTypeDef definition

class GetRDFGraphSummaryOutputTypeDef(TypedDict):
    statusCode: int,
    payload: RDFGraphSummaryValueMapTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RDFGraphSummaryValueMapTypeDef
  2. See ResponseMetadataTypeDef