Guides

NEPTUNE-GRAPH

docs.aws.amazon.com
AWS documentation

CancelExportTask

valid {
    input.ReqMap.taskIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

CancelImportTask

valid {
    input.ReqMap.taskIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

CancelQuery

valid {
    input.ReqMap.queryId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

CreateGraph

valid {
    input.Body.graphName == STRING
    input.Body.tags.STRING == STRING
    input.Body.publicConnectivity == BOOLEAN
    input.Body.kmsKeyIdentifier == STRING
    input.Body.vectorSearchConfiguration.dimension == INTEGER
    input.Body.replicaCount == INTEGER
    input.Body.deletionProtection == BOOLEAN
    input.Body.provisionedMemory == INTEGER
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

CreateGraphSnapshot

valid {
    input.Body.graphIdentifier == STRING
    input.Body.snapshotName == STRING
    input.Body.tags.STRING == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

CreateGraphUsingImportTask

enum_BlankNodeHandling := [ "convertToIri" ]
enum_Format := [ "CSV", "OPEN_CYPHER", "PARQUET", "NTRIPLES" ]
enum_ParquetType := [ "COLUMNAR" ]

valid {
    input.Body.graphName == STRING
    input.Body.tags.STRING == STRING
    input.Body.publicConnectivity == BOOLEAN
    input.Body.kmsKeyIdentifier == STRING
    input.Body.vectorSearchConfiguration.dimension == INTEGER
    input.Body.replicaCount == INTEGER
    input.Body.deletionProtection == BOOLEAN
    input.Body.importOptions.neptune.s3ExportPath == STRING
    input.Body.importOptions.neptune.s3ExportKmsKeyId == STRING
    input.Body.importOptions.neptune.preserveDefaultVertexLabels == BOOLEAN
    input.Body.importOptions.neptune.preserveEdgeIds == BOOLEAN
    input.Body.maxProvisionedMemory == INTEGER
    input.Body.minProvisionedMemory == INTEGER
    input.Body.failOnError == BOOLEAN
    input.Body.source == STRING
    input.Body.format == enum_Format[_]
    input.Body.parquetType == enum_ParquetType[_]
    input.Body.blankNodeHandling == enum_BlankNodeHandling[_]
    input.Body.roleArn == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

CreatePrivateGraphEndpoint

valid {
    input.Body.vpcId == STRING
    input.Body.subnetIds[_] == STRING
    input.Body.vpcSecurityGroupIds[_] == STRING
    input.ReqMap.graphIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

DeleteGraph

valid {
    input.ReqMap.graphIdentifier == STRING
    input.Qs.skipSnapshot == BOOLEAN
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

DeleteGraphSnapshot

valid {
    input.ReqMap.snapshotIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

DeletePrivateGraphEndpoint

valid {
    input.ReqMap.graphIdentifier == STRING
    input.ReqMap.vpcId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

ExecuteQuery

enum_ExplainMode := [ "STATIC", "DETAILS" ]
enum_PlanCacheType := [ "ENABLED", "DISABLED", "AUTO" ]
enum_QueryLanguage := [ "OPEN_CYPHER" ]

valid {
    input.Body.query == STRING
    input.Body.language == enum_QueryLanguage[_]
    input.Body.parameters.STRING == {}
    input.Body.planCache == enum_PlanCacheType[_]
    input.Body.explain == enum_ExplainMode[_]
    input.Body.queryTimeoutMilliseconds == INTEGER
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetExportTask

valid {
    input.ReqMap.taskIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetGraph

valid {
    input.ReqMap.graphIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetGraphSnapshot

valid {
    input.ReqMap.snapshotIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetGraphSummary

enum_GraphSummaryMode := [ "BASIC", "DETAILED" ]

valid {
    input.Qs.mode == enum_GraphSummaryMode[_]
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetImportTask

valid {
    input.ReqMap.taskIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetPrivateGraphEndpoint

valid {
    input.ReqMap.graphIdentifier == STRING
    input.ReqMap.vpcId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetQuery

valid {
    input.ReqMap.queryId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

ListExportTasks

valid {
    input.Qs.graphIdentifier == STRING
    input.Qs.nextToken == STRING
    input.Qs.maxResults == INTEGER
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

ListGraphSnapshots

valid {
    input.Qs.graphIdentifier == STRING
    input.Qs.nextToken == STRING
    input.Qs.maxResults == INTEGER
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

ListGraphs

valid {
    input.Qs.nextToken == STRING
    input.Qs.maxResults == INTEGER
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

ListImportTasks

valid {
    input.Qs.nextToken == STRING
    input.Qs.maxResults == INTEGER
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

ListPrivateGraphEndpoints

valid {
    input.ReqMap.graphIdentifier == STRING
    input.Qs.nextToken == STRING
    input.Qs.maxResults == INTEGER
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

ListQueries

enum_QueryStateInput := [ "ALL", "RUNNING", "WAITING", "CANCELLING" ]

valid {
    input.Qs.maxResults == INTEGER
    input.Qs.state == enum_QueryStateInput[_]
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

ListTagsForResource

valid {
    input.ReqMap.resourceArn == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

ResetGraph

valid {
    input.Body.skipSnapshot == BOOLEAN
    input.ReqMap.graphIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

RestoreGraphFromSnapshot

valid {
    input.Body.graphName == STRING
    input.Body.provisionedMemory == INTEGER
    input.Body.deletionProtection == BOOLEAN
    input.Body.tags.STRING == STRING
    input.Body.replicaCount == INTEGER
    input.Body.publicConnectivity == BOOLEAN
    input.ReqMap.snapshotIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

StartExportTask

enum_ExportFormat := [ "PARQUET", "CSV" ]
enum_MultiValueHandlingType := [ "TO_LIST", "PICK_FIRST" ]
enum_ParquetType := [ "COLUMNAR" ]

valid {
    input.Body.graphIdentifier == STRING
    input.Body.roleArn == STRING
    input.Body.format == enum_ExportFormat[_]
    input.Body.destination == STRING
    input.Body.kmsKeyIdentifier == STRING
    input.Body.parquetType == enum_ParquetType[_]
    input.Body.exportFilter.vertexFilter.STRING.properties.STRING.outputType == STRING
    input.Body.exportFilter.vertexFilter.STRING.properties.STRING.sourcePropertyName == STRING
    input.Body.exportFilter.vertexFilter.STRING.properties.STRING.multiValueHandling == enum_MultiValueHandlingType[_]
    input.Body.exportFilter.edgeFilter.STRING.properties.STRING.outputType == STRING
    input.Body.exportFilter.edgeFilter.STRING.properties.STRING.sourcePropertyName == STRING
    input.Body.exportFilter.edgeFilter.STRING.properties.STRING.multiValueHandling == enum_MultiValueHandlingType[_]
    input.Body.tags.STRING == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

StartGraph

valid {
    input.ReqMap.graphIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

StartImportTask

enum_BlankNodeHandling := [ "convertToIri" ]
enum_Format := [ "CSV", "OPEN_CYPHER", "PARQUET", "NTRIPLES" ]
enum_ParquetType := [ "COLUMNAR" ]

valid {
    input.Body.importOptions.neptune.s3ExportPath == STRING
    input.Body.importOptions.neptune.s3ExportKmsKeyId == STRING
    input.Body.importOptions.neptune.preserveDefaultVertexLabels == BOOLEAN
    input.Body.importOptions.neptune.preserveEdgeIds == BOOLEAN
    input.Body.failOnError == BOOLEAN
    input.Body.source == STRING
    input.Body.format == enum_Format[_]
    input.Body.parquetType == enum_ParquetType[_]
    input.Body.blankNodeHandling == enum_BlankNodeHandling[_]
    input.Body.roleArn == STRING
    input.ReqMap.graphIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

StopGraph

valid {
    input.ReqMap.graphIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

TagResource

valid {
    input.Body.tags.STRING == STRING
    input.ReqMap.resourceArn == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

UntagResource

valid {
    input.ReqMap.resourceArn == STRING
    input.Qs.tagKeys[_] == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

UpdateGraph

valid {
    input.Body.publicConnectivity == BOOLEAN
    input.Body.provisionedMemory == INTEGER
    input.Body.deletionProtection == BOOLEAN
    input.ReqMap.graphIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}