기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
# Amazon Neptune 데이터 API 참조
이 장에서는 Neptune 그래프의 데이터를 로드, 액세스 및 유지 관리하는 데 사용할 수 있는 Neptune 데이터 API 작업에 대해 설명합니다.
Amazon Neptune 데이터 API는 데이터 로드, 쿼리 실행, 데이터 정보 가져오기, 기계 학습 작업 실행을 위한 SDK 지원을 제공합니다. Neptune의 Gremlin 및 openCypher 쿼리 언어를 지원하며 모든 SDK 언어로 사용할 수 있습니다. API 요청에 자동으로 서명하며 Neptune을 애플리케이션에 매우 간편하게 통합할 수 있습니다.
**Contents**
+ [Neptune 데이터플레인 엔진, 빠른 재설정 및 일반 구조 API](data-api-dp-environment-APIs.md)
+ [GetEngineStatus(동작)](data-api-dp-environment-APIs.md#GetEngineStatus)
+ [ExecuteFastReset(동작)](data-api-dp-environment-APIs.md#ExecuteFastReset)
+ [*엔진 작동 구조:*](data-api-dp-environment-APIs.md#data-api-dp-environment-APIs-engine-operation-structures-spacer)
+ [QueryLanguageVersion(구조)](data-api-dp-environment-APIs.md#QueryLanguageVersion)
+ [FastResetToken(구조)](data-api-dp-environment-APIs.md#FastResetToken)
+ [Neptune 쿼리 API](data-api-dp-queries.md)
+ [ExecuteGremlinQuery(동작)](data-api-dp-queries.md#ExecuteGremlinQuery)
+ [ExecuteGremlinExplainQuery(동작)](data-api-dp-queries.md#ExecuteGremlinExplainQuery)
+ [ExecuteGremlinProfileQuery(동작)](data-api-dp-queries.md#ExecuteGremlinProfileQuery)
+ [ListGremlinQueries(동작)](data-api-dp-queries.md#ListGremlinQueries)
+ [GetGremlinQueryStatus(동작)](data-api-dp-queries.md#GetGremlinQueryStatus)
+ [CancelGremlinQuery(동작)](data-api-dp-queries.md#CancelGremlinQuery)
+ [openCypher 쿼리 작업:**](data-api-dp-queries.md#data-api-dp-queries-opencypher-query-actions-spacer)
+ [ExecuteOpenCypherQuery(동작)](data-api-dp-queries.md#ExecuteOpenCypherQuery)
+ [ExecuteOpenCypherExplainQuery(동작)](data-api-dp-queries.md#ExecuteOpenCypherExplainQuery)
+ [ListOpenCypherQueries(동작)](data-api-dp-queries.md#ListOpenCypherQueries)
+ [GetOpenCypherQueryStatus(동작)](data-api-dp-queries.md#GetOpenCypherQueryStatus)
+ [CancelOpenCypherQuery(동작)](data-api-dp-queries.md#CancelOpenCypherQuery)
+ [*쿼리 구조:*](data-api-dp-queries.md#data-api-dp-queries-query-structures-spacer)
+ [QueryEvalStats(구조)](data-api-dp-queries.md#QueryEvalStats)
+ [GremlinQueryStatus(구조)](data-api-dp-queries.md#GremlinQueryStatus)
+ [GremlinQueryStatusAttributes(구조)](data-api-dp-queries.md#GremlinQueryStatusAttributes)
+ [Neptune 데이터 영역 벌크 로더 API](data-api-dp-loader.md)
+ [StartLoaderJob(동작)](data-api-dp-loader.md#StartLoaderJob)
+ [GetLoaderJobStatus(동작)](data-api-dp-loader.md#GetLoaderJobStatus)
+ [ListLoaderJobs(동작)](data-api-dp-loader.md#ListLoaderJobs)
+ [CancelLoaderJob(동작)](data-api-dp-loader.md#CancelLoaderJob)
+ [벌크 로드 구조:**](data-api-dp-loader.md#data-api-dp-loader-bulk-load-structure-spacer)
+ [LoaderIdResult(구조)](data-api-dp-loader.md#LoaderIdResult)
+ [Neptune 스트림 데이터플레인 API](data-api-dp-streams.md)
+ [GetPropertygraphStream(동작)](data-api-dp-streams.md#GetPropertygraphStream)
+ [*스트림 데이터 구조:*](data-api-dp-streams.md#data-api-dp-streams-stream-data-structures-spacer)
+ [PropertygraphRecord(구조)](data-api-dp-streams.md#PropertygraphRecord)
+ [PropertygraphData(구조)](data-api-dp-streams.md#PropertygraphData)
+ [Neptune 데이터플레인 통계 및 그래프 요약 API](data-api-dp-statistics.md)
+ [GetPropertygraphStatistics(동작)](data-api-dp-statistics.md#GetPropertygraphStatistics)
+ [ManagePropertygraphStatistics(동작)](data-api-dp-statistics.md#ManagePropertygraphStatistics)
+ [DeletePropertygraphStatistics(동작)](data-api-dp-statistics.md#DeletePropertygraphStatistics)
+ [GetPropertygraphSummary(동작)](data-api-dp-statistics.md#GetPropertygraphSummary)
+ [*통계 구조:*](data-api-dp-statistics.md#data-api-dp-statistics-statistics-structures-spacer)
+ [Statistics(구조)](data-api-dp-statistics.md#Statistics)
+ [StatisticsSummary(동작)](data-api-dp-statistics.md#StatisticsSummary)
+ [StatisticsSummary(구조)](data-api-dp-statistics.md#DeleteStatisticsValueMap)
+ [RefreshStatisticsIdMap(구조)](data-api-dp-statistics.md#RefreshStatisticsIdMap)
+ [NodeStructure(구조)](data-api-dp-statistics.md#NodeStructure)
+ [NodeStructure(구조)](data-api-dp-statistics.md#EdgeStructure)
+ [SubjectStructure(구조)](data-api-dp-statistics.md#SubjectStructure)
+ [PropertygraphSummaryValueMap(구조)](data-api-dp-statistics.md#PropertygraphSummaryValueMap)
+ [PropertygraphSummary(구조)](data-api-dp-statistics.md#PropertygraphSummary)
+ [Neptune ML 데이터 처리 API](data-api-dp-ml-data-processing.md)
+ [StartMLDataProcessingJob(동작)](data-api-dp-ml-data-processing.md#StartMLDataProcessingJob)
+ [ListMLDataProcessingJobs(작업)](data-api-dp-ml-data-processing.md#ListMLDataProcessingJobs)
+ [GetMLDataProcessingJob(동작)](data-api-dp-ml-data-processing.md#GetMLDataProcessingJob)
+ [CancelMLDataProcessingJob(동작)](data-api-dp-ml-data-processing.md#CancelMLDataProcessingJob)
+ [*ML 범용 구조:*](data-api-dp-ml-data-processing.md#data-api-dp-ml-data-processing-ml-general-purpose-structures-spacer)
+ [MlResourceDefinition(구조)](data-api-dp-ml-data-processing.md#MlResourceDefinition)
+ [MlConfigDefinition(구조)](data-api-dp-ml-data-processing.md#MlConfigDefinition)
+ [Neptune ML 모델 훈련 API](data-api-dp-ml-training.md)
+ [StartMLModelTrainingJob(작업)](data-api-dp-ml-training.md#StartMLModelTrainingJob)
+ [ListMLModelTrainingJobs(작업)](data-api-dp-ml-training.md#ListMLModelTrainingJobs)
+ [GetMLModelTrainingJob(작업)](data-api-dp-ml-training.md#GetMLModelTrainingJob)
+ [CancelMLModelTrainingJob(작업)](data-api-dp-ml-training.md#CancelMLModelTrainingJob)
+ [*모델 훈련 구조:*](data-api-dp-ml-training.md#data-api-dp-ml-training-model-training-structures-spacer)
+ [CustomModelTrainingParameters(구조)](data-api-dp-ml-training.md#CustomModelTrainingParameters)
+ [Neptune ML 모델 변환 API](data-api-dp-ml-transform.md)
+ [StartMLModelTransformJob(작업)](data-api-dp-ml-transform.md#StartMLModelTransformJob)
+ [ListMLModelTransformJobs(작업)](data-api-dp-ml-transform.md#ListMLModelTransformJobs)
+ [GetMLModelTransformJob(작업)](data-api-dp-ml-transform.md#GetMLModelTransformJob)
+ [CancelMLModelTransformJob(작업)](data-api-dp-ml-transform.md#CancelMLModelTransformJob)
+ [*모델 변환 구조:*](data-api-dp-ml-transform.md#data-api-dp-ml-transform-model-transform-structures-spacer)
+ [CustomModelTransformParameters(구조)](data-api-dp-ml-transform.md#CustomModelTransformParameters)
+ [Neptune ML 추론 엔드포인트 API](data-api-dp-inference.md)
+ [CreateMLEndpoint(작업)](data-api-dp-inference.md#CreateMLEndpoint)
+ [ListMLEndpoints(작업)](data-api-dp-inference.md#ListMLEndpoints)
+ [GetMLEndpoint(작업)](data-api-dp-inference.md#GetMLEndpoint)
+ [DeleteMLEndpoint(작업)](data-api-dp-inference.md#DeleteMLEndpoint)
+ [Neptune 데이터 영역 API 예외](data-api-dp-errors.md)
+ [AccessDeniedException(구조)](data-api-dp-errors.md#AccessDeniedException)
+ [BadRequestException(구조)](data-api-dp-errors.md#BadRequestException)
+ [BulkLoadIdNotFoundException(구조)](data-api-dp-errors.md#BulkLoadIdNotFoundException)
+ [CancelledByUserException(구조)](data-api-dp-errors.md#CancelledByUserException)
+ [ClientTimeoutException(구조)](data-api-dp-errors.md#ClientTimeoutException)
+ [ConcurrentModificationException(구조)](data-api-dp-errors.md#ConcurrentModificationException)
+ [ConstraintViolationException(구조)](data-api-dp-errors.md#ConstraintViolationException)
+ [ExpiredStreamException(구조)](data-api-dp-errors.md#ExpiredStreamException)
+ [FailureByQueryException(구조)](data-api-dp-errors.md#FailureByQueryException)
+ [IllegalArgumentException(구조)](data-api-dp-errors.md#IllegalArgumentException)
+ [InternalFailureException(구조)](data-api-dp-errors.md#InternalFailureException)
+ [InvalidArgumentException(구조)](data-api-dp-errors.md#InvalidArgumentException)
+ [InvalidNumericDataException(구조)](data-api-dp-errors.md#InvalidNumericDataException)
+ [InvalidParameterException(구조)](data-api-dp-errors.md#InvalidParameterException)
+ [LoadUrlAccessDeniedException(구조)](data-api-dp-errors.md#LoadUrlAccessDeniedException)
+ [MalformedQueryException(구조)](data-api-dp-errors.md#MalformedQueryException)
+ [MemoryLimitExceededException(구조)](data-api-dp-errors.md#MemoryLimitExceededException)
+ [MethodNotAllowedException(구조)](data-api-dp-errors.md#MethodNotAllowedException)
+ [MissingParameterException(구조)](data-api-dp-errors.md#MissingParameterException)
+ [MLResourceNotFoundException(구조)](data-api-dp-errors.md#MLResourceNotFoundException)
+ [ParsingException(구조)](data-api-dp-errors.md#ParsingException)
+ [PreconditionsFailedException(구조)](data-api-dp-errors.md#PreconditionsFailedException)
+ [QueryLimitExceededException(구조)](data-api-dp-errors.md#QueryLimitExceededException)
+ [QueryLimitException(구조)](data-api-dp-errors.md#QueryLimitException)
+ [QueryTooLargeException(구조)](data-api-dp-errors.md#QueryTooLargeException)
+ [ReadOnlyViolationException(구조)](data-api-dp-errors.md#ReadOnlyViolationException)
+ [S3Exception(구조)](data-api-dp-errors.md#S3Exception)
+ [ServerShutdownException(구조)](data-api-dp-errors.md#ServerShutdownException)
+ [StatisticsNotAvailableException(구조)](data-api-dp-errors.md#StatisticsNotAvailableException)
+ [StreamRecordsNotFoundException(구조)](data-api-dp-errors.md#StreamRecordsNotFoundException)
+ [ThrottlingException(구조)](data-api-dp-errors.md#ThrottlingException)
+ [TimeLimitExceededException(구조)](data-api-dp-errors.md#TimeLimitExceededException)
+ [TooManyRequestsException(구조)](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException(구조)](data-api-dp-errors.md#UnsupportedOperationException)
+ [UnloadUrlAccessDeniedException(구조)](data-api-dp-errors.md#UnloadUrlAccessDeniedException)
# Neptune 데이터플레인 엔진, 빠른 재설정 및 일반 구조 API
**엔진 작동:**
+ [GetEngineStatus(동작)](#GetEngineStatus)
+ [ExecuteFastReset(동작)](#ExecuteFastReset)
**엔진 작동 구조:**
+ [QueryLanguageVersion(구조)](#QueryLanguageVersion)
+ [FastResetToken(구조)](#FastResetToken)
## GetEngineStatus(동작)
이 API의 AWS CLI 이름은 `get-engine-status`입니다.
호스트의 그래프 데이터베이스 상태를 검색합니다.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:GetEngineStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getenginestatus) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ 요청 파라미터가 없습니다.**
**응답**:
+ **dbEngineVersion** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
DB 클러스터에서 실행되는 Neptune 엔진 버전으로 설정합니다. 이 엔진 버전이 릴리스된 이후 수동으로 패치 적용된 경우 버전 번호에 `Patch-` 접두사가 붙습니다.
+ **dfeQueryEngine** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
DFE 엔진이 완전히 활성화된 경우 `enabled`로 설정하거나, `useDFE` 쿼리 힌트가 `true`로 설정된 쿼리에만 DFE 엔진을 사용하는 경우 `viaQueryHint`(기본값)로 설정합니다.
+ **features** – 다음에 해당할 때 키-값 페어의 맵 배열입니다.
각 키는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
각 값은 `document`(JSON과 유사한 데이터 모델로 표현되는 프로토콜에 구애받지 않는 개방형 콘텐츠) 유형의 문서입니다.
DB 클러스터에서 활성화된 기능에 대한 상태 정보가 들어 있습니다.
+ **gremlin** – [QueryLanguageVersion](#QueryLanguageVersion) 객체입니다.
클러스터에서 사용할 수 있는 Gremlin 쿼리 언어에 대한 정보가 들어 있습니다. 특히 엔진에서 사용하는 현재 TinkerPop 버전을 지정하는 버전 필드가 포함되어 있습니다.
+ **labMode** – 다음에 해당할 때 키-값 페어의 맵 배열입니다.
각 키는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
각 값은 String이며, 유형은`string` (UTF-8 인코딩 문자열)입니다.
엔진에서 사용 중인 랩 모드 설정을 포함합니다.
+ **opencypher** – [QueryLanguageVersion](#QueryLanguageVersion) 객체입니다.
클러스터에서 사용할 수 있는 openCypher 쿼리 언어에 대한 정보가 들어 있습니다. 특히 엔진에서 사용하는 현재 openCypher 버전을 지정하는 버전 필드가 포함되어 있습니다.
+ **role** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
인스턴스가 읽기 전용 복제본인 경우 `reader`로 설정하고 인스턴스가 기본 인스턴스인 경우 `writer`로 설정합니다.
+ **rollingBackTrxCount** - Integer이며, 유형은 `integer`(32비트 부호 있는 정수)입니다.
롤백되는 트랜잭션이 있는 경우 이 필드는 해당 트랜잭션 수로 설정됩니다. 없으면 필드가 나타나지 않습니다.
+ **rollingBackTrxEarliestStartTime** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
롤백되고 있는 트랜잭션 중 최초 트랜잭션의 시작 시간으로 설정합니다. 트랜잭션이 롤백되지 않으면 필드가 나타나지 않습니다.
+ **settings** – 다음에 해당할 때 키-값 페어의 맵 배열입니다.
각 키는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
각 값은 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
DB 클러스터의 현재 설정에 대한 정보를 포함합니다. 예를 들어, 현재 클러스터 쿼리 제한 시간 설정(`clusterQueryTimeoutInMs`)을 포함합니다.
+ **sparql** – [QueryLanguageVersion](#QueryLanguageVersion) 객체입니다.
클러스터에서 사용할 수 있는 SPARQL 쿼리 언어에 대한 정보가 들어 있습니다. 특히 엔진에서 사용하는 현재 SPARQL 버전을 지정하는 버전 필드가 포함되어 있습니다.
+ **startTime** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
현재 서버 프로세스가 시작한 UTC 시간으로 설정합니다.
+ **status** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
인스턴스에 문제가 발생하지 않는 경우 `healthy`로 설정합니다. 인스턴스가 충돌로부터 복구 중이거나 재부팅 중이며 최근 서버 중단으로부터 실행 중인 활성 트랜잭션이 있으면 상태가 `recovery`로 설정됩니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [InternalFailureException](data-api-dp-errors.md#InternalFailureException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## ExecuteFastReset(동작)
이 API의 AWS CLI 이름은 `execute-fast-reset`입니다.
빠른 재설정 REST API를 사용하면 Neptune 그래프를 빠르고 쉽게 재설정하여 모든 데이터를 제거할 수 있습니다.
Neptune 빠른 재설정은 두 단계로 이루어져 있습니다. 먼저 `action`을 통해 `ExecuteFastReset`을 `initiateDatabaseReset`으로 설정하여 호출합니다. 그러면 UUID 토큰이 반환되며, 이 토큰은 `performDatabaseReset`으로 설정된 `action`을 통해 `ExecuteFastReset`을 다시 호출할 때 포함시킵니다. [빠른 재설정 API를 사용하여 Amazon Neptune DB 클러스터 비우기](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-fast-reset.html)를 참조하세요.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:ResetDatabase](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#resetdatabase) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **action**(CLI의 경우: `--action`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
빠른 재설정 작업입니다. 다음 값 중 하나입니다.
+ **`initiateDatabaseReset`** - 이 작업은 빠른 재설정을 실제로 수행하는 데 필요한 고유한 토큰을 생성합니다.
+ **`performDatabaseReset`** - 이 작업은 `initiateDatabaseReset` 작업으로 생성된 토큰을 사용하여 실제로 빠른 리셋을 수행합니다.
+ **token**(CLI의 경우: `--token`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
재설정을 시작하기 위한 빠른 재설정 토큰입니다.
**응답**:
+ **payload** – [FastResetToken](#FastResetToken) 객체입니다.
`payload`는 `initiateDatabaseReset` 작업에 의해서만 반환되며, 재설정을 수행하기 위해 `performDatabaseReset` 작업에 사용할 고유 토큰을 포함합니다.
+ **status** - 필수: String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
`status`는 `performDatabaseReset` 작업에 대해서만 반환되며 빠른 재설정 요청의 수락 여부를 나타냅니다.
**오류**
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [ServerShutdownException](data-api-dp-errors.md#ServerShutdownException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MethodNotAllowedException](data-api-dp-errors.md#MethodNotAllowedException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
## *엔진 작동 구조:*
## QueryLanguageVersion(구조)
쿼리 언어 버전을 표현하기 위한 구조입니다.
**Fields**
+ **version** - 필수: String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
쿼리 언어의 버전입니다.
## FastResetToken(구조)
빠른 재설정을 시작하는 데 사용되는 빠른 재설정 토큰을 포함하는 구조입니다.
**Fields**
+ **token** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
`initiateDatabaseReset` 작업 시 데이터베이스에서 생성한 UUID로, `performDatabaseReset`에서 데이터베이스를 재설정하는 데 사용합니다.
# Neptune 쿼리 API
**Gremlin 쿼리 작업:**
+ [ExecuteGremlinQuery(동작)](#ExecuteGremlinQuery)
+ [ExecuteGremlinExplainQuery(동작)](#ExecuteGremlinExplainQuery)
+ [ExecuteGremlinProfileQuery(동작)](#ExecuteGremlinProfileQuery)
+ [ListGremlinQueries(동작)](#ListGremlinQueries)
+ [GetGremlinQueryStatus(동작)](#GetGremlinQueryStatus)
+ [CancelGremlinQuery(동작)](#CancelGremlinQuery)
**openCypher 쿼리 작업:**
+ [ExecuteOpenCypherQuery(동작)](#ExecuteOpenCypherQuery)
+ [ExecuteOpenCypherExplainQuery(동작)](#ExecuteOpenCypherExplainQuery)
+ [ListOpenCypherQueries(동작)](#ListOpenCypherQueries)
+ [GetOpenCypherQueryStatus(동작)](#GetOpenCypherQueryStatus)
+ [CancelOpenCypherQuery(동작)](#CancelOpenCypherQuery)
**쿼리 구조:**
+ [QueryEvalStats(구조)](#QueryEvalStats)
+ [GremlinQueryStatus(구조)](#GremlinQueryStatus)
+ [GremlinQueryStatusAttributes(구조)](#GremlinQueryStatusAttributes)
## ExecuteGremlinQuery(동작)
이 API의 AWS CLI 이름은 `execute-gremlin-query`입니다.
이 명령은 Gremlin 쿼리를 실행합니다. Amazon Neptune은 Apache TinkerPop3 및 Gremlin과 호환되므로 Apache TinkerPop3 설명서의 그래프에 설명된 대로 Gremlin 순회 언어를 사용하여 [그래프](https://tinkerpop.apache.org/docs/current/reference/#graph)를 쿼리할 수 있습니다. [Gremlin을 사용하여 Neptune 그래프에 액세스하기](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin.html)에서도 자세한 내용을 확인할 수 있습니다.
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할은 쿼리에 따라 해당 클러스터에서 다음 IAM 작업 중 하나를 활성화하는 정책을 연결해야 합니다.
+ [Neptune-DB: ReadDataViQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery)
+ [neptune-db:WriteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery)
+ [neptune-db:DeleteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery)
참고로 정책 문서에서는 [neptune-db:QueryLanguage:Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM 조건 키를 사용하여 Gremlin 쿼리의 사용을 제한할 수 있습니다([Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) 참조).
**요청**
+ **gremlinQuery**(CLI의 경우: `--gremlin-query`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
이 API를 사용하면 HTTP 엔드포인트를 사용할 때와 마찬가지로 문자열 형식으로 Gremlin 쿼리를 실행할 수 있습니다. 인터페이스는 DB 클러스터가 사용하는 모든 Gremlin 버전과 호환됩니다(엔진 버전에서 지원하는 Gremlin 릴리스를 확인하려면 [Tinkerpop 클라이언트 섹션](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-client.html#best-practices-gremlin-java-latest) 참조).
+ **serializer**(CLI의 경우: `--serializer`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
null이 아니면 쿼리 결과가 직렬화된 응답 메시지에서 이 파라미터가 지정한 형식으로 반환됩니다. 현재 지원되는 형식 목록은 TinkerPop 문서의 [GraphSon](https://tinkerpop.apache.org/docs/current/reference/#_graphson) 섹션을 참조하세요.
**응답**:
+ **meta** – Document, 유형은 `document`(JSON과 유사한 데이터 모델로 표현되는 프로토콜에 구애받지 않는 개방형 콘텐츠)입니다.
Gremlin 쿼리에 대한 메타데이터입니다.
+ **requestId** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
Gremlin 쿼리의 고유 식별자입니다.
+ **result** – Document, 유형은 `document`(JSON과 유사한 데이터 모델로 표현되는 프로토콜에 구애받지 않는 개방형 콘텐츠)입니다.
서버에서 출력되는 Gremlin 쿼리입니다.
+ **status** – [GremlinQueryStatusAttributes](#GremlinQueryStatusAttributes) 객체입니다.
Gremlin 쿼리의 상태입니다.
**오류**
+ [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [QueryLimitException](data-api-dp-errors.md#QueryLimitException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## ExecuteGremlinExplainQuery(동작)
이 API의 AWS CLI 이름은 `execute-gremlin-explain-query`입니다.
Gremlin Explain 쿼리를 실행합니다.
Amazon Neptune은 Neptune 엔진이 쿼리에 사용하는 실행 방식을 이해하기 위한 셀프 서비스 도구를 제공하는 `explain`이라는 Gremlin 기능을 추가했습니다. Gremlin 쿼리를 제출하는 HTTP 호출에 `explain` 파라미터를 추가하여 이 도구를 호출합니다.
Explain 기능은 쿼리 실행 계획의 논리 구조에 대한 정보를 제공합니다. [Gremlin 쿼리 조정](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html)에 설명된 대로 이 정보를 사용하여 잠재적 평가 및 실행 병목 현상을 식별하고 쿼리를 조정할 수 있습니다. 그런 다음 쿼리 힌트를 사용하여 쿼리 실행 계획을 개선할 수 있습니다.
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할은 쿼리에 따라 해당 클러스터에서 다음 IAM 작업 중 하나를 허용하는 정책을 연결해야 합니다.
+ [Neptune-DB: ReadDataViQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery)
+ [neptune-db:WriteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery)
+ [neptune-db:DeleteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery)
참고로 정책 문서에서는 [neptune-db:QueryLanguage:Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM 조건 키를 사용하여 Gremlin 쿼리의 사용을 제한할 수 있습니다([Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) 참조).
**요청**
+ **gremlinQuery**(CLI의 경우: `--gremlin-query`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
Gremlin Explain 쿼리 문자열입니다.
**응답**:
+ **output** - ReportAsText, 형식은 `blob`(해석되지 않은 바이너리 데이터 블록)입니다.
[Gremlin 쿼리 조정](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html)에 설명된 대로 Gremlin Explain 결과를 포함하는 텍스트 블롭입니다.
**오류**
+ [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [QueryLimitException](data-api-dp-errors.md#QueryLimitException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## ExecuteGremlinProfileQuery(동작)
이 API의 AWS CLI 이름은 `execute-gremlin-profile-query`입니다.
Executes a Gremlin Profile 쿼리는 지정된 Gremlin 순회를 실행하고 해당 실행에 대한 다양한 지표를 수집하여 출력 지표로서 프로파일 보고서를 만듭니다. 자세한 내용은 [Neptune의 Gremlin 프로필 API](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html)를 참조하세요.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:ReadDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
참고로 정책 문서에서는 [neptune-db:QueryLanguage:Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM 조건 키를 사용하여 Gremlin 쿼리의 사용을 제한할 수 있습니다([Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) 참조).
**요청**
+ **chop**(CLI의 경우: `--chop`) - Integer, 유형은 `integer`(32비트 부호 있는 정수)입니다.
0으로 설정되어 있지 않으면 결과 문자열이 해당되는 문자 수에서 잘립니다. 0으로 설정되어 있으면 문자열에 모든 결과가 포함됩니다.
+ **gremlinQuery**(CLI의 경우: `--gremlin-query`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
프로파일링할 Gremlin 쿼리 문자열입니다.
+ **indexOps**(CLI의 경우: `--index-ops`) - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
플래그가 `TRUE`이면 쿼리 실행 및 직렬화 동안 수행된 모든 인덱스 작업에 대한 세부 보고서가 표시됩니다.
+ **results**(CLI의 경우: `--results`) - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
플래그가 `TRUE`이면 프로파일 보고서의 일부로 수집 및 표시됩니다. `FALSE`인 경우에는 결과 수만 표시됩니다.
+ **serializer**(CLI의 경우: `--serializer`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
null이 아니면 수집된 결과가 직렬화된 응답 메시지에서 이 파라미터가 지정한 형식으로 반환됩니다. 자세한 내용은 [Neptune의 Gremlin 프로필 API](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html)를 참조하세요.
**응답**:
+ **output** - ReportAsText, 형식은 `blob`(해석되지 않은 바이너리 데이터 블록)입니다.
Gremlin 프로필 결과를 포함하는 텍스트 블롭입니다. 자세한 내용은 [Neptune의 Gremlin 프로필 API](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html)를 참조하세요.
**오류**
+ [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [QueryLimitException](data-api-dp-errors.md#QueryLimitException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## ListGremlinQueries(동작)
이 API의 AWS CLI 이름은 `list-gremlin-queries`입니다.
활성 Gremlin 쿼리를 나열합니다. 출력에 대한 자세한 내용은 [Gremlin 쿼리 상태 API](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html)를 참조하세요.
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [Neptune-db:GetQueryStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
참고로 정책 문서에서는 [neptune-db:QueryLanguage:Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM 조건 키를 사용하여 Gremlin 쿼리의 사용을 제한할 수 있습니다([Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) 참조).
**요청**
+ **includeWaiting**(CLI의 경우: `--include-waiting`) - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
`TRUE`로 설정하면 반환되는 목록에 대기 중인 쿼리가 포함됩니다. 기본값은 `FALSE`입니다.
**응답**:
+ **acceptedQueryCount** - Integer이며, 유형은 `integer`(32비트 부호 있는 정수)입니다.
대기열에 있는 쿼리를 포함하여 수락되었지만 아직 완료되지 않은 쿼리 수입니다.
+ **queries** – [GremlinQueryStatus](#GremlinQueryStatus) 객체의 배열입니다.
현재 쿼리의 목록입니다.
+ **runningQueryCount** - Integer이며, 유형은 `integer`(32비트 부호 있는 정수)입니다.
현재 실행 중인 Gremlin 쿼리의 수입니다.
**오류**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## GetGremlinQueryStatus(동작)
이 API의 AWS CLI 이름은 `get-gremlin-query-status`입니다.
지정된 Gremlin 쿼리의 상태를 가져옵니다.
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [Neptune-db:GetQueryStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
참고로 정책 문서에서는 [neptune-db:QueryLanguage:Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM 조건 키를 사용하여 Gremlin 쿼리의 사용을 제한할 수 있습니다([Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) 참조).
**요청**
+ **queryId**(CLI의 경우: `--query-id`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
Gremlin 쿼리를 식별하는 고유 식별자입니다.
**응답**:
+ **queryEvalStats** – [QueryEvalStats](#QueryEvalStats) 객체입니다.
그렘린 쿼리의 평가 상태입니다.
+ **queryId** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
상태가 반환되는 쿼리의 ID입니다.
+ **queryString** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
Gremlin 쿼리 문자열입니다.
**오류**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## CancelGremlinQuery(동작)
이 API의 AWS CLI 이름은 `cancel-gremlin-query`입니다.
Gremlin 쿼리를 취소합니다. 자세한 내용은 [Gremlin 쿼리 취소](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status-cancel.html)를 참조하세요.
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [Neptune-DB:cancelQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **queryId**(CLI의 경우: `--query-id`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
취소할 쿼리를 식별하는 고유 식별자입니다.
**응답**:
+ **status** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
취소의 상태
**오류**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## openCypher 쿼리 작업:**
## ExecuteOpenCypherQuery(동작)
이 API의 AWS CLI 이름은 `execute-open-cypher-query`입니다.
openCypher 쿼리를 실행합니다. 자세한 내용은 [openCypher를 사용하여 Neptune 그래프에 액세스하기](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher.html)를 참조하세요.
Neptune은 현재 그래프 데이터베이스를 사용하는 개발자들 사이에서 가장 많이 사용되는 쿼리 언어 중 하나인 openCypher를 사용한 그래프 애플리케이션 구축을 지원합니다. 개발자, 비즈니스 분석가, 데이터 과학자는 openCypher의 SQL에서 영감을 받은 선언적 구문을 좋아합니다. 속성 그래프를 쿼리하는 데 익숙한 구조를 제공하기 때문입니다.
[openCypher 언어는 원래 Neo4j가 개발한 후 2015년에 오픈 소스로 제공되었으며 Apache 2 오픈 소스 라이선스에 따라 openCypher 프로젝트에 기여했습니다.](https://opencypher.org/)
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할은 쿼리에 따라 해당 클러스터에서 다음 IAM 작업 중 하나를 허용하는 정책을 연결해야 합니다.
+ [Neptune-DB: ReadDataViQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery)
+ [neptune-db:WriteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery)
+ [neptune-db:DeleteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery)
또한 정책 문서에서 [Neptune-DB:QueryLanguage:OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM 조건 키를 사용하여 OpenCypher 쿼리 사용을 제한할 수 있습니다([Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키 참조](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)).
**요청**
+ **openCypherQuery**(CLI의 경우: `--open-cypher-query`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
실행할 openCypher 쿼리 문자열입니다.
+ **parameters**(CLI의 경우: `--parameters`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
쿼리 실행을 위한 OpenCypher 쿼리 파라미터입니다. 자세한 내용은 [OpenCypher 파라미터화된 쿼리의 예](https://docs.aws.amazon.com/neptune/latest/userguide/opencypher-parameterized-queries.html)를 참조하세요.
**응답**:
+ **results** - 필수: Document, 유형은 `document`(JSON과 유사한 데이터 모델로 표현되는 프로토콜에 구애받지 않는 개방형 콘텐츠)입니다.**
openCypherquery 결과입니다.
**오류**
+ [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException)
+ [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [QueryLimitException](data-api-dp-errors.md#QueryLimitException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## ExecuteOpenCypherExplainQuery(동작)
이 API의 AWS CLI 이름은 `execute-open-cypher-explain-query`입니다.
openCypher `explain` 요청을 실행합니다. 자세한 내용은 [OpenCypher 설명 기능](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-explain.html)을 참조하세요.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:ReadDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
참고로 정책 문서에서는 [neptune-db:QueryLanguage:OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM 조건 키를 사용하여 OpenCypher 쿼리 사용을 제한할 수 있습니다([Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키 참조](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)).
**요청**
+ **explainMode**(CLI의 경우: `--explain-mode`) - 필수: OpenCypherExplainMode, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
openCypher `explain` 모드입니다. `static`, `dynamic` 또는 `details` 중 하나일 수 있습니다.
+ **openCypherQuery**(CLI의 경우: `--open-cypher-query`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
OpenCypher 쿼리 문자열입니다.
+ **parameters**(CLI의 경우: `--parameters`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
OpenCypher 쿼리 파라미터입니다.
**응답**:
+ **results** - 필수: Blob, 유형은 `blob`(해석되지 않은 바이너리 데이터 블록)입니다.**
OpenCypher `explain` 결과를 포함하는 텍스트 블롭입니다.
**오류**
+ [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException)
+ [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [QueryLimitException](data-api-dp-errors.md#QueryLimitException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## ListOpenCypherQueries(동작)
이 API의 AWS CLI 이름은 `list-open-cypher-queries`입니다.
활성 OpenCypher 쿼리를 나열합니다. 자세한 내용은 [Neptune OpenCypher 상태 엔드포인트](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html)를 참조하세요.
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [Neptune-db:GetQueryStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
참고로 정책 문서에서는 [neptune-db:QueryLanguage:OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM 조건 키를 사용하여 OpenCypher 쿼리 사용을 제한할 수 있습니다([Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키 참조](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)).
**요청**
+ **includeWaiting**(CLI의 경우: `--include-waiting`) - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
`TRUE`로 설정되고 다른 파라미터가 없으면 대기 중인 쿼리와 실행 중인 쿼리에 대한 상태 정보가 반환됩니다.
**응답**:
+ **acceptedQueryCount** - Integer이며, 유형은 `integer`(32비트 부호 있는 정수)입니다.
대기열에 있는 쿼리를 포함하여 수락되었지만 아직 완료되지 않은 쿼리 수입니다.
+ **queries** – [GremlinQueryStatus](#GremlinQueryStatus) 객체의 배열입니다.
현재 OpenCypher 쿼리 목록입니다.
+ **runningQueryCount** - Integer이며, 유형은 `integer`(32비트 부호 있는 정수)입니다.
현재 실행 중인 openCypher 쿼리의 수입니다.
**오류**
+ [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## GetOpenCypherQueryStatus(동작)
이 API의 AWS CLI 이름은 `get-open-cypher-query-status`입니다.
지정된 OpenCypher 쿼리의 상태를 가져옵니다.
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [Neptune-db:GetQueryStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
참고로 정책 문서에서는 [neptune-db:QueryLanguage:OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM 조건 키를 사용하여 OpenCypher 쿼리 사용을 제한할 수 있습니다([Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키 참조](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)).
**요청**
+ **queryId**(CLI의 경우: `--query-id`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
쿼리 상태를 검색하는 데 사용할 OpenCypher 쿼리의 고유 ID입니다.
**응답**:
+ **queryEvalStats** – [QueryEvalStats](#QueryEvalStats) 객체입니다.
openCypher 쿼리 평가 상태입니다.
+ **queryId** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
상태가 반환되는 쿼리의 고유 ID입니다.
+ **queryString** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
OpenCypher 쿼리 문자열입니다.
**오류**
+ [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## CancelOpenCypherQuery(동작)
이 API의 AWS CLI 이름은 `cancel-open-cypher-query`입니다.
지정된 OpenCypher 쿼리를 취소합니다. 자세한 내용은 [Neptune OpenCypher 상태 엔드포인트](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html)를 참조하세요.
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [Neptune-DB:cancelQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **queryId**(CLI의 경우: `--query-id`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
취소할 OpenCypher 쿼리의 고유 ID입니다.
+ **silent**(CLI의 경우: `--silent`) - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
`TRUE`로 설정하면 OpenCypher 쿼리가 자동으로 취소됩니다.
**응답**:
+ **payload** - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
OpenCypher 쿼리를 위한 취소 페이로드입니다.
+ **status** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
취소할 OpenCypher 쿼리의 고유 ID입니다.
**오류**
+ [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## *쿼리 구조:*
## QueryEvalStats(구조)
실행, 승인 또는 대기 중인 쿼리 수, 세부 정보 등 쿼리 통계를 캡처하는 구조입니다.
**Fields**
+ **cancelled** - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
쿼리가 취소된 경우 `TRUE`로 설정하고, 취소되지 않은 경우 FALSE로 설정합니다.
+ **elapsed** - Integer이며, 유형은 `integer`(32비트 부호 있는 정수)입니다.
지금까지 쿼리가 실행된 시간(단위: 밀리초)입니다.
+ **subqueries** – Document, 유형은 `document`(JSON과 유사한 데이터 모델로 표현되는 프로토콜에 구애받지 않는 개방형 콘텐츠)입니다.
이 쿼리에 있는 하위 쿼리의 수입니다.
+ **waited** - Integer이며, 유형은 `integer`(32비트 부호 있는 정수)입니다.
쿼리가 대기한 시간을 밀리초 단위로 나타냅니다.
## GremlinQueryStatus(구조)
Gremlin 쿼리의 상태를 캡처합니다 ([Gremlin 쿼리 상태 API 페이지](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html) 참조).
**Fields**
+ **queryEvalStats** - [QueryEvalStats](#QueryEvalStats) 객체입니다.
Gremlin 쿼리의 통계입니다.
+ **queryId** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
Gremlin 쿼리의 ID입니다.
+ **queryString** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
Gremlin 쿼리의 통계입니다.
## GremlinQueryStatusAttributes(구조)
Gremlin 쿼리의 상태 구성 요소를 포함합니다.
**Fields**
+ **attributes** – Document, 유형은 `document`(JSON과 유사한 데이터 모델로 표현되는 프로토콜에 구애받지 않는 개방형 콘텐츠)입니다.
Gremlin 쿼리 상태의 속성입니다.
+ **code** - Integer이며, 유형은 `integer`(32비트 부호 있는 정수)입니다.
Gremlin 쿼리 요청에서 반환된 HTTP 응답 코드입니다.
+ **message** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
상태 메시지입니다.
# Neptune 데이터 영역 벌크 로더 API
**벌크 로드 동작:**
+ [StartLoaderJob(동작)](#StartLoaderJob)
+ [GetLoaderJobStatus(동작)](#GetLoaderJobStatus)
+ [ListLoaderJobs(동작)](#ListLoaderJobs)
+ [CancelLoaderJob(동작)](#CancelLoaderJob)
**벌크 로드 구조:**
+ [LoaderIdResult(구조)](#LoaderIdResult)
## StartLoaderJob(동작)
이 API의 AWS CLI 이름은 `start-loader-job`입니다.
Amazon S3 버킷에서 Neptune DB 인스턴스로 데이터를 로드하기 위해 Neptune 대량 로더 작업을 시작합니다. [Amazon Neptune 벌크 로더를 사용하여 데이터 수집](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load.html)을 참조하세요.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:StartLoaderJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startloaderjob) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **dependencies**(CLI의 경우: `--dependencies`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
대기열에 있는 로드 요청을 대기열에 있는 하나 이상의 이전 작업이 성공적으로 완료되는 것에 의존하게 만들 수 있는 선택적 파라미터입니다.
Neptune은 `queueRequest` 파라미터가 `"TRUE"`로 설정된 경우 한 번에 최대 64개의 로드 요청을 대기열에 넣을 수 있습니다. `dependencies` 파라미터를 사용하면 대기열에 있는 이러한 요청의 실행이 대기열에 있는 하나 이상의 지정된 이전 요청이 성공적으로 완료되는 것에 의존하게 만들 수 있습니다.
예를 들어 `Job-A` 및 `Job-B` 로드는 서로 독립적이지만 `Job-C` 로드가 시작되기 전에 `Job-A` 및 `Job-B`를 완료해야 하는 경우 다음과 같이 진행합니다.
1. 어떤 순서든지 차례로 `load-job-A` 및 `load-job-B`를 제출하고 로드 ID를 저장하십시오.
1. 해당 `load-job-C` 필드에 있는 두 작업의 load-id와 함께 `dependencies`를 제출하십시오.
**Example**
```
"dependencies" : ["(job_A_load_id)", "(job_B_load_id)"]
```
`dependencies` 파라미터로 인해 대량 로더는 `Job-C` 및 `Job-A`가 성공적으로 완료될 때까지 `Job-B`를 시작하지 않습니다. 둘 중 하나가 실패하면 Job-C가 실행되지 않고 상태가 `LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED`로 설정됩니다.
이 방법으로 여러 수준의 종속성을 설정할 수 있으므로 한 작업의 실패로 인해 작업에 직접 또는 간접적으로 종속된 모든 요청이 취소됩니다.
+ **failOnError**(CLI의 경우: `--fail-on-error`) - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
**`failOnError`** – 오류 발생 시 완전 정지로 전환하는 플래그입니다.
허용된 값: `"TRUE"`, `"FALSE"`**
기본값: `"TRUE"`**
이 파라미터를 `"FALSE"`로 설정하면 로더는 모든 데이터를 지정된 위치에 있는 로드하려고 하며 오류가 있는 항목을 건너뜁니다.
이 파라미터를 `"TRUE"`로 설정하면 오류가 발생하는 즉시 로더가 중지됩니다. 해당 시점까지 로드된 데이터는 지속됩니다.
+ **format**(CLI의 경우: `--format`) - 필수: Format, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
데이터의 형식입니다. Neptune `Loader` 명령의 데이터 형식에 대한 자세한 내용은 [데이터 형식 로드](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format.html) 단원을 참조하십시오.
**허용된 값**
+ **`csv`** - [Gremlin CSV 데이터 형식](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html)용입니다.
+ **`opencypher`** - [OpenCypher CSV 데이터 형식](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html)용입니다.
+ **`ntriples`** - [N-Triple RDF 데이터 형식](https://www.w3.org/TR/n-triples/)용입니다.
+ **`nquads`** - [N-Quads RDF 데이터 형식](https://www.w3.org/TR/n-quads/)용입니다.
+ **`rdfxml`** - [RDF`\$1XML RDF 데이터 형식](https://www.w3.org/TR/rdf-syntax-grammar/)용입니다.
+ **`turtle`** - [Turtle RDF 데이터 형식](https://www.w3.org/TR/turtle/)용입니다.
+ **iamRoleArn**(CLI의 경우: `--iam-role-arn`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
S3 버킷에 액세스하기 위해 Neptune DB 인스턴스가 담당할 IAM 역할의 Amazon 리소스 이름(ARN)입니다. 여기에 제공된 IAM 역할 ARN은 DB 클러스터에 연결되어야 합니다([Amazon Neptune 클러스터에 IAM 역할 추가](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-IAM-add-role-cluster.html) 참조).
+ **mode**(CLI의 경우: `--mode`) - Mode, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
로드 작업 모드입니다.
허용된 값: `RESUME`, `NEW`, `AUTO`**
*기본값*:`AUTO`
****
+ `RESUME` – RESUME 모드에서는 로더가 이 소스에서 이전 로드를 검색하고, 로드 작업을 찾으면 해당 로드 작업을 재개합니다. 이전 로드 작업을 찾지 못하면 로더가 중지됩니다.
로더는 이전 작업에서 성공적으로 로드된 파일을 다시 로드하지 않고 실패한 파일을 처리하는 작업만 시도합니다. 이전에 로드된 데이터를 Neptune 클러스터에서 삭제한 경우 해당 데이터는 이 모드에서 다시 로드되지 않습니다. 이전 로드 작업이 동일한 소스에서 모든 파일을 성공적으로 로드하면 아무것도 다시 로드되지 않고 로더가 성공을 반환합니다.
+ `NEW` – 새 모드에서는 이전 로드와 상관없이 새 로드 요청을 생성합니다. 이 모드는 이전에 로드한 데이터를 Neptune 클러스터에서 삭제한 후 소스에서 모든 데이터를 다시 로드하거나 동일 소스에서 사용 가능한 새 데이터를 로드할 때 사용할 수 있습니다.
+ `AUTO` – 자동 모드에서는 로더가 동일한 소스에서 이전 로드 작업을 찾고 해당 작업을 찾으면 `RESUME` 모드와 마찬가지로 해당 작업을 재개합니다.
로더가 동일한 소스에서 이전 로드 작업을 찾지 못하면 `NEW` 모드에서와 마찬가지로 소스에서 모든 데이터를 로드합니다.
+ **parallelism**(CLI의 경우: `--parallelism`) - Parallelism, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
대량 로드 프로세스에서 사용하는 스레드 수를 줄이도록 설정할 수 있는 선택적 `parallelism` 파라미터입니다.
허용된 값:**
+ `LOW` – 사용된 스레드 수는 지원되는 vCPU 수를 8로 나눈 값입니다.
+ `MEDIUM` – 사용된 스레드 수는 지원되는 vCPU 수를 2로 나눈 값입니다.
+ `HIGH` – 사용된 스레드 수가 지원되는 vCPU 수와 동일합니다.
+ `OVERSUBSCRIBE` – 사용된 스레드 수는 지원되는 vCPU 수에 2를 곱한 값입니다. 이 값을 사용하면 대량 로더가 사용 가능한 모든 리소스를 차지합니다.
그러나 `OVERSUBSCRIBE` 설정으로 인해 CPU 사용률이 100%가 되는 것은 아닙니다. 로드 작업은 I/O 바운드이므로, 예상할 수 있는 최대 CPU 사용률은 60\$170% 범위입니다.
기본값: `HIGH`**
`parallelism` 설정으로 인해 openCypher 데이터를 로드할 때 간혹 스레드 간에 교착 상태가 발생할 수 있습니다. 이 경우 Neptune에서 `LOAD_DATA_DEADLOCK` 오류를 반환합니다. 일반적으로 `parallelism`을 더 낮게 설정하고 load 명령을 다시 시도하여 문제를 해결할 수 있습니다.
+ **parserConfiguration**(CLI의 경우: `--parser-configuration`) – 다음에 해당할 때 키-값 페어의 맵 배열입니다.
각 키는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
각 값은 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
**`parserConfiguration`** – 추가 구문 분석 구성 값이 있는 선택적 객체입니다. 각 하위 파라미터는 선택 사항입니다.
****
+ **`namedGraphUri`** – 지정된 그래프가 없을 때 모든 RDF 형식의 기본 그래프(비-quads 형식과 그래프가 없는 NQUAD 항목)입니다.
기본값은 `https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph`입니다.
+ **`baseUri`** – RDF/XML 및 Turtle 형식의 기본 URI입니다.
기본값은 `https://aws.amazon.com/neptune/default`입니다.
+ **`allowEmptyStrings`** – Gremlin 사용자는 CSV 데이터를 로드할 때 빈 문자열 값(“”)을 노드 및 엣지 속성으로 전달할 수 있어야 합니다. `allowEmptyStrings`를 `false`(기본값)로 설정하면 이러한 빈 문자열은 null로 처리되며 로드되지 않습니다.
`allowEmptyStrings`를 `true`로 설정하면 로더는 빈 문자열을 유효한 속성값으로 취급하고, 그에 따라 로드합니다.
+ **queueRequest**(CLI의 경우: `--queue-request`) - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
로드 요청을 대기열에 넣을 수 있는지 여부를 나타내는 선택적 플래그 파라미터입니다.
Neptune은 `queueRequest` 파라미터가 모두 `"TRUE"`로 설정된 경우에 한해 한 번에 최대 64개의 작업 요청을 대기열에 넣을 수 있으므로, 한 로드 작업이 완료될 때까지 기다렸다가 다른 로드 작업을 발행할 필요가 없습니다. 작업의 대기열 순서는 선입선출(FIFO)입니다.
`queueRequest` 파라미터를 생략하거나 `"FALSE"`로 설정한 경우 다른 로드 작업이 이미 실행 중이면 로드 요청이 실패합니다.
*허용된 값*:`"TRUE"` ,`"FALSE"`
*기본값*:`"FALSE"`
+ **s3BucketRegion**(CLI의 경우: `--s-3-bucket-region`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
S3 버킷의 Amazon 리전입니다. 이는 DB 클러스터의 Amazon Region과 일치해야 합니다.
+ **source**(CLI의 경우: `--source`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
`source` 파라미터는 단일 파일, 여러 파일, 폴더 또는 여러 폴더를 식별하는 S3 URI를 받아들입니다. Neptune은 지정된 폴더의 모든 데이터 파일을 로드합니다.
URI 형식은 다음 중 하나가 될 수 있습니다.
+ `s3://(bucket_name)/(object-key-name)`
+ `https://s3.amazonaws.com/(bucket_name)/(object-key-name)`
+ `https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name)`
URI의 `object-key-name` 요소는 S3 [ListObjects](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html) API 호출의 [접두사](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html#API_ListObjects_RequestParameters) 파라미터와 동일합니다. 지정된 S3 버킷에서 이름이 해당 접두사로 시작하는 모든 객체를 식별합니다. 단일 파일 또는 폴더 또는 여러 파일 및/또는 폴더일 수 있습니다.
지정된 폴더에는 여러 정점 파일 및 여러 엣지 파일이 포함될 수 있습니다.
+ **updateSingleCardinalityProperties**(CLI의 경우: `--update-single-cardinality-properties`) - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
대량 로더가 단일 카디널리티 버텍스 또는 엣지 속성의 새 값을 처리하는 방법을 제어하는 선택적 파라미터입니다. openCypher 데이터 로드에는 지원되지 않습니다.
*허용된 값*:`"TRUE"` ,`"FALSE"`
*기본값*:`"FALSE"`
기본적으로, 또는 `updateSingleCardinalityProperties`가 명시적으로 `"FALSE"`로 설정되면 로더가 단일 카디널리티를 위반하므로 새 값이 오류로 처리됩니다.
반면 `updateSingleCardinalityProperties`가 `"TRUE"`로 설정되면 대량 로더가 기존 값을 새 값으로 바꿉니다. 로드되는 소스 파일에 여러 엣지 또는 단일 카디널리티 버텍스 속성 값이 제공되는 경우 대량 로드 끝의 최종 값은 새로운 값 중 하나일 수 있습니다. 로더는 기존 값이 새 값 중 하나로 대체되었음을 보장합니다.
+ **userProvidedEdgeIds**(CLI의 경우: `--user-provided-edge-ids`) - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
이 파라미터는 관계 ID가 포함된 OpenCypher 데이터를 로드할 때만 필요합니다. 로드 데이터에 openCypher 관계 ID가 명시적으로 제공되는 경우 이 ID를 포함하고 `True`로 설정해야 합니다(권장).
`userProvidedEdgeIds`가 없거나 `True`로 설정된 경우 로드 중인 모든 관계 파일에 `:ID` 열이 있어야 합니다.
`userProvidedEdgeIds`가 존재하고 `False`로 설정된 경우 로드 중인 관계 파일은 `:ID` 열을 포함하지 **않아야 합니다**. 대신 Neptune 로더는 각 관계에 대한 ID를 자동으로 생성합니다.
이미 로드된 관계를 다시 로드하지 않고도 CSV 데이터의 오류가 수정된 후 로더가 로드를 재개할 수 있도록 관계 ID를 명시적으로 제공하는 것이 좋습니다. 관계 ID가 명시적으로 할당되지 않으면 관계 파일을 수정해야 하는 경우 로더는 실패한 로드를 재개할 수 없으며, 대신 모든 관계를 다시 로드해야 합니다.
**응답**:
+ **payload** – 필수: 다음에 해당할 때 키-값 페어의 맵 배열입니다.
각 키는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
각 값은 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
로드 작업의 식별자를 제공하는 `loadId` 이름-값 쌍을 포함합니다.
+ **status** - 필수: String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
작업 상태를 나타내는 HTTP 반화 코드입니다.
**오류**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [BulkLoadIdNotFoundException](data-api-dp-errors.md#BulkLoadIdNotFoundException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [LoadUrlAccessDeniedException](data-api-dp-errors.md#LoadUrlAccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [InternalFailureException](data-api-dp-errors.md#InternalFailureException)
+ [S3Exception](data-api-dp-errors.md#S3Exception)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
## GetLoaderJobStatus(동작)
이 API의 AWS CLI 이름은 `get-loader-job-status`입니다.
지정된 로드 작업에 대한 상태를 가져옵니다. Neptune은 가장 최근의 1,024개 대량 로드 작업만 추적하고 작업당 마지막 10,000개의 오류 세부 정보를 저장합니다.
자세한 내용은 [Neptune 로더 Get-Status API](https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm)를 참조하세요.
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:GetLoaderJobStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getloaderjobstatus) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **details**(CLI의 경우: `--details`) - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
전체 상태(`TRUE` 또는 `FALSE`, 기본값은 `FALSE`) 이외의 세부 정보를 포함할지 여부를 나타내는 플래그입니다.
+ **errors**(CLI의 경우: `--errors`) - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
발생한 오류 목록을 포함할지 여부를 나타내는 플래그입니다(`TRUE` 또는 `FALSE`, 기본값은 `FALSE`).
오류 목록의 페이지가 매겨집니다. `page` 및 `errorsPerPage` 파라미터를 통해 전체 오류 페이지를 탐색할 수 있습니다.
+ **errorsPerPage**(CLI의 경우:`--errors-per-page`) - PositiveInteger, 유형은 `integer` (부호 있는 32비트 정수, 최소 1? st?)입니다.
각 페이지에서 반환된 오류 수(양의 정수, 기본값 `10`)입니다. 이 `errors` 파라미터는 `TRUE`로 설정된 경우에만 유효합니다.
+ **loadId**(CLI의 경우: `--load-id`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
상태를 가져오려는 로드 작업의 로드 ID입니다.
+ **page**(CLI의 경우:`--page`) - PositiveInteger, 유형은 `integer` (부호 있는 32비트 정수, 최소 1? st?)입니다.
오류 페이지 번호(양의 정수, 기본값 `1`)입니다. 이 `errors` 파라미터는 `TRUE`로 설정된 경우에만 유효합니다.
**응답**:
+ **payload** - 필수: Document, 유형은 `document`(JSON과 유사한 데이터 모델로 표현되는 프로토콜에 구애받지 않는 개방형 콘텐츠)입니다.**
로드 작업에 대한 상태 정보입니다. 레이아웃은 다음과 같을 수 있습니다.
**Example**
```
{
"status" : "200 OK",
"payload" : {
"feedCount" : [
{
"LOAD_FAILED" : (number)
}
],
"overallStatus" : {
"fullUri" : "s3://(bucket)/(key)",
"runNumber" : (number),
"retryNumber" : (number),
"status" : "(string)",
"totalTimeSpent" : (number),
"startTime" : (number),
"totalRecords" : (number),
"totalDuplicates" : (number),
"parsingErrors" : (number),
"datatypeMismatchErrors" : (number),
"insertErrors" : (number),
},
"failedFeeds" : [
{
"fullUri" : "s3://(bucket)/(key)",
"runNumber" : (number),
"retryNumber" : (number),
"status" : "(string)",
"totalTimeSpent" : (number),
"startTime" : (number),
"totalRecords" : (number),
"totalDuplicates" : (number),
"parsingErrors" : (number),
"datatypeMismatchErrors" : (number),
"insertErrors" : (number),
}
],
"errors" : {
"startIndex" : (number),
"endIndex" : (number),
"loadId" : "(string),
"errorLogs" : [ ]
}
}
}
```
+ **status** - 필수: String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
요청에 대한 HTTP 응답 코드입니다.
**오류**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [BulkLoadIdNotFoundException](data-api-dp-errors.md#BulkLoadIdNotFoundException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [LoadUrlAccessDeniedException](data-api-dp-errors.md#LoadUrlAccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [InternalFailureException](data-api-dp-errors.md#InternalFailureException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
## ListLoaderJobs(동작)
이 API의 AWS CLI 이름은 `list-loader-jobs`입니다.
모든 활성 로더 작업의 `loadIds` 목록을 검색합니다.
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:ListLoaderJobs](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listloaderjobs)의 IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **includeQueuedLoads**(CLI의 경우: `--include-queued-loads`) - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
파라미터를 `FALSE`로 설정하여 로드 ID 목록이 요청될 때 대기열에 있는 로드 요청의 로드 ID를 제외하는 데 사용할 수 있는 선택적 파라미터입니다. 기본값은 `TRUE`입니다.
+ **limit**(CLI의 경우: `--limit`) - ListLoaderJobsInputLimitInteger, 유형은 1\$1100 ?st?s자인 `integer`(32비트 부호 있는 정수)입니다.
목록에 표시할 로드 ID 수입니다. 0보다 크고 `100`(기본값)보다 크지 않 양의 정수여야 합니다.
**응답**:
+ **payload** – 필수: [LoaderIdResult](#LoaderIdResult) 객체입니다.**
요청된 작업 ID 목록입니다.
+ **status** - 필수: String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
작업 목록 요청 상태를 반환합니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [BulkLoadIdNotFoundException](data-api-dp-errors.md#BulkLoadIdNotFoundException)
+ [InternalFailureException](data-api-dp-errors.md#InternalFailureException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [LoadUrlAccessDeniedException](data-api-dp-errors.md#LoadUrlAccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## CancelLoaderJob(동작)
이 API의 AWS CLI 이름은 `cancel-loader-job`입니다.
지정된 로드 작업을 취소합니다. 이것은 HTTP `DELETE` 요청입니다. 자세한 내용은 [Neptune 로더 Get-Status API](https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm)를 참조하세요.
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:CancelLoaderJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelloaderjob) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **loadId**(CLI의 경우: `--load-id`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
삭제되는 로드 작업의 ID입니다.
**응답**:
+ **status** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
취소 상태입니다.
**오류**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [BulkLoadIdNotFoundException](data-api-dp-errors.md#BulkLoadIdNotFoundException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [LoadUrlAccessDeniedException](data-api-dp-errors.md#LoadUrlAccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [InternalFailureException](data-api-dp-errors.md#InternalFailureException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
## 벌크 로드 구조:**
## LoaderIdResult(구조)
로드 ID의 목록입니다.
**Fields**
+ **loadIds** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
로드 ID의 목록입니다.
# Neptune 스트림 데이터플레인 API
**스트림 액세스 작업:**
+ [GetPropertygraphStream(동작)](#GetPropertygraphStream)
**스트림 데이터 구조:**
+ [PropertygraphRecord(구조)](#PropertygraphRecord)
+ [PropertygraphData(구조)](#PropertygraphData)
## GetPropertygraphStream(동작)
이 API의 AWS CLI 이름은 `get-propertygraph-stream`입니다.
속성 그래프의 스트림을 가져옵니다.
Neptune 스트림 기능을 사용하면 그래프 데이터에 대해 이루어진 모든 변경을 기록하는 변경-로그 항목에 대한 완벽한 시퀀스를 생성할 수 있습니다. `GetPropertygraphStream`은 속성 그래프를 위해 이러한 변경-로그 항목을 수집하도록 합니다.
Neptune DB 클러스터에서 Neptune 스트림 기능을 활성화해야 합니다. 스트림을 활성화하려면 [neptune\$1stream](https://docs.aws.amazon.com/neptune/latest/userguide/parameters.html#parameters-db-cluster-parameters-neptune_streams) DB 클러스터 파라미터를 `1`로 설정합니다.
[Neptune 스트림을 통해 실시간으로 그래프 변경 캡처](https://docs.aws.amazon.com/neptune/latest/userguide/streams.html)를 참조하세요.
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:GetStreamRecords](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstreamrecords) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할은 쿼리에 따라 다음 IAM 작업 중 하나를 활성화하는 정책을 연결해야 합니다.
다음 IAM 컨텍스트 키를 사용하여 속성 그래프 쿼리를 제한할 수 있다는 점에 유의하세요.
+ [neptune-db:QueryLanguage:Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys)
+ [neptune-db:QueryLanguage:OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys)
[Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)를 참조하세요.
**요청**
+ **commitNum**(CLI의 경우: `--commit-num`) - Long, 유형은 `long`(64비트 부호 있는 정수)입니다.
변경-로그 스트림에서 읽어올 시작 레코드의 커밋 수입니다. 이 파라미터는 `iteratorType`이 `AT_SEQUENCE_NUMBER` 또는 `AFTER_SEQUENCE_NUMBER`일 때는 필수이고, `iteratorType`이 `TRIM_HORIZON`이거나 `LATEST`일 때는 무시됩니다.
+ **encoding**(CLI의 경우: `--encoding`) - Encoding, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
TRUE로 설정하면 Neptune은 gzip 인코딩을 사용하여 응답을 압축합니다.
+ **iteratorType**(CLI의 경우: `--iterator-type`) - IteratorType, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
다음 중 하나일 수 있습니다.
+ `AT_SEQUENCE_NUMBER` – 읽기가 `commitNum` 및 `opNum` 파라미터에서 공동으로 지정된 이벤트 시퀀스 번호부터 시작해야 한다는 것을 나타냅니다.
+ `AFTER_SEQUENCE_NUMBER` - 읽기가 `commitNum` 및 `opNum` 파라미터에서 공동으로 지정된 이벤트 시퀀스 번호 바로 뒤부터 시작해야 한다는 것을 나타냅니다.
+ `TRIM_HORIZON` – 읽기가 시스템에서 잘리지 않은 마지막 레코드, 즉 변경-로그 스트림에서 만료되지 않은(아직 삭제되지 않은) 가장 오래된 레코드에서 시작되어야 한다는 것을 나타냅니다.
+ `LATEST` – 읽기가 시스템에서 가장 최근 레코드, 즉 변경-로그 스트림에서 만료되지 않은(아직 삭제되지 않은) 최신 레코드에서 시작되어야 한다는 것을 나타냅니다.
+ **limit** (CLI의 경우:`--limit`) - GetPropertygraphStreamInputLimitLong, 유형은 `long`(부호 있는 1\$199,999 사이의 64비트 정수)입니다.
반환할 최대 레코드 수를 지정합니다. 수정이 불가능하고 `limit` 파라미터에 지정된 레코드 수보다 우선하는 응답의 경우 10MB로 크기가 제한됩니다. 10MB 제한에 도달하면 이러한 응답에 임곗값 위반 레코드가 포함됩니다.
`limit`의 범위는 1\$1100,000이며 기본값은 10입니다.
+ **opNum**(CLI의 경우: `--op-num`) - Long, 유형은 `long`(64비트 부호 있는 정수)입니다.
변경-로그 스트림 데이터에서 읽어오기를 시작하기 위해 지정된 커밋 내의 작업 시퀀스 수입니다. 기본값은입니다`1`.
**응답**:
+ **format** - 필수: String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
반환 중인 변경 레코드에 대한 직렬화 형식입니다. 현재 지원되는 값은 `PG_JSON`입니다.
+ **lastEventId** – 필수: 다음에 해당할 때 키-값 페어의 맵 배열입니다.
각 키는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
각 값은 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
스트림 응답의 마지막 변경에 대한 시퀀스 식별자입니다.
이벤트 ID는 두 개의 필드로 이루어져 있는데, `commitNum`은 그래프를 변경한 트랜잭션을 식별하고 `opNum`는 해당 트랜잭션 내에서 특정 작업을 식별합니다.
**Example**
```
"eventId": {
"commitNum": 12,
"opNum": 1
}
```
+ **lastTrxTimestampInMillis** - 필수: Long, 유형은 `long`(64비트 부호 있는 정수)입니다.
트랜잭션에 대한 커밋이 요청된 시점입니다(Unix epoch의 밀리초).
+ **records** – 필수: [PropertygraphRecord](#PropertygraphRecord) 객체의 배열입니다.**
응답에 포함된 직렬화된 변경-로그 스트림 레코드의 배열입니다.
+ **totalRecords** - 필수: Integer이며, 유형은 `integer`(32비트 부호 있는 정수)입니다.
응답의 총 레코드 수입니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [ExpiredStreamException](data-api-dp-errors.md#ExpiredStreamException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException)
+ [StreamRecordsNotFoundException](data-api-dp-errors.md#StreamRecordsNotFoundException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ThrottlingException](data-api-dp-errors.md#ThrottlingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## *스트림 데이터 구조:*
## PropertygraphRecord(구조)
프로퍼티 그래프 레코드의 구조입니다.
**Fields**
+ **commitTimestampInMillis** - 필수: Long, 유형은 `long`(64비트 부호 있는 정수)입니다.
트랜잭션에 대한 커밋이 요청된 시점입니다(Unix epoch의 밀리초).
+ **data** - 필수: [PropertygraphData](#PropertygraphData) 객체입니다.**
직렬화된 Gremlin, SPARQL 또는 openCypher 변경 레코드입니다.
+ **eventId** – 필수: 다음에 해당할 때 키-값 페어의 맵 배열입니다.
각 키는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
각 값은 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
스트림 응답의 마지막 변경에 대한 시퀀스 식별자입니다.
+ **isLastOp** - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
이 작업이 트랜잭션의 마지막 작업인 경우에만 표시됩니다. 존재하는 경우 true로 설정됩니다. 전체 트랜잭션이 사용되도록 하는 데 유용합니다.
+ **op** - 필수: String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
변경을 일으킨 작업입니다.
## PropertygraphData(구조)
Gremlin, SPARQL 또는 openCypher 변경 레코드입니다.
**Fields**
+ **from** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
이것이 엣지(type=`e`)일 경우, 해당되는 `from` 정점 또는 소스 노드의 ID입니다.
+ **id** - 필수: String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
Gremlin 또는 openCypher 요소의 ID입니다.
+ **key** - 필수: String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
속성 이름입니다. 요소 레이블에서 속성 이름은 `label`입니다.
+ **to** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
이것이 엣지(type=`e`)일 경우, 해당되는 `to` 정점 또는 대상 노드의 ID입니다.
+ **type** - 필수: String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
Gremlin 또는 openCypher 요소의 유형입니다. 다음 중 하나여야 합니다.
+ **`v1`** – Gremlin의 경우 정점 레이블, openCypher의 경우 노드 레이블
+ **`vp`** – Gremlin의 경우 정점 속성, openCypher의 경우 노드 속성
+ **`e`** – Gremlin의 경우 엣지 및 엣지 레이블, openCypher의 경우 관계 및 관계 유형
+ **`ep`** – Gremlin의 경우 엣지 속성, openCypher의 경우 관계 속성
+ **value** - 필수: Document, 유형은 `document`(JSON과 유사한 데이터 모델로 표현되는 프로토콜에 구애받지 않는 개방형 콘텐츠)입니다.**
값 자체에 대한 값 필드와 이 값의 JSON 데이터 유형에 대한 datatype 필드를 포함하는 JSON 객체입니다.
**Example**
```
"value": {
"value": "(the new value"),
"dataType": "(the JSON datatypenew value")
}
```
# Neptune 데이터플레인 통계 및 그래프 요약 API
**속성 그래프 통계 작업:**
+ [GetPropertygraphStatistics(동작)](#GetPropertygraphStatistics)
+ [ManagePropertygraphStatistics(동작)](#ManagePropertygraphStatistics)
+ [DeletePropertygraphStatistics(동작)](#DeletePropertygraphStatistics)
+ [GetPropertygraphSummary(동작)](#GetPropertygraphSummary)
**통계 구조:**
+ [Statistics(구조)](#Statistics)
+ [StatisticsSummary(동작)](#StatisticsSummary)
+ [StatisticsSummary(구조)](#DeleteStatisticsValueMap)
+ [RefreshStatisticsIdMap(구조)](#RefreshStatisticsIdMap)
+ [NodeStructure(구조)](#NodeStructure)
+ [NodeStructure(구조)](#EdgeStructure)
+ [SubjectStructure(구조)](#SubjectStructure)
+ [PropertygraphSummaryValueMap(구조)](#PropertygraphSummaryValueMap)
+ [PropertygraphSummary(구조)](#PropertygraphSummary)
## GetPropertygraphStatistics(동작)
이 API의 AWS CLI 이름은 `get-propertygraph-statistics`입니다.
속성 그래프 통계(Gremlin 및 openCypher)를 가져옵니다.
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:GetStatisticsStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstatisticsstatus) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ 요청 파라미터가 없습니다.**
**응답**:
+ **payload** – 필수: [Statistics](#Statistics) 객체입니다.**
속성 그래프 데이터에 대한 통계입니다.
+ **status** - 필수: String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
요청의 HTTP 반환 코드입니다. 요청이 성공하면 코드는 200입니다. 일반적인 오류 목록은 [DFE 통계 요청의 일반 오류 코드](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors)를 참조하세요.
**오류**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [StatisticsNotAvailableException](data-api-dp-errors.md#StatisticsNotAvailableException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
## ManagePropertygraphStatistics(동작)
이 API의 AWS CLI 이름은 `manage-propertygraph-statistics`입니다.
속성 그래프 통계의 생성 및 사용을 관리합니다.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:ManageStatistics](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#managestatistics) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **mode**(CLI에서:`--mode`) StatisticsAutoGenerationMode, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
통계 생성 모드입니다. 다음 중 하나: `DISABLE_AUTOCOMPUTE`, `ENABLE_AUTOCOMPUTE` 또는 `REFRESH`, DFE 통계 생성을 수동으로 트리거하는 마지막 모드입니다.
**응답**:
+ **payload** – [RefreshStatisticsIdMap](#RefreshStatisticsIdMap) 객체입니다.
이 값은 새로 고침 모드에서만 반환됩니다.
+ **status** - 필수: String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
요청의 HTTP 반환 코드입니다. 요청이 성공하면 코드는 200입니다.
**오류**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [StatisticsNotAvailableException](data-api-dp-errors.md#StatisticsNotAvailableException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
## DeletePropertygraphStatistics(동작)
이 API의 AWS CLI 이름은 `delete-propertygraph-statistics`입니다.
Gremlin 및 openCypher(속성 그래프) 통계를 삭제합니다.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:DeleteStatistics](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletestatistics) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ *요청 파라미터가 없습니다.*
**응답**:
+ **payload** – [StatisticsSummary](#DeleteStatisticsValueMap) 객체입니다.
삭제 페이로드입니다.
+ **status** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
취소 상태입니다.
+ **statusCode** - Integer이며, 유형은 `integer`(32비트 부호 있는 정수)입니다.
HTTP 응답 코드: 삭제에 성공한 경우 200, 삭제할 통계가 없는 경우 204입니다.
**오류**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [StatisticsNotAvailableException](data-api-dp-errors.md#StatisticsNotAvailableException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
## GetPropertygraphSummary(동작)
이 API의 AWS CLI 이름은 `get-propertygraph-summary`입니다.
속성 그래프의 그래프 요약을 가져옵니다.
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:GetGraphSummary](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getgraphsummary) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **mode**(CLI의 경우: `--mode`) - GraphSummaryType, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
모드에는 두 값 `BASIC`(기본값)과 및 `DETAILED` 중 하나를 사용할 수 있습니다.
**응답**:
+ **payload** – [PropertygraphSummaryValueMap](#PropertygraphSummaryValueMap) 객체입니다.
속성 그래프 요약 응답이 포함된 페이로드입니다.
+ **statusCode** - Integer이며, 유형은 `integer`(32비트 부호 있는 정수)입니다.
요청의 HTTP 반환 코드입니다. 요청이 성공하면 코드는 200입니다.
**오류**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [StatisticsNotAvailableException](data-api-dp-errors.md#StatisticsNotAvailableException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
## *통계 구조:*
## Statistics(구조)
통계 정보가 들어 있습니다. DFE 엔진은 Neptune 그래프의 데이터에 대한 정보를 사용하여 쿼리 실행을 계획할 때 효과적인 절충안을 마련합니다. 이 정보는 쿼리 계획의 지침이 될 수 있는 소위 특성 세트와 조건자 통계를 포함하는 통계의 형태를 취합니다. [Neptune DFE에서 사용할 통계 관리](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html)를 참조하세요.
**Fields**
+ **active** - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
DFE 통계 생성이 완전히 활성화되었는지 여부를 나타냅니다.
+ **autoCompute** - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
자동 통계 생성이 활성화되었는지 여부를 나타냅니다.
+ **date** - SyntheticTimestamp\$1date\$1time, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
DFE 통계가 가장 최근에 생성된 UTC 시간입니다.
+ **note** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
통계가 유효하지 않은 경우의 문제에 대한 참고 사항입니다.
+ **signatureInfo** - [StatisticsSummary](#StatisticsSummary) 객체입니다.
다음을 포함하는 StatisticsSummary 구조입니다.
+ `signatureCount` – 모든 특성 세트의 총 서명 수입니다.
+ `instanceCount` – 특성 세트 인스턴스의 총 수입니다.
+ `predicateCount` – 고유한 조건자의 총 수입니다.
+ **statisticsId** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
현재 통계 생성 실행의 ID를 보고합니다. 값이 -1이면 통계가 생성되지 않았음을 나타냅니다.
## StatisticsSummary(동작)
통계에서 생성된 특성 집합에 대한 정보입니다.
**Fields**
+ **instanceCount** - Integer이며, 유형은 `integer`(32비트 부호 있는 정수)입니다.
특성 세트 인스턴스의 총 수입니다.
+ **predicateCount** - Integer이며, 유형은 `integer`(32비트 부호 있는 정수)입니다.
고유한 조건자의 총 수입니다.
+ **signatureCount** - Integer이며, 유형은 `integer`(32비트 부호 있는 정수)입니다.
모든 특성 세트의 총 서명 수입니다.
## StatisticsSummary(구조)
DeleteStatistics를 위한 페이로드입니다.
**Fields**
+ **active** - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
스택의 현재 상태입니다.
+ **statisticsId** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
현재 진행 중인 통계 생성 실행의 ID입니다.
## RefreshStatisticsIdMap(구조)
`REFRESH` 모드에 대한 통계입니다.
**Fields**
+ **statisticsId** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
현재 진행 중인 통계 생성 실행의 ID입니다.
## NodeStructure(구조)
노드 구조입니다.
**Fields**
+ **count** - Long이며, 유형은 `long`(64비트 부호 있는 정수)입니다.
이 특정 구조를 가진 노드 수입니다.
+ **distinctOutgoingEdgeLabels** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
이 특정 구조에 있는 고유한 발신 엣지 레이블의 목록입니다.
+ **nodeProperties** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
이 특정 구조에 있는 노드 속성 목록입니다.
## NodeStructure(구조)
엣지 구조입니다.
**Fields**
+ **count** - Long이며, 유형은 `long`(64비트 부호 있는 정수)입니다.
이 특정 구조를 가진 엣지 수입니다.
+ **edgeProperties** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
이 특정 구조에 있는 엣지 속성 목록입니다.
## SubjectStructure(구조)
주제 구조입니다.
**Fields**
+ **count** - Long이며, 유형은 `long`(64비트 부호 있는 정수)입니다.
이 특정 구조의 발생 횟수입니다.
+ **predicates** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
이 특정 구조에 있는 조건자 목록입니다.
## PropertygraphSummaryValueMap(구조)
속성 그래프 요약 응답을 위한 페이로드입니다.
**Fields**
+ **graphSummary** - [PropertygraphSummary](#PropertygraphSummary) 객체입니다.
그래프 요약입니다.
+ **lastStatisticsComputationTime** - SyntheticTimestamp\$1date\$1time, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
Neptune이 통계를 마지막으로 계산한 시간의 타임스탬프(ISO 8601 형식)입니다.
+ **version** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
이 그래프 요약 응답의 버전입니다.
## PropertygraphSummary(구조)
그래프 요약 API는 노드, 엣지, 속성의 개수와 함께 노드 및 엣지 레이블과 속성 키의 읽기 전용 목록을 반환합니다. [속성 그래프(PG)의 그래프 요약 응답](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-graph-summary.html#neptune-graph-summary-pg-response)을 참조하세요.
**Fields**
+ **edgeLabels** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
그래프의 고유한 엣지 레이블 목록입니다.
+ **edgeProperties** - LongValuedMap 객체이며 다음과 같은 키-값 페어의 맵 배열입니다.
각 키는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
각 값은 Long이며, 유형은 `long`(64비트 부호 있는 정수)입니다.
각 속성이 사용된 엣지 수와 그래프의 고유한 엣지 속성 목록입니다.
+ **edgeStructures** - [NodeStructure](#EdgeStructure) 객체 배열입니다.
이 필드는 요청 모드가 `DETAILED`인 경우에만 표시됩니다. 여기에는 엣지 구조 목록이 포함됩니다.
+ **nodeLabels** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
그래프의 고유한 노드 레이블 목록입니다.
+ **nodeProperties** - LongValuedMap 객체이며 다음과 같은 키-값 페어의 맵 배열입니다.
각 키는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
각 값은 Long이며, 유형은 `long`(64비트 부호 있는 정수)입니다.
그래프에 있는 고유한 노드 속성의 수입니다.
+ **nodeStructures** - [NodeStructure](#NodeStructure) 객체 배열입니다.
이 필드는 요청 모드가 `DETAILED`인 경우에만 표시됩니다. 여기에는 노드 구조 목록이 들어 있습니다.
+ **numEdgeLabels** - Long이며, 유형은 `long`(64비트 부호 있는 정수)입니다.
그래프에 있는 고유한 엣지 레이블의 수입니다.
+ **numEdgeProperties** - Long이며, 유형은 `long`(64비트 부호 있는 정수)입니다.
그래프에 있는 고유한 엣지 속성의 수입니다.
+ **numEdges** - Long이며, 유형은 `long`(64비트 부호 있는 정수)입니다.
그래프의 엣지 수입니다.
+ **numNodeLabels** - Long이며, 유형은 `long`(64비트 부호 있는 정수)입니다.
그래프에 있는 고유한 노드 레이블의 수입니다.
+ **numNodeProperties** - Long이며, 유형은 `long`(64비트 부호 있는 정수)입니다.
각 속성이 사용된 노드 수와 그래프의 고유한 노드 속성 목록입니다.
+ **numNodes** - Long이며, 유형은 `long`(64비트 부호 있는 정수)입니다.
그래프의 노드 수입니다.
+ **totalEdgePropertyValues** - Long이며, 유형은 `long`(64비트 부호 있는 정수)입니다.
모든 엣지 속성의 총 사용 횟수입니다.
+ **totalNodePropertyValues** - Long이며, 유형은 `long`(64비트 부호 있는 정수)입니다.
모든 노드 속성의 총 사용 횟수입니다.
# Neptune ML 데이터 처리 API
**데이터 처리 작업:**
+ [StartMLDataProcessingJob(동작)](#StartMLDataProcessingJob)
+ [ListMLDataProcessingJobs(작업)](#ListMLDataProcessingJobs)
+ [GetMLDataProcessingJob(동작)](#GetMLDataProcessingJob)
+ [CancelMLDataProcessingJob(동작)](#CancelMLDataProcessingJob)
**ML 범용 구조:**
+ [MlResourceDefinition(구조)](#MlResourceDefinition)
+ [MlConfigDefinition(구조)](#MlConfigDefinition)
## StartMLDataProcessingJob(동작)
이 API의 AWS CLI 이름은 `start-ml-data-processing-job`입니다.
Neptune에서 훈련용으로 내보낸 그래프 데이터를 처리하기 위한 새 Neptune ML 데이터 처리 작업을 만듭니다. [`dataprocessing` 명령](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html)을 사용합니다.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:StartMLModelDataProcessingJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeldataprocessingjob) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **configFileName**(CLI의 경우: `--config-file-name`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
훈련용으로 내보낸 그래프 데이터를 로드하는 방법을 설명하는 데이터 사양 파일입니다. 파일은 Neptune 내보내기 도구 키트에 의해 자동으로 생성됩니다. 기본값은 `training-data-configuration.json`입니다.
+ **id**(CLI의 경우: `--id`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
새 작업의 고유 식별자입니다. 기본값은 자동 생성된 UUID입니다.
+ **inputDataS3Location**(CLI의 경우: `--input-data-s3-location`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
SageMaker가 데이터 처리 작업을 실행하는 데 필요한 데이터를 다운로드하도록 하려는 Amazon S3 위치의 URI입니다.
+ **modelType**(CLI의 경우: `--model-type`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
Neptune ML이 현재 지원하는 두 모델 유형인 이기종 그래프 모델(`heterogeneous`)과 지식 그래프(`kge`) 중 하나입니다. 기본값은 없습니다. 지정하지 않으면 Neptune ML은 데이터를 기반으로 모델 유형을 자동으로 선택합니다.
+ **neptuneIamRoleArn**(CLI의 경우: `--neptune-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker가 사용자를 대신하여 작업을 수행하도록 수임할 수 있는 IAM 역할의 Amazon 리소스 이름(ARN)입니다. 이는 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
+ **previousDataProcessingJobId**(CLI의 경우: `--previous-data-processing-job-id`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
이전 버전의 데이터에서 실행된 완료 데이터 처리 작업의 작업 ID입니다.
+ **processedDataS3Location**(CLI의 경우: `--processed-data-s3-location`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
SageMaker가 데이터 처리 작업의 결과를 저장하게 하려는 Amazon S3 위치의 URI입니다.
+ **processingInstanceType**(CLI의 경우: `--processing-instance-type`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
데이터 처리 중에 사용되는 ML 인스턴스의 유형입니다. 메모리는 처리된 데이터 세트를 담을 수 있을 만큼 커야 합니다. 기본값은 디스크에서 내보낸 그래프 데이터 크기보다 10배 큰 메모리가 있는 가장 작은 ml.r5 유형입니다.
+ **processingInstanceVolumeSizeInGB**(CLI의 경우: `--processing-instance-volume-size-in-gb`) - Integer, 유형은 `integer`(32비트 부호 있는 정수)입니다.
처리 인스턴스의 디스크 볼륨 크기입니다. 입력 데이터와 처리된 데이터 모두 디스크에 저장되므로, 볼륨 크기는 두 데이터 세트를 모두 담을 수 있을 만큼 커야 합니다. 기본값은 0입니다. 지정하지 않거나 0으로 지정하면 Neptune ML은 데이터 크기를 기준으로 볼륨 크기를 자동으로 선택합니다.
+ **processingTimeOutInSeconds**(CLI의 경우: `--processing-time-out-in-seconds`) - Integer, 유형은 `integer`(32비트 부호 있는 정수)입니다.
데이터 처리 작업의 제한 시간(초)입니다. 기본값은 86,400(1일)입니다.
+ **s3OutputEncryptionKMSKey**(CLI의 경우: `--s-3-output-encryption-kms-key`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker가 처리 작업의 출력을 암호화하는 데 사용하는 Amazon Key Management Service(Amazon KMS) 키입니다. 기본값은 없습니다.
+ **sagemakerIamRoleArn**(CLI의 경우: `--sagemaker-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker를 실행하기 위한 IAM 역할의 ARN입니다. 이는 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
+ **securityGroupIds**(CLI의 경우: `--security-group-ids`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
VPC 보안 그룹 ID입니다. 기본값은 없습니다.
+ **subnets**(CLI의 경우: `--subnets`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
Neptune VPC의 서브넷 ID입니다. 기본값은 없습니다.
+ **volumeEncryptionKMSKey**(CLI의 경우: `--volume-encryption-kms-key`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
훈련 작업을 실행하는 ML 컴퓨팅 인스턴스에 연결된 스토리지 볼륨에서 데이터를 암호화하는 데 SageMaker가 사용하는 Amazon Key Management Service(Amazon KMS) 키입니다. 기본값은 없습니다.
**응답**:
+ **arn** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
데이터 처리 작업의 ARN입니다.
+ **creationTimeInMillis** - Long, 유형은 `long`(64비트 부호 있는 정수)입니다.
새 처리 작업을 생성하는 데 걸린 시간(밀리초)입니다.
+ **id** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
새 데이터 처리 작업의 고유 ID입니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## ListMLDataProcessingJobs(작업)
이 API의 AWS CLI 이름은 `list-ml-data-processing-jobs`입니다.
Neptune ML 데이터 처리 작업 목록을 반환합니다. [Neptune ML 데이터 처리 명령을 사용하여 활성 데이터 처리 작업](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html#machine-learning-api-dataprocessing-list-jobs) 나열을 참조하세요.
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:ListMLDataProcessingJobs](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmldataprocessingjobs)의 IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **maxItems**(CLI의 경우: `--max-items`) - ListMLDataProcessingJobsInputMaxItemsInteger, 유형은 1\$11,024자인 `integer`(32비트 부호 있는 정수)입니다.
반환할 항목의 최대 수입니다(1\$11024이며, 기본값은 10).
+ **neptuneIamRoleArn**(CLI의 경우: `--neptune-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker와 Amazon S3 리소스에 대한 Neptune의 액세스 권한을 제공하는 IAM 역할의 ARN입니다. 이는 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
**응답**:
+ **ids** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
데이터 처리 작업 ID를 나열하는 페이지입니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## GetMLDataProcessingJob(동작)
이 API의 AWS CLI 이름은 `get-ml-data-processing-job`입니다.
지정된 데이터 처리 작업에 대한 정보를 검색합니다. [`dataprocessing` 명령](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html)을 사용합니다.
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:neptune-db:GetMLDataProcessingJobStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmldataprocessingjobstatus) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **id**(CLI의 경우: `--id`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
검색할 데이터 처리 작업의 고유 식별자입니다.
+ **neptuneIamRoleArn**(CLI의 경우: `--neptune-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker와 Amazon S3 리소스에 대한 Neptune의 액세스 권한을 제공하는 IAM 역할의 ARN입니다. 이는 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
**응답**:
+ **id** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
이 데이터 처리 작업의 고유 식별자입니다.
+ **processingJob** – [MlResourceDefinition](#MlResourceDefinition) 객체입니다.
데이터 처리 작업의 정의입니다.
+ **status** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
데이터 처리 작업의 상태입니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## CancelMLDataProcessingJob(동작)
이 API의 AWS CLI 이름은 `cancel-ml-data-processing-job`입니다.
Neptune ML 데이터 처리 작업을 취소합니다. [`dataprocessing` 명령](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html)을 사용합니다.
IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [Neptune-DB:CancelmlDataProcessingJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmldataprocessingjob) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **clean**(CLI의 경우: `--clean`) - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
`TRUE`로 설정된 경우 이 플래그는 작업이 중지될 때 모든 Neptune ML S3 아티팩트를 삭제하도록 지정합니다. 기본값은 `FALSE`입니다.
+ **id**(CLI의 경우: `--id`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
데이터 처리 작업의 고유 식별자입니다.
+ **neptuneIamRoleArn**(CLI의 경우: `--neptune-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker와 Amazon S3 리소스에 대한 Neptune의 액세스 권한을 제공하는 IAM 역할의 ARN입니다. 이는 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
**응답**:
+ **status** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
취소 요청의 상태입니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## *ML 범용 구조:*
## MlResourceDefinition(구조)
Neptune ML 리소스를 정의합니다.
**Fields**
+ **arn** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
리소스 ARN입니다.
+ **cloudwatchLogUrl** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
리소스의 CloudWatch 로그 URL입니다.
+ **failureReason** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
실패 사유(실패 시)입니다.
+ **name** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
리소스 이름입니다.
+ **outputLocation** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
출력 위치입니다.
+ **status** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
리소스 상태입니다.
## MlConfigDefinition(구조)
Neptune ML 구성을 포함합니다.
**Fields**
+ **arn** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
구성의 ARN입니다.
+ **name** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
구성 이름입니다.
# Neptune ML 모델 훈련 API
**모델 훈련 작업:**
+ [StartMLModelTrainingJob(작업)](#StartMLModelTrainingJob)
+ [ListMLModelTrainingJobs(작업)](#ListMLModelTrainingJobs)
+ [GetMLModelTrainingJob(작업)](#GetMLModelTrainingJob)
+ [CancelMLModelTrainingJob(작업)](#CancelMLModelTrainingJob)
**모델 훈련 구조:**
+ [CustomModelTrainingParameters(구조)](#CustomModelTrainingParameters)
## StartMLModelTrainingJob(작업)
이 API의 AWS CLI 이름은 `start-ml-model-training-job`입니다.
Neptune ML 모델 훈련 작업을 새로 생성합니다. [`modeltraining` 명령을 사용한 모델 훈련](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html)을 참조합니다.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:StartMLModelTrainingJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeltrainingjob) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **baseProcessingInstanceType**(CLI의 경우: `--base-processing-instance-type`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
ML 모델 훈련 준비 및 관리에 사용되는 ML 인스턴스 유형입니다. 훈련 데이터 및 모델을 처리하는 데 필요한 메모리 요구 사항을 기반으로 선택된 CPU 인스턴스입니다.
+ **customModelTrainingParameters**(CLI의 경우: `--custom-model-training-parameters`) - [CustomModelTrainingParameters](#CustomModelTrainingParameters) 객체입니다.
사용자 지정 모델 훈련 구성입니다. 이는 JSON 객체입니다.
+ **dataProcessingJobId**(CLI의 경우: `--data-processing-job-id`) - *필수:* String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
훈련에서 사용할 데이터를 생성하여 완료된 데이터 처리 작업의 작업 ID입니다.
+ **enableManagedSpotTraining**(CLI의 경우: `--enable-managed-spot-training`) - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
Amazon Elastic Compute Cloud 스팟 인스턴스를 사용하여 기계 학습 모델 훈련 비용을 최적화합니다. 기본값은 `False`입니다.
+ **id**(CLI의 경우: `--id`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
새 작업의 고유 식별자입니다. 기본값은 자동 생성된 UUID입니다.
+ **maxHPONumberOfTrainingJobs**(CLI의 경우: `--max-hpo-number-of-training-jobs`) - Integer, 유형은 `integer`(32비트 부호 있는 정수)입니다.
하이퍼파라미터 튜닝 작업을 위해 시작할 최대 총 훈련 작업 수입니다. 기본값은 2입니다. Neptune ML은 기계 학습 모델의 하이퍼파라미터를 자동으로 튜닝합니다. 성능이 좋은 모델을 확보하려면 최소 10개 이상의 작업(즉 `maxHPONumberOfTrainingJobs` 값을 10으로 설정)을 사용합니다. 일반적으로 튜닝 실행 횟수가 많을수록 더 좋은 결과를 얻을 수 있습니다.
+ **maxHPOParallelTrainingJobs**(CLI의 경우: `--max-hpo-parallel-training-jobs`) - Integer, 유형은 `integer`(32비트 부호 있는 정수)입니다.
하이퍼파라미터 튜닝 작업을 위해 시작할 최대 병렬 훈련 작업 수입니다. 기본값은 2입니다. 실행할 수 있는 병렬 작업 수는 훈련 인스턴스에서 사용 가능한 리소스에 따라 제한됩니다.
+ **neptuneIamRoleArn**(CLI의 경우: `--neptune-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker와 Amazon S3 리소스에 대한 Neptune의 액세스 권한을 제공하는 IAM 역할의 ARN입니다. 이는 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
+ **previousModelTrainingJobId**(CLI의 경우: `--previous-model-training-job-id`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
업데이트된 데이터를 기반으로 하여 점진적으로 업데이트하려는 완료된 모델 훈련 작업의 작업 ID입니다.
+ **s3OutputEncryptionKMSKey**(CLI의 경우: `--s-3-output-encryption-kms-key`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker가 처리 작업의 출력을 암호화하는 데 사용하는 Amazon Key Management Service(Amazon KMS) 키입니다. 기본값은 없습니다.
+ **sagemakerIamRoleArn**(CLI의 경우: `--sagemaker-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker 실행을 위한 IAM 역할의 ARN입니다. 이 ARN은 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
+ **securityGroupIds**(CLI의 경우: `--security-group-ids`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
VPC 보안 그룹 ID입니다. 기본값은 없습니다.
+ **subnets**(CLI의 경우: `--subnets`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
Neptune VPC의 서브넷 ID입니다. 기본값은 없습니다.
+ **trainingInstanceType**(CLI의 경우: `--training-instance-type`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
모델 훈련에 사용되는 ML 인스턴스 유형입니다. 모든 Neptune ML 모델은 CPU, GPU 및 다중 GPU 훈련을 지원합니다. 기본값은 `ml.p3.2xlarge`입니다. 훈련에 적합한 인스턴스 유형을 선택하는 것은 작업 유형, 그래프 크기, 예산에 따라 달라집니다.
+ **trainingInstanceVolumeSizeInGB**(CLI의 경우: `--training-instance-volume-size-in-gb`) - Integer, 유형은 `integer`(32비트 부호 있는 정수)입니다.
훈련 인스턴스의 디스크 볼륨 크기입니다. 입력 데이터와 출력 모델 모두 디스크에 저장되므로 볼륨 크기는 두 데이터 집합을 모두 저장할 수 있을 만큼 커야 합니다. 기본값은 0입니다. 지정하지 않거나 0인 경우 Neptune ML은 데이터 처리 단계에서 생성된 권장 사항에 따라 디스크 볼륨 크기를 선택합니다.
+ **trainingTimeOutInSeconds**(CLI의 경우: `--training-time-out-in-seconds`) - Integer, 유형은 `integer`(32비트 부호 있는 정수)입니다.
훈련 작업의 제한 시간(초 단위)입니다. 기본값은 86,400(1일)입니다.
+ **trainModelS3Location**(CLI의 경우: `--train-model-s3-location`) - *필수:* String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
모델 아티팩트가 저장되는 Amazon S3의 위치입니다.
+ **volumeEncryptionKMSKey**(CLI의 경우: `--volume-encryption-kms-key`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
훈련 작업을 실행하는 ML 컴퓨팅 인스턴스에 연결된 스토리지 볼륨에서 데이터를 암호화하는 데 SageMaker가 사용하는 Amazon Key Management Service(Amazon KMS) 키입니다. 기본값은 없습니다.
**응답**:
+ **arn** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
새 모델 훈련 작업의 ARN입니다.
+ **creationTimeInMillis** - Long, 유형은 `long`(64비트 부호가 있는 정수)입니다.
모델 훈련 작업 생성 시간(밀리초 단위)입니다.
+ **id** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
새 모델 훈련 작업의 고유 ID입니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## ListMLModelTrainingJobs(작업)
이 API의 AWS CLI 이름은 `list-ml-model-training-jobs`입니다.
Neptune ML 모델 훈련 작업을 나열합니다. [`modeltraining` 명령을 사용한 모델 훈련](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html)을 참조합니다.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:neptune-db:ListMLModelTrainingJobs](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#neptune-db:listmlmodeltrainingjobs) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **maxItems**(CLI의 경우: `--max-items`) - ListMLModelTrainingJobsInputMaxItemsInteger, 유형은 1\$11,024자인 `integer`(32비트 부호 있는 정수)입니다.
반환할 항목의 최대 수입니다(1\$11024이며, 기본값은 10).
+ **neptuneIamRoleArn**(CLI의 경우: `--neptune-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker와 Amazon S3 리소스에 대한 Neptune의 액세스 권한을 제공하는 IAM 역할의 ARN입니다. 이는 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
**응답**:
+ **ids** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
모델 훈련 작업 ID 목록 페이지입니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## GetMLModelTrainingJob(작업)
이 API의 AWS CLI 이름은 `get-ml-model-training-job`입니다.
Neptune ML 모델 훈련 작업에 대한 정보를 검색합니다. [`modeltraining` 명령을 사용한 모델 훈련](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html)을 참조합니다.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:GetMLModelTrainingJobStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlmodeltrainingjobstatus) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **id**(CLI의 경우: `--id`) - *필수:* String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
검색할 모델 훈련 작업의 고유 식별자입니다.
+ **neptuneIamRoleArn**(CLI의 경우: `--neptune-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker와 Amazon S3 리소스에 대한 Neptune의 액세스 권한을 제공하는 IAM 역할의 ARN입니다. 이는 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
**응답**:
+ **hpoJob** – [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition) 객체입니다.
HPO 작업입니다.
+ **id** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
이 모델 훈련 작업의 고유 식별자입니다.
+ **mlModels** – [MlConfigDefinition](data-api-dp-ml-data-processing.md#MlConfigDefinition) 객체의 배열입니다.
사용 중인 ML 모델의 구성 목록입니다.
+ **modelTransformJob** – [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition) 객체입니다.
모델 변환 작업입니다.
+ **processingJob** – [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition) 객체입니다.
데이터 처리 작업입니다.
+ **status** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
모델 훈련 작업의 상태입니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## CancelMLModelTrainingJob(작업)
이 API의 AWS CLI 이름은 `cancel-ml-model-training-job`입니다.
Neptune ML 모델 훈련 작업을 취소합니다. [`modeltraining` 명령을 사용한 모델 훈련](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html)을 참조합니다.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:CancelMLModelTrainingJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltrainingjob) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **clean**(CLI의 경우: `--clean`) - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
`TRUE`로 설정된 경우 이 플래그는 작업이 중지될 때 모든 Amazon S3 아티팩트를 삭제하도록 지정합니다. 기본값은 `FALSE`입니다.
+ **id**(CLI의 경우: `--id`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
취소할 모델 훈련 작업의 고유 식별자입니다.
+ **neptuneIamRoleArn**(CLI의 경우: `--neptune-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker와 Amazon S3 리소스에 대한 Neptune의 액세스 권한을 제공하는 IAM 역할의 ARN입니다. 이는 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
**응답**:
+ **status** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
취소 상태입니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## *모델 훈련 구조:*
## CustomModelTrainingParameters(구조)
사용자 지정 모델 학습 파라미터가 포함되어 있습니다. [Neptune ML의 사용자 지정 모델](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-custom-models.html)을 참조합니다.
**Fields**
+ **sourceS3DirectoryPath** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
모델을 구현하는 Python 모듈이 위치한 Amazon S3 위치 경로입니다. 이는 최소한 훈련 스크립트, 변환 스크립트 및 `model-hpo-configuration.json` 파일을 포함하는 유효한 기존 Amazon S3 위치를 가리켜야 합니다.
+ **trainingEntryPointScript** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
모델 훈련을 수행하고 하이퍼파라미터를 명령줄 인수로 취하는 스크립트(예: 고정값 하이퍼파라미터)의 모듈 진입점 이름입니다. 기본값은 `training.py`입니다.
+ **transformEntryPointScript** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
모델 배포에 필요한 모델 아티팩트를 계산하기 위해 하이퍼파라미터 검색에서 최적의 모델을 식별한 후 실행해야 하는 스크립트의 모듈 내 진입점 이름입니다. 명령줄 인수 없이 실행할 수 있어야 하며 기본값은 `transform.py`입니다.
# Neptune ML 모델 변환 API
**모델 변환 작업:**
+ [StartMLModelTransformJob(작업)](#StartMLModelTransformJob)
+ [ListMLModelTransformJobs(작업)](#ListMLModelTransformJobs)
+ [GetMLModelTransformJob(작업)](#GetMLModelTransformJob)
+ [CancelMLModelTransformJob(작업)](#CancelMLModelTransformJob)
**모델 변환 구조:**
+ [CustomModelTransformParameters(구조)](#CustomModelTransformParameters)
## StartMLModelTransformJob(작업)
이 API의 AWS CLI 이름은 `start-ml-model-transform-job`입니다.
모델 변환 작업을 새로 생성합니다. [훈련된 모델을 사용하여 새 모델 아티팩트 생성](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html)을 참조합니다.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:StartMLModelTransformJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeltransformjob) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **baseProcessingInstanceType**(CLI의 경우: `--base-processing-instance-type`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
ML 모델 훈련 준비 및 관리에 사용되는 ML 인스턴스 유형입니다. 훈련 데이터 및 모델을 처리하는 데 필요한 메모리 요구 사항을 기반으로 선택된 ML 컴퓨팅 인스턴스입니다.
+ **baseProcessingInstanceVolumeSizeInGB**(CLI의 경우: `--base-processing-instance-volume-size-in-gb`) - Integer, 유형은 `integer`(32비트 부호 있는 정수)입니다.
훈련 인스턴스의 디스크 볼륨 크기(기가바이트 단위)입니다. 기본값은 0입니다. 입력 데이터와 출력 모델 모두 디스크에 저장되므로 볼륨 크기는 두 데이터 집합을 모두 저장할 수 있을 만큼 커야 합니다. 지정하지 않거나 0인 경우 Neptune ML은 데이터 처리 단계에서 생성된 권장 사항에 따라 디스크 볼륨 크기를 선택합니다.
+ **customModelTransformParameters**(CLI의 경우: `--custom-model-transform-parameters`) - [CustomModelTransformParameters](#CustomModelTransformParameters) 객체입니다.
사용자 지정 모델을 사용한 모델 변환의 구성 정보입니다. `customModelTransformParameters` 객체에는 다음 필드가 포함되며, 이 필드는 훈련 작업에서 저장된 모델 파라미터와 호환되는 값을 가져야 합니다.
+ **dataProcessingJobId**(CLI의 경우: `--data-processing-job-id`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
완료된 데이터 처리 작업의 작업 ID입니다. `dataProcessingJobId` 및 `mlModelTrainingJobId`를 포함하거나 `trainingJobName`을 지정해야 합니다.
+ **id**(CLI의 경우: `--id`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
새 작업의 고유 식별자입니다. 기본값은 자동 생성된 UUID입니다.
+ **mlModelTrainingJobId**(CLI의 경우: `--ml-model-training-job-id`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
완료된 모델 훈련 작업의 작업 ID입니다. `dataProcessingJobId` 및 `mlModelTrainingJobId`를 포함하거나 `trainingJobName`을 지정해야 합니다.
+ **modelTransformOutputS3Location**(CLI의 경우: `--model-transform-output-s3-location`) - *필수:* String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
모델 아티팩트가 저장되는 Amazon S3의 위치입니다.
+ **neptuneIamRoleArn**(CLI의 경우: `--neptune-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker와 Amazon S3 리소스에 대한 Neptune의 액세스 권한을 제공하는 IAM 역할의 ARN입니다. 이는 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
+ **s3OutputEncryptionKMSKey**(CLI의 경우: `--s-3-output-encryption-kms-key`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker가 처리 작업의 출력을 암호화하는 데 사용하는 Amazon Key Management Service(Amazon KMS) 키입니다. 기본값은 없습니다.
+ **sagemakerIamRoleArn**(CLI의 경우: `--sagemaker-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker를 실행하기 위한 IAM 역할의 ARN입니다. 이는 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
+ **securityGroupIds**(CLI의 경우: `--security-group-ids`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
VPC 보안 그룹 ID입니다. 기본값은 없습니다.
+ **subnets**(CLI의 경우: `--subnets`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
Neptune VPC의 서브넷 ID입니다. 기본값은 없습니다.
+ **trainingJobName**(CLI의 경우: `--training-job-name`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
완료한 SageMaker 훈련 작업의 이름입니다. `dataProcessingJobId` 및 `mlModelTrainingJobId`를 포함하거나 `trainingJobName`을 지정해야 합니다.
+ **volumeEncryptionKMSKey**(CLI의 경우: `--volume-encryption-kms-key`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
훈련 작업을 실행하는 ML 컴퓨팅 인스턴스에 연결된 스토리지 볼륨에서 데이터를 암호화하는 데 SageMaker가 사용하는 Amazon Key Management Service(Amazon KMS) 키입니다. 기본값은 없습니다.
**응답**:
+ **arn** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
모델 변환 작업의 ARN입니다.
+ **creationTimeInMillis** - Long, 유형은 `long`(64비트 부호 있는 정수)입니다.
모델 변환 작업 생성 시간(밀리초 단위)입니다.
+ **id** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
새 모델 변환 작업의 고유 ID입니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## ListMLModelTransformJobs(작업)
이 API의 AWS CLI 이름은 `list-ml-model-transform-jobs`입니다.
모델 변환 작업 ID 목록을 반환합니다. [훈련된 모델을 사용하여 새 모델 아티팩트 생성](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html)을 참조합니다.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:ListMLModelTransformJobs](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmlmodeltransformjobs) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **maxItems**(CLI의 경우: `--max-items`) - ListMLModelTransformJobsInputMaxItemsInteger, 유형은 1\$11,024자인 `integer`(32비트 부호 있는 정수)입니다.
반환할 항목의 최대 수입니다(1\$11024이며, 기본값은 10).
+ **neptuneIamRoleArn**(CLI의 경우: `--neptune-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker와 Amazon S3 리소스에 대한 Neptune의 액세스 권한을 제공하는 IAM 역할의 ARN입니다. 이는 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
**응답**:
+ **ids** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
모델 변환 ID 목록 페이지입니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## GetMLModelTransformJob(작업)
이 API의 AWS CLI 이름은 `get-ml-model-transform-job`입니다.
지정된 모델 변환 작업에 대한 정보를 가져옵니다. [훈련된 모델을 사용하여 새 모델 아티팩트 생성](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html)을 참조합니다.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:GetMLModelTransformJobStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlmodeltransformjobstatus) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **id**(CLI의 경우: `--id`) - *필수:* String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
다시 검색할 모델 변환 작업의 고유 식별자입니다.
+ **neptuneIamRoleArn**(CLI의 경우: `--neptune-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker와 Amazon S3 리소스에 대한 Neptune의 액세스 권한을 제공하는 IAM 역할의 ARN입니다. 이는 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
**응답**:
+ **baseProcessingJob** – [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition) 객체입니다.
기본 데이터 처리 작업입니다.
+ **id** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
검색될 모델 변환 작업의 고유 식별자입니다.
+ **models** – [MlConfigDefinition](data-api-dp-ml-data-processing.md#MlConfigDefinition) 객체의 배열입니다.
사용 중인 모델의 구성 정보 목록입니다.
+ **remoteModelTransformJob** – [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition) 객체입니다.
원격 모델 변환 작업입니다.
+ **status** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
모델 변환 작업의 상태입니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## CancelMLModelTransformJob(작업)
이 API의 AWS CLI 이름은 `cancel-ml-model-transform-job`입니다.
지정된 모델 변환 작업을 취소합니다. [훈련된 모델을 사용하여 새 모델 아티팩트 생성](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html)을 참조합니다.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:CancelMLModelTransformJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltransformjob) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **clean**(CLI의 경우: `--clean`) - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
플래그가 `TRUE`로 설정되면 모든 Neptune ML S3 아티팩트는 작업이 중지될 때 삭제됩니다. 기본값은 `FALSE`입니다.
+ **id**(CLI의 경우: `--id`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
취소할 모델 변환 작업의 고유 식별자입니다.
+ **neptuneIamRoleArn**(CLI의 경우: `--neptune-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker와 Amazon S3 리소스에 대한 Neptune의 액세스 권한을 제공하는 IAM 역할의 ARN입니다. 이는 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
**응답**:
+ **status** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
취소 상태입니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## *모델 변환 구조:*
## CustomModelTransformParameters(구조)
사용자 지정 모델 변환 파라미터가 포함되어 있습니다. [훈련된 모델을 사용하여 새 모델 아티팩트 생성](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html)을 참조합니다.
**Fields**
+ **sourceS3DirectoryPath** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
모델을 구현하는 Python 모듈이 위치한 Amazon S3 위치 경로입니다. 이는 최소한 훈련 스크립트, 변환 스크립트 및 `model-hpo-configuration.json` 파일을 포함하는 유효한 기존 Amazon S3 위치를 가리켜야 합니다.
+ **transformEntryPointScript** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
모델 배포에 필요한 모델 아티팩트를 계산하기 위해 하이퍼파라미터 검색에서 최적의 모델을 식별한 후 실행해야 하는 스크립트의 모듈 내 진입점 이름입니다. 명령줄 인수 없이 실행할 수 있어야 합니다. 기본값은 `transform.py`입니다.
# Neptune ML 추론 엔드포인트 API
**추론 엔드포인트 작업:**
+ [CreateMLEndpoint(작업)](#CreateMLEndpoint)
+ [ListMLEndpoints(작업)](#ListMLEndpoints)
+ [GetMLEndpoint(작업)](#GetMLEndpoint)
+ [DeleteMLEndpoint(작업)](#DeleteMLEndpoint)
## CreateMLEndpoint(작업)
이 API의 AWS CLI 이름은 `create-ml-endpoint`입니다.
모델 훈련 프로세스에서 구성한 특정 모델 하나를 쿼리할 수 있는 새 Neptune ML 추론 엔드포인트를 생성합니다. [엔드포인트 명령을 사용한 추론 엔드포인트 관리](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html)를 참조합니다.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:CreateMLEndpoint](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#createmlendpoint) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **id**(CLI의 경우: `--id`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
새 추론 엔드포인트의 고유 식별자입니다. 기본값은 자동 생성된 타임스탬프 이름입니다.
+ **instanceCount**(CLI의 경우: `--instance-count`) - Integer, 유형은 `integer`(32비트 부호 있는 정수)입니다.
예측을 위해 엔드포인트에 배포할 최소 Amazon EC2 인스턴스 수입니다. 기본값은 1입니다.
+ **instanceType**(CLI의 경우: `--instance-type`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
온라인 서비스에서 사용할 Neptune ML 인스턴스의 유형입니다. 기본값은 `ml.m5.xlarge`입니다. 추론 엔드포인트의 ML 인스턴스 유형을 선택하는 것은 작업 유형, 그래프 크기, 예산에 따라 달라집니다.
+ **mlModelTrainingJobId**(CLI의 경우: `--ml-model-training-job-id`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
추론 엔드포인트가 가리키는 모델을 생성하여 완료된 모델 훈련 작업의 작업 ID입니다. `mlModelTrainingJobId` 또는 `mlModelTransformJobId` 중 하나를 제공해야 합니다.
+ **mlModelTransformJobId**(CLI의 경우: `--ml-model-transform-job-id`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
완료된 모델 변환 작업의 작업 ID입니다. `mlModelTrainingJobId` 또는 `mlModelTransformJobId` 중 하나를 제공해야 합니다.
+ **modelName**(CLI의 경우: `--model-name`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
훈련용 모델 유형입니다. 기본적으로 Neptune ML 모델은 자동으로 데이터 처리에 사용되는 `modelType`을 기반으로 하지만 여기에서 다른 모델 유형을 지정할 수도 있습니다. 기본값은 이기종 그래프용 `rgcn` 및 지식 그래프용 `kge`입니다. 이기종 그래프의 유일한 유횻값은 `rgcn`입니다. 지식 그래프의 유횻값은`kge`, `transe`, `distmult`, `rotate`입니다.
+ **neptuneIamRoleArn**(CLI의 경우: `--neptune-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker와 Amazon S3 리소스에 대한 Neptune의 액세스 권한을 제공하는 IAM 역할의 ARN입니다. 이는 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
+ **update**(CLI의 경우: `--update`) - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
`true`로 설정하면 업데이터 요청을 나타내는 `update`가 나타납니다. 기본값은 `false`입니다. `mlModelTrainingJobId` 또는 `mlModelTransformJobId` 중 하나를 제공해야 합니다.
+ **volumeEncryptionKMSKey**(CLI의 경우: `--volume-encryption-kms-key`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
훈련 작업을 실행하는 ML 컴퓨팅 인스턴스에 연결된 스토리지 볼륨에서 데이터를 암호화하는 데 SageMaker가 사용하는 Amazon Key Management Service(Amazon KMS) 키입니다. 기본값은 없습니다.
**응답**:
+ **arn** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
새 추론 엔드포인트의 ARN입니다.
+ **creationTimeInMillis** - Long, 유형은 `long`(64비트 부호 있는 정수)입니다.
엔드포인트 생성 시간(밀리초 단위)입니다.
+ **id** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
새 추론 엔드포인트의 고유 ID입니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## ListMLEndpoints(작업)
이 API의 AWS CLI 이름은 `list-ml-endpoints`입니다.
기존 추론 엔드포인트를 나열합니다. [엔드포인트 명령을 사용한 추론 엔드포인트 관리](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html)를 참조합니다.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:ListMLEndpoints](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmlendpoints) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **maxItems**(CLI의 경우: `--max-items`) - ListMLEndpointsInputMaxItemsInteger, 유형은 1\$11,024자인 `integer`(32비트 부호 있는 정수)입니다.
반환할 항목의 최대 수입니다(1\$11024이며, 기본값은 10).
+ **neptuneIamRoleArn**(CLI의 경우: `--neptune-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker와 Amazon S3 리소스에 대한 Neptune의 액세스 권한을 제공하는 IAM 역할의 ARN입니다. 이는 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
**응답**:
+ **ids** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
추론 엔드포인트 ID 목록의 한 페이지입니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## GetMLEndpoint(작업)
이 API의 AWS CLI 이름은 `get-ml-endpoint`입니다.
추론 엔드포인트에 대한 세부 정보를 검색합니다. [엔드포인트 명령을 사용한 추론 엔드포인트 관리](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html)를 참조합니다.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:GetMLEndpointStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlendpointstatus) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **id**(CLI의 경우: `--id`) - *필수:* String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
추론 엔드포인트의 고유 식별자입니다.
+ **neptuneIamRoleArn**(CLI의 경우: `--neptune-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker와 Amazon S3 리소스에 대한 Neptune의 액세스 권한을 제공하는 IAM 역할의 ARN입니다. 이는 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
**응답**:
+ **endpoint** – [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition) 객체입니다.
엔드포인트 정의입니다.
+ **endpointConfig** – [MlConfigDefinition](data-api-dp-ml-data-processing.md#MlConfigDefinition) 객체입니다.
엔드포인트 구성입니다.
+ **id** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
추론 엔드포인트의 고유 식별자입니다.
+ **status** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
추론 엔드포인트의 상태입니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## DeleteMLEndpoint(작업)
이 API의 AWS CLI 이름은 `delete-ml-endpoint`입니다.
Neptune ML 추론 엔드포인트 생성을 취소합니다. [엔드포인트 명령을 사용한 추론 엔드포인트 관리](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html)를 참조합니다.
IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:DeleteMLEndpoint](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletemlendpoint) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.
**요청**
+ **clean**(CLI의 경우: `--clean`) - Boolean, 유형은 `boolean`(부울(true 또는 false) 값)입니다.
플래그가 `TRUE`로 설정되면 모든 Neptune ML S3 아티팩트는 작업이 중지될 때 삭제됩니다. 기본값은 `FALSE`입니다.
+ **id**(CLI의 경우: `--id`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**
추론 엔드포인트의 고유 식별자입니다.
+ **neptuneIamRoleArn**(CLI의 경우: `--neptune-iam-role-arn`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
SageMaker와 Amazon S3 리소스에 대한 Neptune의 액세스 권한을 제공하는 IAM 역할의 ARN입니다. 이는 DB 클러스터 파라미터 그룹에 나열되어 있어야 합니다. 그렇지 않으면 오류가 발생합니다.
**응답**:
+ **status** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
취소 상태입니다.
**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
# Neptune 데이터 영역 API 예외
**예외:**
+ [AccessDeniedException(구조)](#AccessDeniedException)
+ [BadRequestException(구조)](#BadRequestException)
+ [BulkLoadIdNotFoundException(구조)](#BulkLoadIdNotFoundException)
+ [CancelledByUserException(구조)](#CancelledByUserException)
+ [ClientTimeoutException(구조)](#ClientTimeoutException)
+ [ConcurrentModificationException(구조)](#ConcurrentModificationException)
+ [ConstraintViolationException(구조)](#ConstraintViolationException)
+ [ExpiredStreamException(구조)](#ExpiredStreamException)
+ [FailureByQueryException(구조)](#FailureByQueryException)
+ [IllegalArgumentException(구조)](#IllegalArgumentException)
+ [InternalFailureException(구조)](#InternalFailureException)
+ [InvalidArgumentException(구조)](#InvalidArgumentException)
+ [InvalidNumericDataException(구조)](#InvalidNumericDataException)
+ [InvalidParameterException(구조)](#InvalidParameterException)
+ [LoadUrlAccessDeniedException(구조)](#LoadUrlAccessDeniedException)
+ [MalformedQueryException(구조)](#MalformedQueryException)
+ [MemoryLimitExceededException(구조)](#MemoryLimitExceededException)
+ [MethodNotAllowedException(구조)](#MethodNotAllowedException)
+ [MissingParameterException(구조)](#MissingParameterException)
+ [MLResourceNotFoundException(구조)](#MLResourceNotFoundException)
+ [ParsingException(구조)](#ParsingException)
+ [PreconditionsFailedException(구조)](#PreconditionsFailedException)
+ [QueryLimitExceededException(구조)](#QueryLimitExceededException)
+ [QueryLimitException(구조)](#QueryLimitException)
+ [QueryTooLargeException(구조)](#QueryTooLargeException)
+ [ReadOnlyViolationException(구조)](#ReadOnlyViolationException)
+ [S3Exception(구조)](#S3Exception)
+ [ServerShutdownException(구조)](#ServerShutdownException)
+ [StatisticsNotAvailableException(구조)](#StatisticsNotAvailableException)
+ [StreamRecordsNotFoundException(구조)](#StreamRecordsNotFoundException)
+ [ThrottlingException(구조)](#ThrottlingException)
+ [TimeLimitExceededException(구조)](#TimeLimitExceededException)
+ [TooManyRequestsException(구조)](#TooManyRequestsException)
+ [UnsupportedOperationException(구조)](#UnsupportedOperationException)
+ [UnloadUrlAccessDeniedException(구조)](#UnloadUrlAccessDeniedException)
## AccessDeniedException(구조)
인증 또는 인증 실패 시 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## BadRequestException(구조)
처리할 수 없는 요청이 제출되었을 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
잘못된 요청의 ID입니다.
## BulkLoadIdNotFoundException(구조)
지정된 대량 로드 작업 ID를 찾을 수 없을 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
찾을 수 없는 대량 로드 작업 ID입니다.
## CancelledByUserException(구조)
사용자가 요청을 취소했을 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## ClientTimeoutException(구조)
클라이언트에서 요청 제한 시간이 초과되었을 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## ConcurrentModificationException(구조)
요청이 다른 프로세스에서 동시에 수정되는 데이터를 수정하려고 시도할 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## ConstraintViolationException(구조)
요청 필드의 값이 필수 제약 조건을 충족하지 않을 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## ExpiredStreamException(구조)
요청이 만료된 스트림에 액세스를 시도할 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## FailureByQueryException(구조)
요청이 실패하면 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## IllegalArgumentException(구조)
요청의 인수가 지원되지 않을 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## InternalFailureException(구조)
요청 처리가 예기치 않게 실패했을 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## InvalidArgumentException(구조)
요청의 인수에 잘못된 값이 있을 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## InvalidNumericDataException(구조)
요청을 제공할 때 잘못된 숫자 데이터가 발견되면 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## InvalidParameterException(구조)
파라미터 값이 유효하지 않을 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
잘못된 파라미터가 포함된 요청의 ID입니다.
## LoadUrlAccessDeniedException(구조)
지정된 로드 URL에 대한 액세스가 거부될 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## MalformedQueryException(구조)
구문상 올바르지 않거나 추가 검증을 통과하지 못한 쿼리가 제출될 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
잘못된 형식의 쿼리 요청 ID입니다.
## MemoryLimitExceededException(구조)
메모리 리소스가 부족하여 요청이 실패할 때 발생합니다. 요청을 재시도할 수 있습니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
실패한 요청의 ID입니다.
## MethodNotAllowedException(구조)
요청에 사용된 HTTP 메서드가 사용 중인 엔드포인트에서 지원되지 않을 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## MissingParameterException(구조)
필수 파라미터가 누락되면 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
파라미터가 누락된 요청의 ID입니다.
## MLResourceNotFoundException(구조)
지정된 기계 학습 리소스를 찾을 수 없을 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## ParsingException(구조)
구문 분석 문제가 있을 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## PreconditionsFailedException(구조)
요청 처리를 위한 전제 조건이 충족되지 않을 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## QueryLimitExceededException(구조)
사용 중인 쿼리 수가 서버가 처리할 수 있는 수를 초과할 때 발생합니다. 시스템 사용량이 적을 때 해당 쿼리를 다시 시도할 수 있습니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
제한을 초과한 요청의 ID입니다.
## QueryLimitException(구조)
쿼리 크기가 시스템 제한을 초과할 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
제한을 초과한 요청의 ID입니다.
## QueryTooLargeException(구조)
쿼리 본문이 너무 클 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
요청 ID가 너무 큽니다.
## ReadOnlyViolationException(구조)
요청이 읽기 전용 리소스에 쓰기를 시도할 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
파라미터가 누락된 요청의 ID입니다.
## S3Exception(구조)
Amazon S3에 액세스하는 데 문제가 있을 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## ServerShutdownException(구조)
요청을 처리하는 동안 서버가 종료될 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## StatisticsNotAvailableException(구조)
요청을 충족하는 데 필요한 통계를 사용할 수 없을 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## StreamRecordsNotFoundException(구조)
쿼리에서 요청한 스트림 레코드를 찾을 수 없을 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## ThrottlingException(구조)
요청 속도가 최대 처리량을 초과할 때 발생합니다. 이 예외가 발생한 후 요청을 재시도할 수 있습니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
이러한 이유로 처리할 수 없는 요청의 ID입니다.
## TimeLimitExceededException(구조)
작업이 허용된 시간 제한을 초과할 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
이러한 이유로 처리할 수 없는 요청의 ID입니다.
## TooManyRequestsException(구조)
처리 중인 요청 수가 제한을 초과할 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
이러한 이유로 처리할 수 없는 요청의 ID입니다.
## UnsupportedOperationException(구조)
요청이 지원되지 않는 작업을 시작하려고 시도할 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.
## UnloadUrlAccessDeniedException(구조)
언로드 대상인 URL에 대한 액세스가 거부될 때 발생합니다.
**Fields**
+ **code** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
HTTP 상태 코드가 예외와 반환됩니다.
+ **detailedMessage** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제를 설명하는 세부적인 메시지입니다.
+ **requestId** - *필수*는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.
문제의 요청 ID입니다.