Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
# Referensi API Data Amazon Neptunus
Bab ini mendokumentasikan operasi API data Neptunus yang dapat Anda gunakan untuk memuat, mengakses, dan memelihara data dalam grafik Neptunus Anda.
API data Neptunus menyediakan dukungan SDK untuk memuat data, menjalankan kueri, mendapatkan informasi tentang data Anda, dan menjalankan operasi pembelajaran mesin. Ini mendukung bahasa query Gremlin dan OpenCypher di Neptunus, dan tersedia dalam semua bahasa SDK. Ini secara otomatis menandatangani permintaan API dan sangat menyederhanakan integrasi Neptunus ke dalam aplikasi.
**Contents**
+ [Mesin dataplane Neptunus, reset cepat, dan struktur umum APIs](data-api-dp-environment-APIs.md)
+ [GetEngineStatus (tindakan)](data-api-dp-environment-APIs.md#GetEngineStatus)
+ [ExecuteFastReset (tindakan)](data-api-dp-environment-APIs.md#ExecuteFastReset)
+ [*Struktur operasi mesin:*](data-api-dp-environment-APIs.md#data-api-dp-environment-APIs-engine-operation-structures-spacer)
+ [QueryLanguageVersion (struktur)](data-api-dp-environment-APIs.md#QueryLanguageVersion)
+ [FastResetToken (struktur)](data-api-dp-environment-APIs.md#FastResetToken)
+ [Kueri Neptunus APIs](data-api-dp-queries.md)
+ [ExecuteGremlinQuery (tindakan)](data-api-dp-queries.md#ExecuteGremlinQuery)
+ [ExecuteGremlinExplainQuery (tindakan)](data-api-dp-queries.md#ExecuteGremlinExplainQuery)
+ [ExecuteGremlinProfileQuery (tindakan)](data-api-dp-queries.md#ExecuteGremlinProfileQuery)
+ [ListGremlinQueries (tindakan)](data-api-dp-queries.md#ListGremlinQueries)
+ [GetGremlinQueryStatus (tindakan)](data-api-dp-queries.md#GetGremlinQueryStatus)
+ [CancelGremlinQuery (tindakan)](data-api-dp-queries.md#CancelGremlinQuery)
+ [*Tindakan kueri OpenCypher:*](data-api-dp-queries.md#data-api-dp-queries-opencypher-query-actions-spacer)
+ [ExecuteOpenCypherQuery (tindakan)](data-api-dp-queries.md#ExecuteOpenCypherQuery)
+ [ExecuteOpenCypherExplainQuery (tindakan)](data-api-dp-queries.md#ExecuteOpenCypherExplainQuery)
+ [ListOpenCypherQueries (tindakan)](data-api-dp-queries.md#ListOpenCypherQueries)
+ [GetOpenCypherQueryStatus (tindakan)](data-api-dp-queries.md#GetOpenCypherQueryStatus)
+ [CancelOpenCypherQuery (tindakan)](data-api-dp-queries.md#CancelOpenCypherQuery)
+ [*Struktur kueri:*](data-api-dp-queries.md#data-api-dp-queries-query-structures-spacer)
+ [QueryEvalStats (struktur)](data-api-dp-queries.md#QueryEvalStats)
+ [GremlinQueryStatus (struktur)](data-api-dp-queries.md#GremlinQueryStatus)
+ [GremlinQueryStatusAttributes (struktur)](data-api-dp-queries.md#GremlinQueryStatusAttributes)
+ [Pemuat massal pesawat data Neptunus APIs](data-api-dp-loader.md)
+ [StartLoaderJob (tindakan)](data-api-dp-loader.md#StartLoaderJob)
+ [GetLoaderJobStatus (tindakan)](data-api-dp-loader.md#GetLoaderJobStatus)
+ [ListLoaderJobs (tindakan)](data-api-dp-loader.md#ListLoaderJobs)
+ [CancelLoaderJob (tindakan)](data-api-dp-loader.md#CancelLoaderJob)
+ [*Struktur beban massal:*](data-api-dp-loader.md#data-api-dp-loader-bulk-load-structure-spacer)
+ [LoaderIdResult (struktur)](data-api-dp-loader.md#LoaderIdResult)
+ [Neptunus mengalirkan API jalur data](data-api-dp-streams.md)
+ [GetPropertygraphStream (tindakan)](data-api-dp-streams.md#GetPropertygraphStream)
+ [*Struktur data aliran:*](data-api-dp-streams.md#data-api-dp-streams-stream-data-structures-spacer)
+ [PropertygraphRecord (struktur)](data-api-dp-streams.md#PropertygraphRecord)
+ [PropertygraphData (struktur)](data-api-dp-streams.md#PropertygraphData)
+ [Statistik jalur data Neptunus dan ringkasan grafik APIs](data-api-dp-statistics.md)
+ [GetPropertygraphStatistics (tindakan)](data-api-dp-statistics.md#GetPropertygraphStatistics)
+ [ManagePropertygraphStatistics (tindakan)](data-api-dp-statistics.md#ManagePropertygraphStatistics)
+ [DeletePropertygraphStatistics (tindakan)](data-api-dp-statistics.md#DeletePropertygraphStatistics)
+ [GetPropertygraphSummary (tindakan)](data-api-dp-statistics.md#GetPropertygraphSummary)
+ [*Struktur statistik:*](data-api-dp-statistics.md#data-api-dp-statistics-statistics-structures-spacer)
+ [Statistik (struktur)](data-api-dp-statistics.md#Statistics)
+ [StatisticsSummary (struktur)](data-api-dp-statistics.md#StatisticsSummary)
+ [DeleteStatisticsValueMap (struktur)](data-api-dp-statistics.md#DeleteStatisticsValueMap)
+ [RefreshStatisticsIdMap (struktur)](data-api-dp-statistics.md#RefreshStatisticsIdMap)
+ [NodeStructure (struktur)](data-api-dp-statistics.md#NodeStructure)
+ [EdgeStructure (struktur)](data-api-dp-statistics.md#EdgeStructure)
+ [SubjectStructure (struktur)](data-api-dp-statistics.md#SubjectStructure)
+ [PropertygraphSummaryValueMap (struktur)](data-api-dp-statistics.md#PropertygraphSummaryValueMap)
+ [PropertygraphSummary (struktur)](data-api-dp-statistics.md#PropertygraphSummary)
+ [API pemrosesan data Neptunus Neptunus](data-api-dp-ml-data-processing.md)
+ [Mulai MLData ProcessingJob (tindakan)](data-api-dp-ml-data-processing.md#StartMLDataProcessingJob)
+ [Daftar MLData ProcessingJobs (tindakan)](data-api-dp-ml-data-processing.md#ListMLDataProcessingJobs)
+ [Dapatkan MLData ProcessingJob (tindakan)](data-api-dp-ml-data-processing.md#GetMLDataProcessingJob)
+ [Batalkan MLData ProcessingJob (tindakan)](data-api-dp-ml-data-processing.md#CancelMLDataProcessingJob)
+ [*Struktur tujuan umum ML:*](data-api-dp-ml-data-processing.md#data-api-dp-ml-data-processing-ml-general-purpose-structures-spacer)
+ [MlResourceDefinition (struktur)](data-api-dp-ml-data-processing.md#MlResourceDefinition)
+ [MlConfigDefinition (struktur)](data-api-dp-ml-data-processing.md#MlConfigDefinition)
+ [API pelatihan model Neptunus Neptunus](data-api-dp-ml-training.md)
+ [Mulai MLModel TrainingJob (tindakan)](data-api-dp-ml-training.md#StartMLModelTrainingJob)
+ [Daftar MLModel TrainingJobs (tindakan)](data-api-dp-ml-training.md#ListMLModelTrainingJobs)
+ [Dapatkan MLModel TrainingJob (tindakan)](data-api-dp-ml-training.md#GetMLModelTrainingJob)
+ [Batalkan MLModel TrainingJob (tindakan)](data-api-dp-ml-training.md#CancelMLModelTrainingJob)
+ [*Struktur pelatihan model:*](data-api-dp-ml-training.md#data-api-dp-ml-training-model-training-structures-spacer)
+ [CustomModelTrainingParameters (struktur)](data-api-dp-ml-training.md#CustomModelTrainingParameters)
+ [Model Neptunus Neptunus mengubah API](data-api-dp-ml-transform.md)
+ [Mulai MLModel TransformJob (tindakan)](data-api-dp-ml-transform.md#StartMLModelTransformJob)
+ [Daftar MLModel TransformJobs (tindakan)](data-api-dp-ml-transform.md#ListMLModelTransformJobs)
+ [Dapatkan MLModel TransformJob (tindakan)](data-api-dp-ml-transform.md#GetMLModelTransformJob)
+ [Batalkan MLModel TransformJob (tindakan)](data-api-dp-ml-transform.md#CancelMLModelTransformJob)
+ [*Struktur transformasi model:*](data-api-dp-ml-transform.md#data-api-dp-ml-transform-model-transform-structures-spacer)
+ [CustomModelTransformParameters (struktur)](data-api-dp-ml-transform.md#CustomModelTransformParameters)
+ [API titik akhir inferensi Neptunus ML](data-api-dp-inference.md)
+ [Buat MLEndpoint (tindakan)](data-api-dp-inference.md#CreateMLEndpoint)
+ [Daftar MLEndpoints (tindakan)](data-api-dp-inference.md#ListMLEndpoints)
+ [Dapatkan MLEndpoint (tindakan)](data-api-dp-inference.md#GetMLEndpoint)
+ [Hapus MLEndpoint (tindakan)](data-api-dp-inference.md#DeleteMLEndpoint)
+ [Pengecualian API jalur data Neptunus](data-api-dp-errors.md)
+ [AccessDeniedException (struktur)](data-api-dp-errors.md#AccessDeniedException)
+ [BadRequestException (struktur)](data-api-dp-errors.md#BadRequestException)
+ [BulkLoadIdNotFoundException (struktur)](data-api-dp-errors.md#BulkLoadIdNotFoundException)
+ [CancelledByUserException (struktur)](data-api-dp-errors.md#CancelledByUserException)
+ [ClientTimeoutException (struktur)](data-api-dp-errors.md#ClientTimeoutException)
+ [ConcurrentModificationException (struktur)](data-api-dp-errors.md#ConcurrentModificationException)
+ [ConstraintViolationException (struktur)](data-api-dp-errors.md#ConstraintViolationException)
+ [ExpiredStreamException (struktur)](data-api-dp-errors.md#ExpiredStreamException)
+ [FailureByQueryException (struktur)](data-api-dp-errors.md#FailureByQueryException)
+ [IllegalArgumentException (struktur)](data-api-dp-errors.md#IllegalArgumentException)
+ [InternalFailureException (struktur)](data-api-dp-errors.md#InternalFailureException)
+ [InvalidArgumentException (struktur)](data-api-dp-errors.md#InvalidArgumentException)
+ [InvalidNumericDataException (struktur)](data-api-dp-errors.md#InvalidNumericDataException)
+ [InvalidParameterException (struktur)](data-api-dp-errors.md#InvalidParameterException)
+ [LoadUrlAccessDeniedException (struktur)](data-api-dp-errors.md#LoadUrlAccessDeniedException)
+ [MalformedQueryException (struktur)](data-api-dp-errors.md#MalformedQueryException)
+ [MemoryLimitExceededException (struktur)](data-api-dp-errors.md#MemoryLimitExceededException)
+ [MethodNotAllowedException (struktur)](data-api-dp-errors.md#MethodNotAllowedException)
+ [MissingParameterException (struktur)](data-api-dp-errors.md#MissingParameterException)
+ [MLResourceNotFoundException (struktur)](data-api-dp-errors.md#MLResourceNotFoundException)
+ [ParsingException (struktur)](data-api-dp-errors.md#ParsingException)
+ [PreconditionsFailedException (struktur)](data-api-dp-errors.md#PreconditionsFailedException)
+ [QueryLimitExceededException (struktur)](data-api-dp-errors.md#QueryLimitExceededException)
+ [QueryLimitException (struktur)](data-api-dp-errors.md#QueryLimitException)
+ [QueryTooLargeException (struktur)](data-api-dp-errors.md#QueryTooLargeException)
+ [ReadOnlyViolationException (struktur)](data-api-dp-errors.md#ReadOnlyViolationException)
+ [S3Exception (struktur)](data-api-dp-errors.md#S3Exception)
+ [ServerShutdownException (struktur)](data-api-dp-errors.md#ServerShutdownException)
+ [StatisticsNotAvailableException (struktur)](data-api-dp-errors.md#StatisticsNotAvailableException)
+ [StreamRecordsNotFoundException (struktur)](data-api-dp-errors.md#StreamRecordsNotFoundException)
+ [ThrottlingException (struktur)](data-api-dp-errors.md#ThrottlingException)
+ [TimeLimitExceededException (struktur)](data-api-dp-errors.md#TimeLimitExceededException)
+ [TooManyRequestsException (struktur)](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException (struktur)](data-api-dp-errors.md#UnsupportedOperationException)
+ [UnloadUrlAccessDeniedException (struktur)](data-api-dp-errors.md#UnloadUrlAccessDeniedException)
# Mesin dataplane Neptunus, reset cepat, dan struktur umum APIs
**Operasi mesin:**
+ [GetEngineStatus (tindakan)](#GetEngineStatus)
+ [ExecuteFastReset (tindakan)](#ExecuteFastReset)
**Struktur operasi mesin:**
+ [QueryLanguageVersion (struktur)](#QueryLanguageVersion)
+ [FastResetToken (struktur)](#FastResetToken)
## GetEngineStatus (tindakan)
Nama AWS CLI untuk API ini adalah:. `get-engine-status`
Mengambil status database grafik pada host.
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan otentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getenginestatus) cluster itu. GetEngineStatus
**Permintaan**
+ *Tidak ada parameter Permintaan.*
**Respons**
+ **dbEngineVersion**— String, tipe: `string` (string yang dikodekan UTF-8).
Setel ke versi mesin Neptunus yang berjalan di cluster DB Anda. Jika versi mesin ini telah di-patch secara manual sejak dirilis, nomor versi diawali dengan `Patch-`.
+ **dfeQueryEngine**— String, tipe: `string` (string yang dikodekan UTF-8).
Setel ke `enabled` jika mesin DFE sepenuhnya diaktifkan, atau ke `viaQueryHint` (default) jika mesin DFE hanya digunakan dengan kueri yang memiliki petunjuk kueri yang disetel ke`useDFE`. `true`
+ **features**— Ini adalah array peta pasangan kunci-nilai di mana:
Setiap kunci adalah String, tipe: `string` (string yang dikodekan UTF-8).
Setiap nilai adalah Dokumen, tipe: `document` (konten terbuka protokol-agnostik yang diwakili oleh model data seperti JSON).
Berisi informasi status tentang fitur yang diaktifkan pada cluster DB Anda.
+ **gremlin** — Sebuah objek [QueryLanguageVersion](#QueryLanguageVersion).
Berisi informasi tentang bahasa kueri Gremlin yang tersedia di cluster Anda. Secara khusus, ini berisi bidang versi yang menentukan TinkerPop versi saat ini yang digunakan oleh mesin.
+ **labMode**— Ini adalah array peta pasangan kunci-nilai di mana:
Setiap kunci adalah String, tipe: `string` (string yang dikodekan UTF-8).
Setiap nilai adalah String, tipe: `string` (string yang dikodekan UTF-8).
Berisi pengaturan Mode Lab yang digunakan oleh mesin.
+ **opencypher** — Sebuah objek [QueryLanguageVersion](#QueryLanguageVersion).
Berisi informasi tentang bahasa query OpenCypher yang tersedia di cluster Anda. Secara khusus, ini berisi bidang versi yang menentukan versi OperCypher saat ini yang digunakan oleh mesin.
+ **role**— String, tipe: `string` (string yang dikodekan UTF-8).
Setel ke `reader` jika instance adalah read-replica, atau ke `writer` jika instance adalah instance utama.
+ **rollingBackTrxCount**— Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Jika ada transaksi yang digulung kembali, bidang ini diatur ke jumlah transaksi tersebut. Jika tidak ada, bidang tidak muncul sama sekali.
+ **rollingBackTrxEarliestStartTime**— String, tipe: `string` (string yang dikodekan UTF-8).
Atur ke waktu mulai transaksi paling awal yang digulirkan kembali. Jika tidak ada transaksi yang diputar kembali, bidang tidak muncul sama sekali.
+ **settings**— Ini adalah array peta pasangan kunci-nilai di mana:
Setiap kunci adalah String, tipe: `string` (string yang dikodekan UTF-8).
Setiap nilai adalah String, tipe: `string` (string yang dikodekan UTF-8).
Berisi informasi tentang pengaturan saat ini pada cluster DB Anda. Misalnya, berisi pengaturan batas waktu kueri klaster saat ini (`clusterQueryTimeoutInMs`).
+ **sparql** — Sebuah objek [QueryLanguageVersion](#QueryLanguageVersion).
Berisi informasi tentang bahasa kueri SPARQL yang tersedia di klaster Anda. Secara khusus, ini berisi bidang versi yang menentukan versi SPARQL saat ini yang digunakan oleh mesin.
+ **startTime**— String, tipe: `string` (string yang dikodekan UTF-8).
Setel ke waktu UTC di mana proses server saat ini dimulai.
+ **status**— String, tipe: `string` (string yang dikodekan UTF-8).
Setel ke `healthy` jika instance tidak mengalami masalah. Jika instance pulih dari crash atau dari reboot dan ada transaksi aktif yang berjalan dari shutdown server terbaru, status diatur ke. `recovery`
**Kesalahan**
+ [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 (tindakan)
Nama AWS CLI untuk API ini adalah:. `execute-fast-reset`
REST API reset cepat memungkinkan Anda mengatur ulang grafik Neptunus dengan cepat dan mudah, menghapus semua datanya.
Reset cepat Neptunus adalah proses dua langkah. Pertama Anda menelepon `ExecuteFastReset` dengan `action` set ke`initiateDatabaseReset`. Ini mengembalikan token UUID yang kemudian Anda sertakan saat memanggil `ExecuteFastReset` lagi dengan `action` set ke. `performDatabaseReset` Lihat [Mengosongkan klaster DB Amazon Neptunus menggunakan API reset cepat.](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-fast-reset.html)
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan otentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#resetdatabase) cluster itu. ResetDatabase
**Permintaan**
+ **action**(dalam CLI:`--action`) - *Diperlukan: Tindakan, tipe:* `string` (string yang dikodekan UTF-8).
Tindakan reset cepat. Salah satu nilai berikut:
+ **`initiateDatabaseReset`**— Tindakan ini menghasilkan token unik yang diperlukan untuk benar-benar melakukan reset cepat.
+ **`performDatabaseReset`**— Tindakan ini menggunakan token yang dihasilkan oleh `initiateDatabaseReset` tindakan untuk benar-benar melakukan reset cepat.
+ **token**(dalam CLI:`--token`) — String, tipe: `string` (string yang dikodekan UTF-8).
Token reset cepat untuk memulai reset.
**Respons**
+ **payload** — Sebuah objek [FastResetToken](#FastResetToken).
Hanya `payload` dikembalikan oleh `initiateDatabaseReset` tindakan, dan berisi token unik untuk digunakan dengan `performDatabaseReset` tindakan untuk membuat reset terjadi.
+ **status**— *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Hanya `status` dikembalikan untuk `performDatabaseReset` tindakan, dan menunjukkan apakah rquest reset cepat diterima atau tidak.
**Kesalahan**
+ [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)
## *Struktur operasi mesin:*
## QueryLanguageVersion (struktur)
Struktur untuk mengekspresikan versi bahasa kueri.
**Bidang**
+ **version**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Versi bahasa kueri.
## FastResetToken (struktur)
Struktur yang berisi token reset cepat yang digunakan untuk memulai reset cepat.
**Bidang**
+ **token**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Sebuah UUID dihasilkan oleh database dalam `initiateDatabaseReset` tindakan, dan kemudian dikonsumsi oleh `performDatabaseReset` untuk mengatur ulang database.
# Kueri Neptunus APIs
**Tindakan kueri Gremlin:**
+ [ExecuteGremlinQuery (tindakan)](#ExecuteGremlinQuery)
+ [ExecuteGremlinExplainQuery (tindakan)](#ExecuteGremlinExplainQuery)
+ [ExecuteGremlinProfileQuery (tindakan)](#ExecuteGremlinProfileQuery)
+ [ListGremlinQueries (tindakan)](#ListGremlinQueries)
+ [GetGremlinQueryStatus (tindakan)](#GetGremlinQueryStatus)
+ [CancelGremlinQuery (tindakan)](#CancelGremlinQuery)
**Tindakan kueri OpenCypher:**
+ [ExecuteOpenCypherQuery (tindakan)](#ExecuteOpenCypherQuery)
+ [ExecuteOpenCypherExplainQuery (tindakan)](#ExecuteOpenCypherExplainQuery)
+ [ListOpenCypherQueries (tindakan)](#ListOpenCypherQueries)
+ [GetOpenCypherQueryStatus (tindakan)](#GetOpenCypherQueryStatus)
+ [CancelOpenCypherQuery (tindakan)](#CancelOpenCypherQuery)
**Struktur kueri:**
+ [QueryEvalStats (struktur)](#QueryEvalStats)
+ [GremlinQueryStatus (struktur)](#GremlinQueryStatus)
+ [GremlinQueryStatusAttributes (struktur)](#GremlinQueryStatusAttributes)
## ExecuteGremlinQuery (tindakan)
Nama AWS CLI untuk API ini adalah:. `execute-gremlin-query`
Perintah ini mengeksekusi query Gremlin. [Amazon Neptunus kompatibel dengan TinkerPop Apache 3 dan Gremlin, sehingga Anda dapat menggunakan bahasa traversal Gremlin untuk menanyakan grafik, seperti yang dijelaskan di bawah Grafik dalam dokumentasi Apache 3.](https://tinkerpop.apache.org/docs/current/reference/#graph) TinkerPop Rincian lebih lanjut juga dapat ditemukan di [Mengakses grafik Neptunus dengan Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin.html).
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan salah satu tindakan IAM berikut di cluster itu, tergantung pada kueri:
+ [neptunus-db: ReadDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery)
+ [neptunus-db: WriteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery)
+ [neptunus-db: DeleteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery)
[Perhatikan bahwa kunci kondisi [QueryLanguageIAM neptune-db ::Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) dapat digunakan dalam dokumen kebijakan untuk membatasi penggunaan kueri Gremlin (lihat Kunci kondisi yang tersedia di pernyataan kebijakan akses data IAM Neptunus).](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)
**Permintaan**
+ **gremlinQuery**(dalam CLI:`--gremlin-query`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
Dengan menggunakan API ini, Anda dapat menjalankan kueri Gremlin dalam format string sebanyak yang Anda bisa menggunakan endpoint HTTP. Antarmuka kompatibel dengan versi Gremlin apa pun yang digunakan cluster DB Anda (lihat [bagian klien Tinkerpop](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-client.html#best-practices-gremlin-java-latest) untuk menentukan Gremlin mana yang merilis versi mesin Anda yang didukung).
+ **serializer**(dalam CLI:`--serializer`) — String, tipe: `string` (string yang dikodekan UTF-8).
Jika non-null, hasil query dikembalikan dalam pesan respon serial dalam format yang ditentukan oleh parameter ini. Lihat bagian [GraphSon](https://tinkerpop.apache.org/docs/current/reference/#_graphson) dalam TinkerPop dokumentasi untuk daftar format yang saat ini didukung.
**Respons**
+ **meta**— Dokumen, tipe: `document` (konten terbuka protokol-agnostik yang diwakili oleh model data seperti JSON).
Metadata tentang kueri Gremlin.
+ **requestId**— String, tipe: `string` (string yang dikodekan UTF-8).
Pengidentifikasi unik dari kueri Gremlin.
+ **result**— Dokumen, tipe: `document` (konten terbuka protokol-agnostik yang diwakili oleh model data seperti JSON).
Output query Gremlin dari server.
+ **status** — Sebuah objek [GremlinQueryStatusAttributes](#GremlinQueryStatusAttributes).
Status kueri Gremlin.
**Kesalahan**
+ [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 (tindakan)
Nama AWS CLI untuk API ini adalah:. `execute-gremlin-explain-query`
Mengeksekusi kueri Gremlin Expline.
Amazon Neptunus telah menambahkan fitur Gremlin `explain` bernama yang menyediakan alat swalayan untuk memahami pendekatan eksekusi yang diambil oleh mesin Neptunus untuk kueri. Anda memintanya dengan menambahkan parameter `explain` ke panggilan HTTP yang mengirimkan kueri Gremlin.
Fitur menjelaskan memberikan informasi tentang struktur logis dari rencana eksekusi kueri. [Anda dapat menggunakan informasi ini untuk mengidentifikasi potensi kemacetan evaluasi dan eksekusi dan untuk menyetel kueri Anda, seperti yang dijelaskan dalam kueri Tuning Gremlin.](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html) Anda juga dapat menggunakan petunjuk kueri untuk meningkatkan rencana eksekusi kueri.
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan otentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan salah satu tindakan IAM berikut di cluster itu, tergantung pada kueri:
+ [neptunus-db: ReadDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery)
+ [neptunus-db: WriteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery)
+ [neptunus-db: DeleteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery)
[Perhatikan bahwa kunci kondisi [QueryLanguageIAM neptune-db ::Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) dapat digunakan dalam dokumen kebijakan untuk membatasi penggunaan kueri Gremlin (lihat Kunci kondisi yang tersedia di pernyataan kebijakan akses data IAM Neptunus).](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)
**Permintaan**
+ **gremlinQuery**(dalam CLI:`--gremlin-query`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
Gremlin menjelaskan string kueri.
**Respons**
+ **output**— a ReportAsText, tipe: `blob` (blok data biner yang tidak ditafsirkan).
Gumpalan teks yang berisi Gremlin menjelaskan hasil, seperti yang dijelaskan dalam kueri [Tuning](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html) Gremlin.
**Kesalahan**
+ [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 (tindakan)
Nama AWS CLI untuk API ini adalah:. `execute-gremlin-profile-query`
Mengeksekusi kueri Profil Gremlin, yang menjalankan traversal tertentu, mengumpulkan berbagai metrik tentang proses, dan menghasilkan laporan profil sebagai output. Lihat [API profil Gremlin di Neptunus](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html) untuk detailnya.
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery) cluster itu. ReadDataViaQuery
[Perhatikan bahwa kunci kondisi [QueryLanguageIAM neptune-db ::Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) dapat digunakan dalam dokumen kebijakan untuk membatasi penggunaan kueri Gremlin (lihat Kunci kondisi yang tersedia di pernyataan kebijakan akses data IAM Neptunus).](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)
**Permintaan**
+ **chop**(dalam CLI:`--chop`) — Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Jika non-nol, menyebabkan hasil string akan dipotong pada jumlah karakter tersebut. Jika diatur ke nol, string berisi semua hasil.
+ **gremlinQuery**(dalam CLI:`--gremlin-query`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
String kueri Gremlin ke profil.
+ **indexOps**(dalam CLI:`--index-ops`) — Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Jika tanda ini disetel ke`TRUE`, hasilnya menyertakan laporan terperinci dari semua operasi indeks yang terjadi selama eksekusi kueri dan serialisasi.
+ **results**(dalam CLI:`--results`) — Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Jika tanda ini disetel ke`TRUE`, hasil kueri dikumpulkan dan ditampilkan sebagai bagian dari laporan profil. Jika`FALSE`, hanya jumlah hasil yang ditampilkan.
+ **serializer**(dalam CLI:`--serializer`) — String, tipe: `string` (string yang dikodekan UTF-8).
Jika non-null, hasil yang dikumpulkan dikembalikan dalam pesan respons serial dalam format yang ditentukan oleh parameter ini. Lihat [API profil Gremlin di Neptunus](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html) untuk informasi selengkapnya.
**Respons**
+ **output**— a ReportAsText, tipe: `blob` (blok data biner yang tidak ditafsirkan).
Gumpalan teks yang berisi hasil Profil Gremlin. Lihat [API profil Gremlin di Neptunus](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html) untuk detailnya.
**Kesalahan**
+ [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 (tindakan)
Nama AWS CLI untuk API ini adalah:. `list-gremlin-queries`
Daftar kueri Gremlin aktif. Lihat [API status kueri Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html) untuk detail tentang output.
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) cluster itu. GetQueryStatus
[Perhatikan bahwa kunci kondisi [QueryLanguageIAM neptune-db ::Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) dapat digunakan dalam dokumen kebijakan untuk membatasi penggunaan kueri Gremlin (lihat Kunci kondisi yang tersedia di pernyataan kebijakan akses data IAM Neptunus).](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)
**Permintaan**
+ **includeWaiting**(dalam CLI:`--include-waiting`) — Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Jika disetel ke`TRUE`, daftar yang dikembalikan menyertakan kueri tunggu. Defaultnya adalah`FALSE`;
**Respons**
+ **acceptedQueryCount**— Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Jumlah kueri yang telah diterima tetapi belum selesai, termasuk kueri dalam antrian.
+ **queries** – Susunan objek [GremlinQueryStatus](#GremlinQueryStatus).
Daftar kueri saat ini.
+ **runningQueryCount**— Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Jumlah kueri Gremlin yang sedang berjalan.
**Kesalahan**
+ [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 (tindakan)
Nama AWS CLI untuk API ini adalah:. `get-gremlin-query-status`
Mendapat status query Gremlin tertentu.
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) cluster itu. GetQueryStatus
[Perhatikan bahwa kunci kondisi [QueryLanguageIAM neptune-db ::Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) dapat digunakan dalam dokumen kebijakan untuk membatasi penggunaan kueri Gremlin (lihat Kunci kondisi yang tersedia di pernyataan kebijakan akses data IAM Neptunus).](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)
**Permintaan**
+ **queryId**(dalam CLI:`--query-id`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
Pengidentifikasi unik yang mengidentifikasi kueri Gremlin.
**Respons**
+ **queryEvalStats** — Sebuah objek [QueryEvalStats](#QueryEvalStats).
Status evaluasi kueri Gremlin.
+ **queryId**— String, tipe: `string` (string yang dikodekan UTF-8).
ID kueri yang statusnya dikembalikan.
+ **queryString**— String, tipe: `string` (string yang dikodekan UTF-8).
String kueri Gremlin.
**Kesalahan**
+ [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 (tindakan)
Nama AWS CLI untuk API ini adalah:. `cancel-gremlin-query`
Membatalkan kueri Gremlin. Lihat [pembatalan kueri Gremlin untuk informasi selengkapnya](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status-cancel.html).
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery) cluster itu. CancelQuery
**Permintaan**
+ **queryId**(dalam CLI:`--query-id`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
Pengidentifikasi unik yang mengidentifikasi kueri yang akan dibatalkan.
**Respons**
+ **status**— String, tipe: `string` (string yang dikodekan UTF-8).
Status pembatalan
**Kesalahan**
+ [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)
## *Tindakan kueri OpenCypher:*
## ExecuteOpenCypherQuery (tindakan)
Nama AWS CLI untuk API ini adalah:. `execute-open-cypher-query`
Mengeksekusi query OpenCypher. Lihat [Mengakses Grafik Neptunus dengan OpenCypher untuk informasi](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher.html) lebih lanjut.
Neptunus mendukung pembuatan aplikasi grafik menggunakan OpenCypher, yang saat ini merupakan salah satu bahasa kueri paling populer di kalangan pengembang yang bekerja dengan database grafik. Pengembang, analis bisnis, dan ilmuwan data menyukai sintaks deklaratif dan terinspirasi SQL OpenCypher karena menyediakan struktur yang akrab untuk menanyakan grafik properti.
Bahasa OpenCypher awalnya dikembangkan oleh Neo4j, kemudian bersumber terbuka pada tahun 2015 dan berkontribusi pada proyek [OpenCypher](https://opencypher.org/) di bawah lisensi open-source Apache 2.
Perhatikan bahwa saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan salah satu tindakan IAM berikut di klaster tersebut, tergantung pada kueri:
+ [neptunus-db: ReadDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery)
+ [neptunus-db: WriteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery)
+ [neptunus-db: DeleteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery)
Perhatikan juga bahwa kunci kondisi OpenCypher IAM [neptune-db:QueryLanguage:](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) dapat digunakan dalam dokumen kebijakan untuk membatasi penggunaan kueri OpenCypher (lihat [Kunci](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) kondisi yang tersedia dalam pernyataan kebijakan akses data IAM Neptunus).
**Permintaan**
+ **openCypherQuery**(dalam CLI:`--open-cypher-query`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
String query OpenCypher yang akan dieksekusi.
+ **parameters**(dalam CLI:`--parameters`) — String, tipe: `string` (string yang dikodekan UTF-8).
Parameter query OpenCypher untuk eksekusi query. Lihat [Contoh kueri parameter OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/opencypher-parameterized-queries.html) untuk informasi selengkapnya.
**Respons**
+ **results**— *Diperlukan:* Dokumen, tipe: `document` (konten terbuka protokol-agnostik yang diwakili oleh model data seperti JSON).
Hasil OpenCypherQuery.
**Kesalahan**
+ [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 (tindakan)
Nama AWS CLI untuk API ini adalah:. `execute-open-cypher-explain-query`
Mengeksekusi permintaan OpenCypher`explain`. Lihat [fitur penjelasan OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-explain.html) untuk informasi selengkapnya.
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery) cluster itu. ReadDataViaQuery
Perhatikan bahwa kunci kondisi OpenCypher IAM [neptune-db:QueryLanguage:](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) dapat digunakan dalam dokumen kebijakan untuk membatasi penggunaan kueri OpenCypher (lihat [Kunci](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) kondisi yang tersedia dalam pernyataan kebijakan akses data IAM Neptunus).
**Permintaan**
+ **explainMode**(dalam CLI:`--explain-mode`) - *Wajib: an OpenCypherExplainMode, tipe:* `string` (string yang dikodekan UTF-8).
Mode OpenCypher`explain`. Bisa menjadi salah satu dari:`static`,`dynamic`, atau`details`.
+ **openCypherQuery**(dalam CLI:`--open-cypher-query`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
String query OpenCypher.
+ **parameters**(dalam CLI:`--parameters`) — String, tipe: `string` (string yang dikodekan UTF-8).
Parameter kueri OpenCypher.
**Respons**
+ **results**— *Diperlukan:* Gumpalan, tipe: `blob` (blok data biner yang tidak ditafsirkan).
Sebuah gumpalan teks yang berisi hasil OpenCypher`explain`.
**Kesalahan**
+ [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 (tindakan)
Nama AWS CLI untuk API ini adalah:. `list-open-cypher-queries`
Daftar query OpenCypher aktif. Lihat titik akhir [status Neptunus OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html) untuk informasi lebih lanjut.
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) cluster itu. GetQueryStatus
Perhatikan bahwa kunci kondisi OpenCypher IAM [neptune-db:QueryLanguage:](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) dapat digunakan dalam dokumen kebijakan untuk membatasi penggunaan kueri OpenCypher (lihat [Kunci](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) kondisi yang tersedia dalam pernyataan kebijakan akses data IAM Neptunus).
**Permintaan**
+ **includeWaiting**(dalam CLI:`--include-waiting`) — Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Ketika disetel ke `TRUE` dan parameter lain tidak ada, menyebabkan informasi status dikembalikan untuk kueri menunggu serta untuk menjalankan kueri.
**Respons**
+ **acceptedQueryCount**— Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Jumlah kueri yang telah diterima tetapi belum selesai, termasuk kueri dalam antrian.
+ **queries** – Susunan objek [GremlinQueryStatus](#GremlinQueryStatus).
Daftar kueri OpenCypher saat ini.
+ **runningQueryCount**— Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Jumlah kueri OpenCypher yang sedang berjalan.
**Kesalahan**
+ [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 (tindakan)
Nama AWS CLI untuk API ini adalah:. `get-open-cypher-query-status`
Mengambil status query OpenCypher tertentu.
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) cluster itu. GetQueryStatus
Perhatikan bahwa kunci kondisi OpenCypher IAM [neptune-db:QueryLanguage:](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) dapat digunakan dalam dokumen kebijakan untuk membatasi penggunaan kueri OpenCypher (lihat [Kunci](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) kondisi yang tersedia dalam pernyataan kebijakan akses data IAM Neptunus).
**Permintaan**
+ **queryId**(dalam CLI:`--query-id`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
ID unik dari query OpenCypher untuk mengambil status query.
**Respons**
+ **queryEvalStats** — Sebuah objek [QueryEvalStats](#QueryEvalStats).
Status evaluasi kueri OpenCypher.
+ **queryId**— String, tipe: `string` (string yang dikodekan UTF-8).
ID unik dari kueri yang statusnya dikembalikan.
+ **queryString**— String, tipe: `string` (string yang dikodekan UTF-8).
String query OpenCypher.
**Kesalahan**
+ [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 (tindakan)
Nama AWS CLI untuk API ini adalah:. `cancel-open-cypher-query`
Membatalkan query OpenCypher tertentu. Lihat titik akhir [status Neptunus OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html) untuk informasi lebih lanjut.
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery) cluster itu. CancelQuery
**Permintaan**
+ **queryId**(dalam CLI:`--query-id`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
ID unik dari kueri OpenCypher untuk dibatalkan.
+ **silent**(dalam CLI:`--silent`) — Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Jika disetel ke`TRUE`, menyebabkan pembatalan kueri OpenCypher terjadi secara diam-diam.
**Respons**
+ **payload**— Boolean, tipe: `boolean` (nilai Boolean (benar atau salah)).
Payload pembatalan untuk kueri OpenCypher.
+ **status**— String, tipe: `string` (string yang dikodekan UTF-8).
Status pembatalan kueri OpenCypher.
**Kesalahan**
+ [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)
## *Struktur kueri:*
## QueryEvalStats (struktur)
Struktur untuk menangkap statistik kueri seperti berapa banyak kueri yang berjalan, diterima atau menunggu dan detailnya.
**Bidang**
+ **cancelled**— Ini adalah Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Setel ke `TRUE` jika kueri dibatalkan, atau FALSE sebaliknya.
+ **elapsed**— Ini adalah Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Jumlah milidetik kueri telah berjalan sejauh ini.
+ **subqueries**— Ini adalah Dokumen, dari tipe: `document` (konten terbuka protokol-agnostik yang diwakili oleh model data seperti JSON).
Jumlah subquery dalam query ini.
+ **waited**— Ini adalah Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Menunjukkan berapa lama kueri menunggu, dalam milidetik.
## GremlinQueryStatus (struktur)
Menangkap status kueri Gremlin (lihat halaman API status kueri [Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html)).
**Bidang**
+ **queryEvalStats**Ini adalah sebuah [QueryEvalStats](#QueryEvalStats) objek.
Statistik kueri dari kueri Gremlin.
+ **queryId**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
ID dari kueri Gremlin.
+ **queryString**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
String query dari query Gremlin.
## GremlinQueryStatusAttributes (struktur)
Berisi komponen status dari query Gremlin.
**Bidang**
+ **attributes**— Ini adalah Dokumen, dari tipe: `document` (konten terbuka protokol-agnostik yang diwakili oleh model data seperti JSON).
Atribut status kueri Gremlin.
+ **code**— Ini adalah Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Kode respons HTTP dikembalikan dari permintaan kueri Gremlin..
+ **message**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Pesan status.
# Pemuat massal pesawat data Neptunus APIs
**Tindakan beban massal:**
+ [StartLoaderJob (tindakan)](#StartLoaderJob)
+ [GetLoaderJobStatus (tindakan)](#GetLoaderJobStatus)
+ [ListLoaderJobs (tindakan)](#ListLoaderJobs)
+ [CancelLoaderJob (tindakan)](#CancelLoaderJob)
**Struktur beban massal:**
+ [LoaderIdResult (struktur)](#LoaderIdResult)
## StartLoaderJob (tindakan)
Nama AWS CLI untuk API ini adalah:. `start-loader-job`
Memulai tugas pemuat massal Neptunus untuk memuat data dari bucket Amazon S3 ke instans DB Neptunus. Lihat [Menggunakan Amazon Neptune Bulk Loader](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load.html) untuk Menyerap Data.
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startloaderjob) cluster itu. StartLoaderJob
**Permintaan**
+ **dependencies**(dalam CLI:`--dependencies`) — String, tipe: `string` (string yang dikodekan UTF-8).
Ini adalah parameter opsional yang dapat membuat permintaan beban antrian bergantung pada keberhasilan penyelesaian satu atau lebih pekerjaan sebelumnya dalam antrian.
Neptune dapat mengantrekan sebanyak 64 permintaan pemuatan sekaligus, jika parameter `queueRequest` permintaannya diatur ke `"TRUE"`. Parameter `dependencies` memungkinkan Anda melakukan eksekusi seperti permintaan mengantre yang tergantung pada penyelesaian yang berhasil dari satu atau lebih permintaan ditentukan sebelumnya dalam antrean.
Misalnya, jika pemuatan `Job-A` dan `Job-B` independen satu sama lain, namun pemuatan `Job-C` membutuhkan `Job-A` dan `Job-B` harus selesai sebelum dimulai, lanjutkan sebagai berikut:
1. Kirim `load-job-A` dan `load-job-B` satu demi satu dalam urutan apa pun, dan simpan load-id mereka.
1. Kirim `load-job-C` dengan load-id dari dua pekerjaan di bidang `dependencies`-nya:
**Example**
```
"dependencies" : ["(job_A_load_id)", "(job_B_load_id)"]
```
Karena parameter `dependencies`, loader massal tidak akan memulai `Job-C` sampai `Job-A` dan `Job-B` telah berhasil diselesaikan. Jika salah satu dari mereka gagal, Job-C tidak akan dieksekusi, dan statusnya akan diatur ke `LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED`.
Anda dapat mengatur beberapa tingkat ketergantungan dengan cara ini, sehingga kegagalan satu pekerjaan akan menyebabkan semua permintaan yang secara langsung atau tidak langsung tergantung padanya untuk dibatalkan.
+ **failOnError**(dalam CLI:`--fail-on-error`) — Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
**`failOnError`** — Sebuah bendera untuk mengubah berhenti penuh pada kesalahan.
*Nilai yang diizinkan*: `"TRUE"`, `"FALSE"`.
*Nilai default*:`"TRUE"`.
Ketika parameter ini diatur ke `"FALSE"`, loader mencoba memuat semua data di lokasi yang ditentukan, melewatkan entri apa pun yang memiliki kesalahan.
Ketika parameter ini diatur ke `"TRUE"`, loader berhenti segera setelah menemukan kesalahan. Data yang dimuat sampai saat itu tetap ada.
+ **format**(dalam CLI:`--format`) - *Diperlukan: Format, tipe:* `string` (string yang dikodekan UTF-8).
Format data. Untuk informasi selengkapnya tentang format data untuk perintah `Loader` Neptunus, [lihat](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format.html) Memuat Format Data.
**Nilai yang diizinkan**
+ **`csv`**untuk format data [CSV Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html).
+ **`opencypher`**untuk format data [CSV OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html).
+ **`ntriples`**untuk format data [RDF N-Triples](https://www.w3.org/TR/n-triples/).
+ **`nquads`**untuk format data [N-Quads RDF](https://www.w3.org/TR/n-quads/).
+ **`rdfxml`**untuk format data [RDF\$1 XHTML RDF](https://www.w3.org/TR/rdf-syntax-grammar/).
+ **`turtle`**untuk format data [Turtle RDF](https://www.w3.org/TR/turtle/).
+ **iamRoleArn**(dalam CLI:`--iam-role-arn`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
Nama Sumber Daya Amazon (ARN) untuk peran IAM akan diasumsikan oleh instans DB Neptunus untuk akses ke bucket S3. Peran IAM ARN yang disediakan di sini harus dilampirkan ke cluster DB ([lihat Menambahkan Peran IAM ke Cluster Amazon Neptunus](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-IAM-add-role-cluster.html).
+ **mode**(dalam CLI:`--mode`) — Mode, tipe: `string` (string yang dikodekan UTF-8).
Mode beban pekerjaan.
*Nilai yang diizinkan*:`RESUME`,`NEW`,`AUTO`.
*Nilai default*:`AUTO`.
****
+ `RESUME` — Dalam mode RESUME, loader mencari pemuatan sebelumnya dari sumber ini, dan jika menemukan satu, melanjutkan pekerjaan pemuatan tersebut. Jika tidak ada pekerjaan pemuatan sebelumnya yang ditemukan, loader berhenti.
Loader menghindari memuat ulang file yang berhasil dimuat di pekerjaan sebelumnya. Ia hanya mencoba untuk memproses file yang gagal. Jika Anda menjatuhkan data yang dimuat sebelumnya dari klaster Neptune Anda, data tersebut tidak dimuat ulang dalam mode ini. Jika pekerjaan pemuatan sebelumnya berhasil memuat semua file dari sumber yang sama, tidak ada yang dimuat ulang, dan loader mengembalikan keberhasilan.
+ `NEW` — Dalam mode NEW, it menciptakan permintaan pemuatan baru terlepas dari pemuatan sebelumnya. Anda dapat menggunakan mode ini untuk memuat ulang semua data dari sumber setelah menjatuhkan data yang dimuat sebelumnya dari klaster Neptune Anda, atau untuk memuat data baru yang tersedia di sumber yang sama.
+ `AUTO` — Dalam mode AUTO, loader mencari pekerjaan pemuatan sebelumnya dari sumber yang sama, dan jika menemukannya, melanjutkan pekerjaan itu, seperti pada mode `RESUME`.
Jika loader tidak menemukan pekerjaan pemuatan sebelumnya dari sumber yang sama, loader akan memuat semua data dari sumbernya, seperti pada mode `NEW`.
+ **parallelism**(dalam CLI:`--parallelism`) — Paralelisme, tipe: `string` (string yang dikodekan UTF-8).
`parallelism`Parameter opsional dapat diatur untuk mengurangi jumlah utas yang digunakan oleh proses beban massal.
*Nilai yang diizinkan*:
+ `LOW`— Jumlah benang yang digunakan adalah jumlah v yang tersedia CPUs dibagi 8.
+ `MEDIUM`— Jumlah benang yang digunakan adalah jumlah v yang tersedia CPUs dibagi 2.
+ `HIGH`— Jumlah thread yang digunakan sama dengan jumlah yang tersedia vCPUs.
+ `OVERSUBSCRIBE`— Jumlah utas yang digunakan adalah jumlah v yang tersedia CPUs dikalikan dengan 2. Jika nilai ini digunakan, loader massal mengambil semua sumber daya yang tersedia.
Ini tidak berarti, bagaimanapun, bahwa pengaturan `OVERSUBSCRIBE` menghasilkan 100% utilisasi CPU. Karena operasi beban I/O terikat, pemanfaatan CPU tertinggi yang diharapkan adalah dalam kisaran 60% hingga 70%.
*Nilai default*: `HIGH`
`parallelism`Pengaturan terkadang dapat mengakibatkan kebuntuan antar utas saat memuat data OpenCypher. Ketika ini terjadi, Neptunus mengembalikan kesalahan. `LOAD_DATA_DEADLOCK` Anda biasanya dapat memperbaiki masalah dengan menyetel `parallelism` ke pengaturan yang lebih rendah dan mencoba kembali perintah load.
+ **parserConfiguration**(dalam CLI:`--parser-configuration`) — Ini adalah array peta pasangan kunci-nilai di mana:
Setiap kunci adalah String, tipe: `string` (string yang dikodekan UTF-8).
Setiap nilai adalah String, tipe: `string` (string yang dikodekan UTF-8).
**`parserConfiguration`** — Sebuah objek opsional dengan nilai konfigurasi parser tambahan. Masing-masing parameter turunan juga opsional:
****
+ **`namedGraphUri`**— Grafik default untuk semua format RDF ketika tidak ada grafik yang ditentukan (untuk format non-quads dan entri NQUAD tanpa grafik).
Nilai default-nya `https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph`.
+ **`baseUri`**— URI dasar untuk RDF/XML dan format Turtle.
Nilai default-nya `https://aws.amazon.com/neptune/default`.
+ **`allowEmptyStrings`**— Pengguna Gremlin harus dapat memberikan nilai string kosong (“”) sebagai properti simpul dan tepi saat memuat data CSV. Jika `allowEmptyStrings` diatur ke `false` (default), string kosong diperlakukan sebagai null dan tidak dimuat.
Jika `allowEmptyStrings` diatur ke `true`, loader memperlakukan string kosong sebagai nilai properti yang valid dan memuatnya sesuai keperluan.
+ **queueRequest**(dalam CLI:`--queue-request`) — Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Ini adalah parameter bendera opsional yang menunjukkan apakah permintaan pemuatan dapat diantrian atau tidak.
Anda tidak perlu menunggu satu pekerjaan muat selesai sebelum mengeluarkan pekerjaan berikutnya, karena Neptune dapat mengantrekan sebanyak 64 pekerjaan sekaligus, asalkan parameter `queueRequest` semua diatur ke `"TRUE"`. Urutan antrian pekerjaan akan menjadi first-in-first-out (FIFO).
Jika parameter `queueRequest` dihilangkan atau diatur ke `"FALSE"`, permintaan pemuatan akan gagal jika pekerjaan pemuatan lain sudah berjalan.
*Nilai yang diizinkan*: `"TRUE"`, `"FALSE"`.
*Nilai default*:`"FALSE"`.
+ **s3BucketRegion**(dalam CLI:`--s-3-bucket-region`) - *Diperlukan: S3BucketRegion, tipe:* `string` (string yang dikodekan UTF-8).
Wilayah Amazon dari ember S3. Ini harus cocok dengan Wilayah Amazon dari cluster DB.
+ **source**(dalam CLI:`--source`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
`source`Parameter menerima URI S3 yang mengidentifikasi satu file, beberapa file, folder, atau beberapa folder. Neptune memuat setiap file data dalam folder yang ditentukan.
URI dapat berupa format berikut.
+ `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)`
`object-key-name`Elemen URI setara dengan parameter [awalan](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html#API_ListObjects_RequestParameters) dalam panggilan [ListObjects](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html)API S3. Ini mengidentifikasi semua objek dalam ember S3 yang ditentukan yang namanya dimulai dengan awalan itu. Objek itu bisa berupa satu file atau folder, atau beberapa file dan/atau folder.
Folder atau folder-folder yang ditentukan dapat berisi beberapa file vertex dan beberapa file edge.
+ **updateSingleCardinalityProperties**(dalam CLI:`--update-single-cardinality-properties`) — Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
`updateSingleCardinalityProperties`adalah parameter opsional yang mengontrol cara pemuat massal memperlakukan nilai baru untuk properti simpul atau tepi kardinalitas tunggal. Ini tidak didukung untuk memuat data OpenCypher.
*Nilai yang diizinkan*: `"TRUE"`, `"FALSE"`.
*Nilai default*:`"FALSE"`.
Secara default, atau saat `updateSingleCardinalityProperties` secara eksplisit diatur ke `"FALSE"`, loader memperlakukan nilai baru sebagai kesalahan, karena melanggar kardinalitas tunggal.
Saat `updateSingleCardinalityProperties` diatur ke `"TRUE"`, di sisi lain, loader massal menggantikan nilai yang ada dengan yang baru. Jika beberapa edge atau nilai properti vertex single-cardinality disediakan dalam file sumber yang dimuat, nilai akhir pada akhir pemuatan massal bisa menjadi salah satu dari nilai-nilai baru tersebut. Loader hanya menjamin bahwa nilai yang ada telah digantikan oleh salah satu yang baru.
+ **userProvidedEdgeIds**(dalam CLI:`--user-provided-edge-ids`) — Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Parameter ini diperlukan hanya ketika memuat data OpenCypher yang berisi hubungan. IDs Itu harus disertakan dan diatur ke `True` ketika hubungan OpenCypher secara eksplisit IDs disediakan dalam data beban (disarankan).
Ketika tidak `userProvidedEdgeIds` ada atau diatur ke`True`, `:ID` kolom harus ada di setiap file hubungan dalam beban.
Ketika `userProvidedEdgeIds` hadir dan diatur ke`False`, file hubungan dalam beban **tidak boleh** berisi `:ID` kolom. Sebagai gantinya, pemuat Neptunus secara otomatis menghasilkan ID untuk setiap hubungan.
Sangat berguna untuk memberikan hubungan secara IDs eksplisit sehingga loader dapat melanjutkan pemuatan setelah kesalahan dalam data CSV telah diperbaiki, tanpa harus memuat ulang hubungan apa pun yang telah dimuat. Jika hubungan IDs belum ditetapkan secara eksplisit, pemuat tidak dapat melanjutkan pemuatan yang gagal jika ada file hubungan yang harus diperbaiki, dan sebagai gantinya harus memuat ulang semua hubungan.
**Respons**
+ **payload**— *Wajib:* Ini adalah array peta pasangan kunci-nilai di mana:
Setiap kunci adalah String, tipe: `string` (string yang dikodekan UTF-8).
Setiap nilai adalah String, tipe: `string` (string yang dikodekan UTF-8).
Berisi pasangan `loadId` nama-nilai yang menyediakan pengenal untuk operasi beban.
+ **status**— *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode pengembalian HTTP yang menunjukkan status pekerjaan pemuatan.
**Kesalahan**
+ [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 (tindakan)
Nama AWS CLI untuk API ini adalah:. `get-loader-job-status`
Mendapat informasi status tentang pekerjaan pemuatan tertentu. Neptunus melacak 1.024 pekerjaan pemuatan massal terbaru, dan menyimpan 10.000 detail kesalahan terakhir per pekerjaan.
Lihat [Neptune Get-Status Loader](https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm) API untuk informasi selengkapnya.
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan otentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getloaderjobstatus) cluster itu.. GetLoaderJobStatus
**Permintaan**
+ **details**(dalam CLI:`--details`) — Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Tandai yang menunjukkan apakah akan menyertakan detail di luar status keseluruhan atau tidak (`TRUE`atau`FALSE`; defaultnya adalah`FALSE`).
+ **errors**(dalam CLI:`--errors`) — Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Bendera yang menunjukkan apakah akan menyertakan daftar kesalahan yang ditemui atau tidak (`TRUE`atau`FALSE`; defaultnya adalah`FALSE`).
Daftar kesalahan dipecah dalam beberapa bagian. Parameter `page` dan `errorsPerPage` memungkinkan Anda untuk melalui semua kesalahan dalam beberapa bagian.
+ **errorsPerPage**(dalam CLI:`--errors-per-page`) — a PositiveInteger, tipe: `integer` (bilangan bulat 32-bit yang ditandatangani), setidaknya 1? st?.
Jumlah kesalahan yang dikembalikan di setiap halaman (bilangan bulat positif; defaultnya adalah`10`). Hanya berlaku ketika `errors` parameter disetel ke`TRUE`.
+ **loadId**(dalam CLI:`--load-id`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
ID beban pekerjaan beban untuk mendapatkan status.
+ **page**(dalam CLI:`--page`) — a PositiveInteger, tipe: `integer` (bilangan bulat 32-bit yang ditandatangani), setidaknya 1? st?.
Nomor halaman kesalahan (bilangan bulat positif; defaultnya adalah`1`). Hanya berlaku ketika `errors` parameter disetel ke`TRUE`.
**Respons**
+ **payload**— *Diperlukan:* Dokumen, tipe: `document` (konten terbuka protokol-agnostik yang diwakili oleh model data seperti JSON).
Informasi status tentang pekerjaan pemuatan, dalam tata letak yang bisa terlihat seperti ini:
**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**— *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode respons HTTP untuk permintaan tersebut.
**Kesalahan**
+ [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 (tindakan)
Nama AWS CLI untuk API ini adalah:. `list-loader-jobs`
Mengambil daftar `loadIds` untuk semua pekerjaan loader aktif.
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan otentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listloaderjobs) cluster itu.. ListLoaderJobs
**Permintaan**
+ **includeQueuedLoads**(dalam CLI:`--include-queued-loads`) — Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Parameter opsional yang dapat digunakan untuk mengecualikan beban IDs permintaan beban antrian saat meminta daftar beban IDs dengan menyetel parameter ke. `FALSE` Nilai default-nya adalah `TRUE`.
+ **limit**(dalam CLI:`--limit`) — a ListLoaderJobsInputLimitInteger, tipe: `integer` (bilangan bulat 32-bit yang ditandatangani), tidak kurang dari 1 atau lebih dari 100? st? s.
Jumlah beban IDs ke daftar. Harus bilangan bulat positif lebih besar dari nol dan tidak lebih dari `100` (yang merupakan default).
**Respons**
+ **payload** — *Wajib:* Sebuah objek [LoaderIdResult](#LoaderIdResult).
Daftar pekerjaan yang diminta IDs.
+ **status**— *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Mengembalikan status permintaan daftar pekerjaan.
**Kesalahan**
+ [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 (tindakan)
Nama AWS CLI untuk API ini adalah:. `cancel-loader-job`
Membatalkan pekerjaan pemuatan tertentu. Ini adalah `DELETE` permintaan HTTP. Lihat [Neptune Get-Status Loader](https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm) API untuk informasi selengkapnya.
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan otentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelloaderjob) cluster itu.. CancelLoaderJob
**Permintaan**
+ **loadId**(dalam CLI:`--load-id`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
ID pekerjaan pemuatan yang akan dihapus.
**Respons**
+ **status**— String, tipe: `string` (string yang dikodekan UTF-8).
Status pembatalan.
**Kesalahan**
+ [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)
## *Struktur beban massal:*
## LoaderIdResult (struktur)
Berisi daftar beban IDs.
**Bidang**
+ **loadIds**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Daftar beban IDs.
# Neptunus mengalirkan API jalur data
**Tindakan akses streaming:**
+ [GetPropertygraphStream (tindakan)](#GetPropertygraphStream)
**Struktur data aliran:**
+ [PropertygraphRecord (struktur)](#PropertygraphRecord)
+ [PropertygraphData (struktur)](#PropertygraphData)
## GetPropertygraphStream (tindakan)
Nama AWS CLI untuk API ini adalah:. `get-propertygraph-stream`
Mendapat aliran untuk grafik properti.
Dengan fitur Neptunus Streams, Anda dapat menghasilkan urutan lengkap entri log perubahan yang merekam setiap perubahan yang dilakukan pada data grafik Anda saat itu terjadi. `GetPropertygraphStream`memungkinkan Anda mengumpulkan entri log perubahan ini untuk grafik properti.
Fitur aliran Neptunus perlu diaktifkan di Neptunus Anda. DBcluster Untuk mengaktifkan aliran, setel parameter cluster DB [neptune\$1streams](https://docs.aws.amazon.com/neptune/latest/userguide/parameters.html#parameters-db-cluster-parameters-neptune_streams) ke. `1`
Lihat [Menangkap perubahan grafik secara real time menggunakan aliran Neptunus](https://docs.aws.amazon.com/neptune/latest/userguide/streams.html).
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstreamrecords) cluster itu. GetStreamRecords
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan salah satu tindakan IAM berikut, tergantung pada kueri:
Perhatikan bahwa Anda dapat membatasi kueri grafik properti menggunakan kunci konteks IAM berikut:
+ [neptunus-db ::Gremlin QueryLanguage](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys)
+ [neptunus-db:: QueryLanguage OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys)
Lihat [Kunci kondisi yang tersedia di pernyataan kebijakan akses data IAM Neptunus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)).
**Permintaan**
+ **commitNum**(dalam CLI:`--commit-num`) — Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Jumlah commit dari catatan awal yang akan dibaca dari stream log perubahan. Parameter ini `iteratorType` diperlukan saat `AT_SEQUENCE_NUMBER` atau`AFTER_SEQUENCE_NUMBER`, dan diabaikan kapan `iteratorType` `TRIM_HORIZON` atau`LATEST`.
+ **encoding**(dalam CLI:`--encoding`) — Pengkodean, tipe: `string` (string yang dikodekan UTF-8).
Jika disetel ke TRUE, Neptunus memampatkan respons menggunakan pengkodean gzip.
+ **iteratorType**(dalam CLI:`--iterator-type`) — sebuah IteratorType, dari tipe: `string` (string yang dikodekan UTF-8).
Bisa menjadi salah satu dari:
+ `AT_SEQUENCE_NUMBER`— Menunjukkan bahwa pembacaan harus dimulai dari nomor urut acara yang ditentukan bersama oleh `opNum` parameter `commitNum` dan.
+ `AFTER_SEQUENCE_NUMBER`— Menunjukkan bahwa pembacaan harus dimulai tepat setelah nomor urut acara yang ditentukan bersama oleh `opNum` parameter `commitNum` dan.
+ `TRIM_HORIZON`— Menunjukkan bahwa pembacaan harus dimulai pada catatan terakhir yang belum dipangkas dalam sistem, yang merupakan catatan tertua yang belum kedaluwarsa (belum dihapus) dalam aliran log perubahan.
+ `LATEST`— Menunjukkan bahwa pembacaan harus dimulai pada catatan terbaru dalam sistem, yang merupakan catatan terbaru yang belum kedaluwarsa (belum dihapus) dalam aliran log perubahan.
+ **limit**(dalam CLI:`--limit`) — a GetPropertygraphStreamInputLimitLong, tipe: `long` (integer 64-bit yang ditandatangani), tidak kurang dari 1 atau lebih dari 100000? st? s.
Menentukan angka maksimum catatan yang akan dikembalikan. Ada juga batas ukuran 10 MB pada respon yang tidak dapat diubah dan yang diutamakan daripada jumlah catatan yang ditentukan dalam parameter `limit`. Respon mencakup catatan pelanggaran ambang batas jika batas 10 MB tercapai.
Rentang untuk `limit` adalah 1 hingga 100.000, dengan default 10.
+ **opNum**(dalam CLI:`--op-num`) — Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Nomor urut operasi dalam commit yang ditentukan untuk mulai dibaca dari dalam data stream log perubahan. Nilai default-nya `1`.
**Respons**
+ **format**— *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Format serialisasi untuk catatan perubahan yang dikembalikan. Saat ini, satu-satunya nilai yang didukung adalah `PG_JSON`.
+ **lastEventId**— *Wajib:* Ini adalah array peta pasangan kunci-nilai di mana:
Setiap kunci adalah String, tipe: `string` (string yang dikodekan UTF-8).
Setiap nilai adalah String, tipe: `string` (string yang dikodekan UTF-8).
Pengidentifikasi urutan dari perubahan terakhir dalam respons aliran.
ID peristiwa terdiri dari dua bidang: a`commitNum`, yang mengidentifikasi transaksi yang mengubah grafik, dan`opNum`, yang mengidentifikasi operasi tertentu dalam transaksi itu:
**Example**
```
"eventId": {
"commitNum": 12,
"opNum": 1
}
```
+ **lastTrxTimestampInMillis**— *Diperlukan:* Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Waktu di mana komit untuk transaksi diminta, dalam milidetik dari zaman Unix.
+ **records** – *Wajib:* Susunan objek [PropertygraphRecord](#PropertygraphRecord).
Array catatan aliran log perubahan serial yang disertakan dalam respons.
+ **totalRecords**— *Diperlukan:* Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Jumlah total catatan dalam tanggapan.
**Kesalahan**
+ [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)
## *Struktur data aliran:*
## PropertygraphRecord (struktur)
Struktur catatan grafik properti.
**Bidang**
+ **commitTimestampInMillis**— Ini *Diperlukan:* Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Waktu di mana komit untuk transaksi diminta, dalam milidetik dari zaman Unix.
+ **data**— Ini *Diperlukan:* Sebuah [PropertygraphData](#PropertygraphData) objek.
Catatan perubahan Gremlin atau OpenCypher yang diserialisasi.
+ **eventId**— Ini *Diperlukan:* Ini adalah array peta pasangan kunci-nilai di mana:
Setiap kunci adalah String, tipe: `string` (string yang dikodekan UTF-8).
Setiap nilai adalah String, tipe: `string` (string yang dikodekan UTF-8).
Pengidentifikasi urutan catatan perubahan aliran.
+ **isLastOp**— Ini adalah Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Hanya hadir jika operasi ini adalah yang terakhir dalam transaksinya. Jika ada, itu diatur ke true. Ini berguna untuk memastikan bahwa seluruh transaksi dikonsumsi.
+ **op**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Operasi yang menciptakan perubahan.
## PropertygraphData (struktur)
Catatan perubahan Gremlin atau OpenCypher.
**Bidang**
+ **from**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Jika ini adalah tepi (tipe =`e`), ID dari simpul atau `from` simpul sumber yang sesuai.
+ **id**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID dari elemen Gremlin atau OpenCypher.
+ **key**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Nama properti. Untuk label elemen, ini adalah`label`.
+ **to**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Jika ini adalah tepi (tipe =`e`), ID dari simpul atau `to` simpul target yang sesuai.
+ **type**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Jenis elemen Gremlin atau OpenCypher ini. Harus menjadi salah satu dari:
+ **`v1`**- Label Vertex untuk Gremlin, atau label node untuk OpenCypher.
+ **`vp`**- Properti Vertex untuk Gremlin, atau properti node untuk OpenCypher.
+ **`e`**- Label tepi dan tepi untuk Gremlin, atau jenis hubungan dan hubungan untuk OpenCypher.
+ **`ep`**- Properti tepi untuk Gremlin, atau properti hubungan untuk OpenCypher.
+ **value**— Ini *Diperlukan:* Dokumen, tipe: `document` (konten terbuka protokol-agnostik yang diwakili oleh model data seperti JSON).
Ini adalah objek JSON yang berisi bidang nilai untuk nilai itu sendiri, dan bidang tipe data untuk tipe data JSON dari nilai itu:
**Example**
```
"value": {
"value": "(the new value"),
"dataType": "(the JSON datatypenew value")
}
```
# Statistik jalur data Neptunus dan ringkasan grafik APIs
**Tindakan statistik grafik properti:**
+ [GetPropertygraphStatistics (tindakan)](#GetPropertygraphStatistics)
+ [ManagePropertygraphStatistics (tindakan)](#ManagePropertygraphStatistics)
+ [DeletePropertygraphStatistics (tindakan)](#DeletePropertygraphStatistics)
+ [GetPropertygraphSummary (tindakan)](#GetPropertygraphSummary)
**Struktur statistik:**
+ [Statistik (struktur)](#Statistics)
+ [StatisticsSummary (struktur)](#StatisticsSummary)
+ [DeleteStatisticsValueMap (struktur)](#DeleteStatisticsValueMap)
+ [RefreshStatisticsIdMap (struktur)](#RefreshStatisticsIdMap)
+ [NodeStructure (struktur)](#NodeStructure)
+ [EdgeStructure (struktur)](#EdgeStructure)
+ [SubjectStructure (struktur)](#SubjectStructure)
+ [PropertygraphSummaryValueMap (struktur)](#PropertygraphSummaryValueMap)
+ [PropertygraphSummary (struktur)](#PropertygraphSummary)
## GetPropertygraphStatistics (tindakan)
Nama AWS CLI untuk API ini adalah:. `get-propertygraph-statistics`
Mendapat statistik grafik properti (Gremlin dan OpenCypher).
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstatisticsstatus) cluster itu. GetStatisticsStatus
**Permintaan**
+ *Tidak ada parameter Permintaan.*
**Respons**
+ **payload** — *Wajib:* Sebuah objek [Statistik](#Statistics).
Statistik untuk data grafik properti.
+ **status**— *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode pengembalian HTTP dari permintaan. Jika permintaan berhasil, kodenya adalah 200. Lihat [Kode kesalahan umum untuk permintaan statistik DFE](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors) untuk daftar kesalahan umum.
**Kesalahan**
+ [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 (tindakan)
Nama AWS CLI untuk API ini adalah:. `manage-propertygraph-statistics`
Mengelola pembuatan dan penggunaan statistik grafik properti.
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#managestatistics) cluster itu. ManageStatistics
**Permintaan**
+ **mode**(dalam CLI:`--mode`) — a StatisticsAutoGenerationMode, dari tipe: `string` (string yang dikodekan UTF-8).
Mode generasi statistik. Salah satu dari: `DISABLE_AUTOCOMPUTE``ENABLE_AUTOCOMPUTE`,, atau`REFRESH`, yang terakhir secara manual memicu pembuatan statistik DFE.
**Respons**
+ **payload** — Sebuah objek [RefreshStatisticsIdMap](#RefreshStatisticsIdMap).
Ini hanya dikembalikan untuk mode refresh.
+ **status**— *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode pengembalian HTTP dari permintaan. Jika permintaan berhasil, kodenya adalah 200.
**Kesalahan**
+ [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 (tindakan)
Nama AWS CLI untuk API ini adalah:. `delete-propertygraph-statistics`
Menghapus statistik untuk data Gremlin dan OpenCypher (grafik properti).
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletestatistics) cluster itu. DeleteStatistics
**Permintaan**
+ *Tidak ada parameter Permintaan.*
**Respons**
+ **payload** — Sebuah objek [DeleteStatisticsValueMap](#DeleteStatisticsValueMap).
Muatan penghapusan.
+ **status**— String, tipe: `string` (string yang dikodekan UTF-8).
Status pembatalan.
+ **statusCode**— Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Kode respons HTTP: 200 jika penghapusan berhasil, atau 204 jika tidak ada statistik untuk dihapus.
**Kesalahan**
+ [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 (tindakan)
Nama AWS CLI untuk API ini adalah:. `get-propertygraph-summary`
Mendapat ringkasan grafik untuk grafik properti.
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM [di](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getgraphsummary) cluster itu. GetGraphSummary
**Permintaan**
+ **mode**(dalam CLI:`--mode`) — a GraphSummaryType, dari tipe: `string` (string yang dikodekan UTF-8).
Mode dapat mengambil salah satu dari dua nilai: `BASIC` (default), dan`DETAILED`.
**Respons**
+ **payload** — Sebuah objek [PropertygraphSummaryValueMap](#PropertygraphSummaryValueMap).
Payload yang berisi respon ringkasan grafik properti.
+ **statusCode**— Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Kode pengembalian HTTP dari permintaan. Jika permintaan berhasil, kodenya adalah 200.
**Kesalahan**
+ [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)
## *Struktur statistik:*
## Statistik (struktur)
Berisi informasi statistik. Mesin DFE menggunakan informasi tentang data dalam grafik Neptunus Anda untuk membuat trade-off yang efektif saat merencanakan eksekusi kueri. Informasi ini mengambil bentuk statistik yang mencakup apa yang disebut set karakteristik dan statistik predikat yang dapat memandu perencanaan kueri. Lihat [Mengelola statistik untuk DFE Neptunus](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html) untuk digunakan.
**Bidang**
+ **active**— Ini adalah Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Menunjukkan apakah pembuatan statistik DFE diaktifkan sama sekali atau tidak.
+ **autoCompute**— Ini adalah Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Menunjukkan apakah pembuatan statistik otomatis diaktifkan atau tidak.
+ **date**— Ini adalah SyntheticTimestamp \$1date\$1time, dari tipe: `string` (string yang dikodekan UTF-8).
Waktu UTC di mana statistik DFE baru-baru ini dihasilkan.
+ **note**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Catatan tentang masalah dalam kasus di mana statistik tidak valid.
+ **signatureInfo**Ini adalah sebuah [StatisticsSummary](#StatisticsSummary) objek.
StatisticsSummary Struktur yang berisi:
+ `signatureCount`- Jumlah total tanda tangan di semua set karakteristik.
+ `instanceCount`- Jumlah total instance yang ditetapkan karakteristik.
+ `predicateCount`- Jumlah total predikat unik.
+ **statisticsId**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Melaporkan ID dari proses pembuatan statistik saat ini. Nilai -1 menunjukkan bahwa tidak ada statistik yang dihasilkan.
## StatisticsSummary (struktur)
Informasi tentang set karakteristik yang dihasilkan dalam statistik.
**Bidang**
+ **instanceCount**— Ini adalah Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Jumlah total instance set karakteristik.
+ **predicateCount**— Ini adalah Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Jumlah total predikat unik.
+ **signatureCount**— Ini adalah Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Jumlah total tanda tangan di semua set karakteristik.
## DeleteStatisticsValueMap (struktur)
Muatan untuk DeleteStatistics.
**Bidang**
+ **active**— Ini adalah Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Status statistik saat ini.
+ **statisticsId**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
ID dari proses pembuatan statistik yang sedang terjadi saat ini.
## RefreshStatisticsIdMap (struktur)
Statistik untuk `REFRESH` mode.
**Bidang**
+ **statisticsId**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
ID dari proses pembuatan statistik yang sedang terjadi saat ini.
## NodeStructure (struktur)
Struktur simpul.
**Bidang**
+ **count**— Ini adalah Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Jumlah node yang memiliki struktur khusus ini.
+ **distinctOutgoingEdgeLabels**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Daftar label tepi keluar yang berbeda hadir dalam struktur khusus ini.
+ **nodeProperties**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Daftar properti simpul yang ada dalam struktur khusus ini.
## EdgeStructure (struktur)
Struktur tepi.
**Bidang**
+ **count**— Ini adalah Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Jumlah tepi yang memiliki struktur khusus ini.
+ **edgeProperties**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Daftar properti tepi yang ada dalam struktur khusus ini.
## SubjectStructure (struktur)
Struktur subjek.
**Bidang**
+ **count**— Ini adalah Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Jumlah kemunculan struktur khusus ini.
+ **predicates**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Daftar predikat hadir dalam struktur khusus ini.
## PropertygraphSummaryValueMap (struktur)
Payload untuk respon ringkasan grafik properti.
**Bidang**
+ **graphSummary**Ini adalah sebuah [PropertygraphSummary](#PropertygraphSummary) objek.
Ringkasan grafik.
+ **lastStatisticsComputationTime**— Ini adalah SyntheticTimestamp \$1date\$1time, dari tipe: `string` (string yang dikodekan UTF-8).
Stempel waktu, dalam format ISO 8601, saat Neptunus terakhir menghitung statistik.
+ **version**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Versi respons ringkasan grafik ini.
## PropertygraphSummary (struktur)
API ringkasan grafik mengembalikan daftar read-only label node dan edge dan kunci properti, bersama dengan jumlah node, tepi, dan properti. Lihat [Respons ringkasan grafik untuk grafik properti (PG)](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-graph-summary.html#neptune-graph-summary-pg-response).
**Bidang**
+ **edgeLabels**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Daftar label tepi yang berbeda dalam grafik.
+ **edgeProperties**— Ini adalah LongValuedMap objek Ini adalah array peta pasangan kunci-nilai di mana:
Setiap kunci adalah String, tipe: `string` (string yang dikodekan UTF-8).
Setiap nilai adalah Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Daftar properti tepi yang berbeda dalam grafik, bersama dengan jumlah tepi di mana setiap properti digunakan.
+ **edgeStructures**— Ini adalah Array [EdgeStructure](#EdgeStructure) objek.
Bidang ini hanya ada ketika mode yang diminta`DETAILED`. Ini berisi daftar struktur tepi.
+ **nodeLabels**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Daftar label node yang berbeda dalam grafik.
+ **nodeProperties**— Ini adalah LongValuedMap objek Ini adalah array peta pasangan kunci-nilai di mana:
Setiap kunci adalah String, tipe: `string` (string yang dikodekan UTF-8).
Setiap nilai adalah Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Jumlah properti node yang berbeda dalam grafik.
+ **nodeStructures**— Ini adalah Array [NodeStructure](#NodeStructure) objek.
Bidang ini hanya ada ketika mode yang diminta`DETAILED`. Ini berisi daftar struktur simpul.
+ **numEdgeLabels**— Ini adalah Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Jumlah label tepi yang berbeda dalam grafik.
+ **numEdgeProperties**— Ini adalah Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Jumlah properti tepi yang berbeda dalam grafik.
+ **numEdges**— Ini adalah Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Jumlah tepi dalam grafik.
+ **numNodeLabels**— Ini adalah Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Jumlah label node yang berbeda dalam grafik.
+ **numNodeProperties**— Ini adalah Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Daftar properti node yang berbeda dalam grafik, bersama dengan jumlah node di mana setiap properti digunakan.
+ **numNodes**— Ini adalah Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Jumlah node dalam grafik.
+ **totalEdgePropertyValues**— Ini adalah Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Jumlah total penggunaan semua properti tepi.
+ **totalNodePropertyValues**— Ini adalah Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Jumlah total penggunaan semua properti node.
# API pemrosesan data Neptunus Neptunus
**Tindakan pemrosesan data:**
+ [Mulai MLData ProcessingJob (tindakan)](#StartMLDataProcessingJob)
+ [Daftar MLData ProcessingJobs (tindakan)](#ListMLDataProcessingJobs)
+ [Dapatkan MLData ProcessingJob (tindakan)](#GetMLDataProcessingJob)
+ [Batalkan MLData ProcessingJob (tindakan)](#CancelMLDataProcessingJob)
**Struktur tujuan umum ML:**
+ [MlResourceDefinition (struktur)](#MlResourceDefinition)
+ [MlConfigDefinition (struktur)](#MlConfigDefinition)
## Mulai MLData ProcessingJob (tindakan)
Nama AWS CLI untuk API ini adalah:. `start-ml-data-processing-job`
Membuat pekerjaan pemrosesan data Neptunus ML baru untuk memproses data grafik yang diekspor dari Neptunus untuk pelatihan. Lihat [`dataprocessing`perintahnya](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html).
[Saat menjalankan operasi ini di kluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan IAM Neptunus-DB:start di cluster tersebut. MLModel DataProcessingJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeldataprocessingjob)
**Permintaan**
+ **configFileName**(dalam CLI:`--config-file-name`) — String, tipe: `string` (string yang dikodekan UTF-8).
File spesifikasi data yang menjelaskan cara memuat data grafik yang diekspor untuk pelatihan. File secara otomatis dihasilkan oleh kit alat ekspor Neptune. Nilai default-nya `training-data-configuration.json`.
+ **id**(dalam CLI:`--id`) — String, tipe: `string` (string yang dikodekan UTF-8).
Pengenal unik untuk pekerjaan baru. Defaultnya adalah UUID yang dibuat secara otomatis.
+ **inputDataS3Location**(dalam CLI:`--input-data-s3-location`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
URI lokasi Amazon S3 tempat Anda ingin SageMaker mengunduh data yang diperlukan untuk menjalankan pekerjaan pemrosesan data.
+ **modelType**(dalam CLI:`--model-type`) — String, tipe: `string` (string yang dikodekan UTF-8).
Salah satu dari dua jenis model yang didukung Neptunus ML saat ini: model grafik heterogen `heterogeneous` (), dan grafik pengetahuan (). `kge` Defaultnya tidak ada. Jika tidak ditentukan, Neptunus ML memilih jenis model secara otomatis berdasarkan data.
+ **neptuneIamRoleArn**(dalam CLI:`--neptune-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
Nama Sumber Daya Amazon (ARN) dari peran IAM yang SageMaker dapat diasumsikan untuk melakukan tugas atas nama Anda. Ini harus tercantum dalam grup parameter cluster DB Anda atau kesalahan akan terjadi.
+ **previousDataProcessingJobId**(dalam CLI:`--previous-data-processing-job-id`) — String, tipe: `string` (string yang dikodekan UTF-8).
ID pekerjaan dari pekerjaan pemrosesan data yang telah selesai dijalankan pada versi data yang lebih lama.
+ **processedDataS3Location**(dalam CLI:`--processed-data-s3-location`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
URI lokasi Amazon S3 tempat Anda SageMaker ingin menyimpan hasil pekerjaan pemrosesan data.
+ **processingInstanceType**(dalam CLI:`--processing-instance-type`) — String, tipe: `string` (string yang dikodekan UTF-8).
Jenis instance ML yang digunakan selama pemrosesan data. Memorinya harus cukup besar untuk menahan set data yang diproses. Defaultnya adalah tipe ml.r5 terkecil yang memorinya sepuluh kali lebih besar dari ukuran data grafik yang diekspor pada disk.
+ **processingInstanceVolumeSizeInGB**(dalam CLI:`--processing-instance-volume-size-in-gb`) — Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Ukuran volume disk dari instance pemrosesan. Data input dan data yang diproses disimpan pada disk, sehingga ukuran volume harus cukup besar untuk menahan kedua set data. Default-nya adalah 0. Jika tidak ditentukan atau 0, Neptunus ML memilih ukuran volume secara otomatis berdasarkan ukuran data.
+ **processingTimeOutInSeconds**(dalam CLI:`--processing-time-out-in-seconds`) — Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Batas waktu dalam hitungan detik untuk pekerjaan pemrosesan data. Defaultnya adalah 86.400 (1 hari).
+ **s3OutputEncryptionKMSKey**(dalam CLI:`--s-3-output-encryption-kms-key`) — String, tipe: `string` (string yang dikodekan UTF-8).
Kunci Amazon Key Management Service (Amazon KMS) yang SageMaker digunakan untuk mengenkripsi output dari pekerjaan pemrosesan. Defaultnya tidak ada.
+ **sagemakerIamRoleArn**(dalam CLI:`--sagemaker-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari peran IAM untuk eksekusi. SageMaker Ini harus tercantum dalam grup parameter cluster DB Anda atau kesalahan akan terjadi.
+ **securityGroupIds**(dalam CLI:`--security-group-ids`) — String, tipe: `string` (string yang dikodekan UTF-8).
Grup keamanan VPC. IDs Default-nya adalah Tidak Ada.
+ **subnets**(dalam CLI:`--subnets`) — String, tipe: `string` (string yang dikodekan UTF-8).
Subnet di VPC Neptunus. IDs Default-nya adalah Tidak Ada.
+ **volumeEncryptionKMSKey**(dalam CLI:`--volume-encryption-kms-key`) — String, tipe: `string` (string yang dikodekan UTF-8).
Kunci Amazon Key Management Service (Amazon KMS) yang SageMaker digunakan untuk mengenkripsi data pada volume penyimpanan yang dilampirkan ke instans komputasi ML yang menjalankan tugas pelatihan. Default-nya adalah Tidak Ada.
**Respons**
+ **arn**— String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari pekerjaan pemrosesan data.
+ **creationTimeInMillis**— Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Waktu yang dibutuhkan untuk membuat pekerjaan pemrosesan baru, dalam milidetik.
+ **id**— String, tipe: `string` (string yang dikodekan UTF-8).
ID unik dari pekerjaan pemrosesan data baru.
**Kesalahan**
+ [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)
## Daftar MLData ProcessingJobs (tindakan)
Nama AWS CLI untuk API ini adalah:. `list-ml-data-processing-jobs`
Mengembalikan daftar pekerjaan pemrosesan data Neptunus Neptunus. Lihat Membuat [daftar pekerjaan pemrosesan data aktif menggunakan perintah pemrosesan data Neptunus ML](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html#machine-learning-api-dataprocessing-list-jobs).
[Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan IAM Neptune-DB:List di cluster tersebut. MLData ProcessingJobs](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmldataprocessingjobs)
**Permintaan**
+ **maxItems**(dalam CLI:`--max-items`) — Daftar ListMLDataProcessingJobsInputMaxItemsInteger, tipe: `integer` (bilangan bulat 32-bit yang ditandatangani), tidak kurang dari 1 atau lebih dari 1024? st? s.
Jumlah maksimum item yang akan dikembalikan (dari 1 hingga 1024; defaultnya adalah 10).
+ **neptuneIamRoleArn**(dalam CLI:`--neptune-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari peran IAM yang menyediakan akses Neptunus ke dan sumber daya Amazon S3. SageMaker Ini harus tercantum dalam grup parameter cluster DB Anda atau kesalahan akan terjadi.
**Respons**
+ **ids**— String, tipe: `string` (string yang dikodekan UTF-8).
Halaman yang mencantumkan pekerjaan pemrosesan data IDs.
**Kesalahan**
+ [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)
## Dapatkan MLData ProcessingJob (tindakan)
Nama AWS CLI untuk API ini adalah:. `get-ml-data-processing-job`
Mengambil informasi tentang pekerjaan pemrosesan data tertentu. Lihat [`dataprocessing`perintahnya](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html).
[Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan Neptune-DB:Neptune-db:get IAM di cluster itu. MLData ProcessingJobStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmldataprocessingjobstatus)
**Permintaan**
+ **id**(dalam CLI:`--id`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
Pengidentifikasi unik dari pekerjaan pemrosesan data yang akan diambil.
+ **neptuneIamRoleArn**(dalam CLI:`--neptune-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari peran IAM yang menyediakan akses Neptunus ke dan sumber daya Amazon S3. SageMaker Ini harus tercantum dalam grup parameter cluster DB Anda atau kesalahan akan terjadi.
**Respons**
+ **id**— String, tipe: `string` (string yang dikodekan UTF-8).
Pengidentifikasi unik dari pekerjaan pemrosesan data ini.
+ **processingJob** — Sebuah objek [MlResourceDefinition](#MlResourceDefinition).
Definisi pekerjaan pemrosesan data.
+ **status**— String, tipe: `string` (string yang dikodekan UTF-8).
Status pekerjaan pemrosesan data.
**Kesalahan**
+ [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)
## Batalkan MLData ProcessingJob (tindakan)
Nama AWS CLI untuk API ini adalah:. `cancel-ml-data-processing-job`
Membatalkan pekerjaan pemrosesan data Neptunus Neptunus. Lihat [`dataprocessing`perintahnya](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html).
[Saat menjalankan operasi ini di kluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan IAM Neptune-DB:Cancel di cluster tersebut. MLData ProcessingJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmldataprocessingjob)
**Permintaan**
+ **clean**(dalam CLI:`--clean`) — Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Jika disetel ke`TRUE`, bendera ini menentukan bahwa semua artefak Neptunus ML S3 harus dihapus ketika pekerjaan dihentikan. Nilai default-nya `FALSE`.
+ **id**(dalam CLI:`--id`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
Pengidentifikasi unik dari pekerjaan pemrosesan data.
+ **neptuneIamRoleArn**(dalam CLI:`--neptune-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari peran IAM yang menyediakan akses Neptunus ke dan sumber daya Amazon S3. SageMaker Ini harus tercantum dalam grup parameter cluster DB Anda atau kesalahan akan terjadi.
**Respons**
+ **status**— String, tipe: `string` (string yang dikodekan UTF-8).
Status permintaan pembatalan.
**Kesalahan**
+ [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)
## *Struktur tujuan umum ML:*
## MlResourceDefinition (struktur)
Mendefinisikan sumber daya Neptunus Neptunus.
**Bidang**
+ **arn**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Sumber daya ARN.
+ **cloudwatchLogUrl**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
URL CloudWatch log untuk sumber daya.
+ **failureReason**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Alasan kegagalan, jika terjadi kegagalan.
+ **name**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Nama sumber daya.
+ **outputLocation**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Lokasi output.
+ **status**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Status sumber daya.
## MlConfigDefinition (struktur)
Berisi konfigurasi Neptunus Neptunus.
**Bidang**
+ **arn**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
ARN untuk konfigurasi.
+ **name**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Nama konfigurasi.
# API pelatihan model Neptunus Neptunus
**Tindakan pelatihan model:**
+ [Mulai MLModel TrainingJob (tindakan)](#StartMLModelTrainingJob)
+ [Daftar MLModel TrainingJobs (tindakan)](#ListMLModelTrainingJobs)
+ [Dapatkan MLModel TrainingJob (tindakan)](#GetMLModelTrainingJob)
+ [Batalkan MLModel TrainingJob (tindakan)](#CancelMLModelTrainingJob)
**Struktur pelatihan model:**
+ [CustomModelTrainingParameters (struktur)](#CustomModelTrainingParameters)
## Mulai MLModel TrainingJob (tindakan)
Nama AWS CLI untuk API ini adalah:. `start-ml-model-training-job`
Menciptakan pekerjaan pelatihan model Neptunus ML baru. Lihat [Pelatihan model menggunakan `modeltraining` perintah](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html).
[Saat menjalankan operasi ini di kluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan IAM Neptunus-DB:start di cluster tersebut. MLModel TrainingJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeltrainingjob)
**Permintaan**
+ **baseProcessingInstanceType**(dalam CLI:`--base-processing-instance-type`) — String, tipe: `string` (string yang dikodekan UTF-8).
Jenis instance ML yang digunakan dalam mempersiapkan dan mengelola pelatihan model ML. Ini adalah instance CPU yang dipilih berdasarkan persyaratan memori untuk memproses data dan model pelatihan.
+ **customModelTrainingParameters**(dalam CLI:`--custom-model-training-parameters`) — Sebuah [CustomModelTrainingParameters](#CustomModelTrainingParameters) objek.
Konfigurasi untuk pelatihan model khusus. Ini adalah objek JSON.
+ **dataProcessingJobId**(dalam CLI:`--data-processing-job-id`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
ID pekerjaan dari pekerjaan pemrosesan data yang telah selesai yang telah menciptakan data yang akan dikerjakan oleh pelatihan.
+ **enableManagedSpotTraining**(dalam CLI:`--enable-managed-spot-training`) — Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Mengoptimalkan biaya pelatihan model pembelajaran mesin dengan menggunakan instans spot Amazon Elastic Compute Cloud. Nilai default-nya `False`.
+ **id**(dalam CLI:`--id`) — String, tipe: `string` (string yang dikodekan UTF-8).
Pengenal unik untuk pekerjaan baru. Defaultnya adalah UUID yang dibuat secara otomatis.
+ **maxHPONumberOfTrainingJobs**(dalam CLI:`--max-hpo-number-of-training-jobs`) — Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Jumlah total maksimum pekerjaan pelatihan untuk memulai untuk pekerjaan tuning hyperparameter. Defaultnya adalah 2. Neptunus ML secara otomatis menyetel hiperparameter model pembelajaran mesin. Untuk mendapatkan model yang berkinerja baik, gunakan setidaknya 10 pekerjaan (dengan kata lain, atur `maxHPONumberOfTrainingJobs` ke 10). Secara umum, semakin banyak tuning berjalan, semakin baik hasilnya.
+ **maxHPOParallelTrainingJobs**(dalam CLI:`--max-hpo-parallel-training-jobs`) — Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Jumlah maksimum pekerjaan pelatihan paralel untuk memulai untuk pekerjaan tuning hyperparameter. Defaultnya adalah 2. Jumlah pekerjaan paralel yang dapat Anda jalankan dibatasi oleh sumber daya yang tersedia pada instans pelatihan Anda.
+ **neptuneIamRoleArn**(dalam CLI:`--neptune-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari peran IAM yang menyediakan akses Neptunus ke dan sumber daya Amazon S3. SageMaker Ini harus tercantum dalam grup parameter cluster DB Anda atau kesalahan akan terjadi.
+ **previousModelTrainingJobId**(dalam CLI:`--previous-model-training-job-id`) — String, tipe: `string` (string yang dikodekan UTF-8).
ID pekerjaan dari pekerjaan pelatihan model yang telah selesai yang ingin Anda perbarui secara bertahap berdasarkan data yang diperbarui.
+ **s3OutputEncryptionKMSKey**(dalam CLI:`--s-3-output-encryption-kms-key`) — String, tipe: `string` (string yang dikodekan UTF-8).
Kunci Amazon Key Management Service (KMS) yang SageMaker digunakan untuk mengenkripsi output dari pekerjaan pemrosesan. Defaultnya tidak ada.
+ **sagemakerIamRoleArn**(dalam CLI:`--sagemaker-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari peran IAM untuk SageMaker eksekusi. Ini harus terdaftar di grup parameter cluster DB Anda atau kesalahan akan terjadi.
+ **securityGroupIds**(dalam CLI:`--security-group-ids`) — String, tipe: `string` (string yang dikodekan UTF-8).
Grup keamanan VPC. IDs Default-nya adalah Tidak Ada.
+ **subnets**(dalam CLI:`--subnets`) — String, tipe: `string` (string yang dikodekan UTF-8).
Subnet di VPC Neptunus. IDs Default-nya adalah Tidak Ada.
+ **trainingInstanceType**(dalam CLI:`--training-instance-type`) — String, tipe: `string` (string yang dikodekan UTF-8).
Jenis instance ML yang digunakan untuk pelatihan model. Semua model Neptune ML mendukung pelatihan CPU, GPU, dan MultiGPU. Nilai default-nya `ml.p3.2xlarge`. Memilih jenis instans yang tepat untuk pelatihan tergantung pada jenis tugas, ukuran grafik, dan anggaran Anda.
+ **trainingInstanceVolumeSizeInGB**(dalam CLI:`--training-instance-volume-size-in-gb`) — Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Ukuran volume disk dari instance pelatihan. Input data dan model output disimpan dalam disk, sehingga ukuran volume harus cukup besar untuk menahan kedua set data. Default-nya adalah 0. Jika tidak ditentukan atau 0, Neptunus ML memilih ukuran volume disk berdasarkan rekomendasi yang dihasilkan dalam langkah pemrosesan data.
+ **trainingTimeOutInSeconds**(dalam CLI:`--training-time-out-in-seconds`) — Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Batas waktu dalam hitungan detik untuk pekerjaan pelatihan. Defaultnya adalah 86.400 (1 hari).
+ **trainModelS3Location**(dalam CLI:`--train-model-s3-location`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
Lokasi di Amazon S3 tempat artefak model akan disimpan.
+ **volumeEncryptionKMSKey**(dalam CLI:`--volume-encryption-kms-key`) — String, tipe: `string` (string yang dikodekan UTF-8).
Kunci Amazon Key Management Service (KMS) yang SageMaker digunakan untuk mengenkripsi data pada volume penyimpanan yang dilampirkan ke instans komputasi ML yang menjalankan tugas pelatihan. Default-nya adalah Tidak Ada.
**Respons**
+ **arn**— String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari pekerjaan pelatihan model baru.
+ **creationTimeInMillis**— Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Model pelatihan waktu penciptaan lapangan kerja, dalam milidetik.
+ **id**— String, tipe: `string` (string yang dikodekan UTF-8).
ID unik dari pekerjaan pelatihan model baru.
**Kesalahan**
+ [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)
## Daftar MLModel TrainingJobs (tindakan)
Nama AWS CLI untuk API ini adalah:. `list-ml-model-training-jobs`
Daftar pekerjaan pelatihan model Neptunus ML. Lihat [Pelatihan model menggunakan `modeltraining` perintah](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html).
[Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan IAM Neptune-DB:Neptune-db:list di cluster tersebut. MLModel TrainingJobs](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#neptune-db:listmlmodeltrainingjobs)
**Permintaan**
+ **maxItems**(dalam CLI:`--max-items`) — Daftar MLModelTrainingJobsInputMaxItemsInteger, tipe: `integer` (bilangan bulat 32-bit yang ditandatangani), tidak kurang dari 1 atau lebih dari 1024? st? s.
Jumlah maksimum item yang akan dikembalikan (dari 1 hingga 1024; defaultnya adalah 10).
+ **neptuneIamRoleArn**(dalam CLI:`--neptune-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari peran IAM yang menyediakan akses Neptunus ke dan sumber daya Amazon S3. SageMaker Ini harus tercantum dalam grup parameter cluster DB Anda atau kesalahan akan terjadi.
**Respons**
+ **ids**— String, tipe: `string` (string yang dikodekan UTF-8).
Halaman daftar pekerjaan pelatihan model IDs.
**Kesalahan**
+ [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)
## Dapatkan MLModel TrainingJob (tindakan)
Nama AWS CLI untuk API ini adalah:. `get-ml-model-training-job`
Mengambil informasi tentang pekerjaan pelatihan model Neptunus ML. Lihat [Pelatihan model menggunakan `modeltraining` perintah](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html).
[Saat menjalankan operasi ini di kluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan Neptunus-DB:get IAM di cluster tersebut. MLModel TrainingJobStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlmodeltrainingjobstatus)
**Permintaan**
+ **id**(dalam CLI:`--id`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
Pengidentifikasi unik dari pekerjaan pelatihan model untuk diambil.
+ **neptuneIamRoleArn**(dalam CLI:`--neptune-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari peran IAM yang menyediakan akses Neptunus ke dan sumber daya Amazon S3. SageMaker Ini harus tercantum dalam grup parameter cluster DB Anda atau kesalahan akan terjadi.
**Respons**
+ **hpoJob** — Sebuah objek [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition).
Pekerjaan HPO.
+ **id**— String, tipe: `string` (string yang dikodekan UTF-8).
Pengidentifikasi unik dari pekerjaan pelatihan model ini.
+ **mlModels** – Susunan objek [MlConfigDefinition](data-api-dp-ml-data-processing.md#MlConfigDefinition).
Daftar konfigurasi model ML yang digunakan.
+ **modelTransformJob** — Sebuah objek [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition).
Model mengubah pekerjaan.
+ **processingJob** — Sebuah objek [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition).
Pekerjaan pemrosesan data.
+ **status**— String, tipe: `string` (string yang dikodekan UTF-8).
Status pekerjaan pelatihan model.
**Kesalahan**
+ [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)
## Batalkan MLModel TrainingJob (tindakan)
Nama AWS CLI untuk API ini adalah:. `cancel-ml-model-training-job`
Membatalkan pekerjaan pelatihan model Neptunus Neptunus. Lihat [Pelatihan model menggunakan `modeltraining` perintah](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html).
[Saat menjalankan operasi ini di kluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan IAM Neptune-DB:Cancel di cluster tersebut. MLModel TrainingJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltrainingjob)
**Permintaan**
+ **clean**(dalam CLI:`--clean`) — Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Jika disetel ke`TRUE`, flag ini menetapkan bahwa semua artefak Amazon S3 harus dihapus ketika pekerjaan dihentikan. Nilai default-nya `FALSE`.
+ **id**(dalam CLI:`--id`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
Pengidentifikasi unik dari pekerjaan pelatihan model yang akan dibatalkan.
+ **neptuneIamRoleArn**(dalam CLI:`--neptune-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari peran IAM yang menyediakan akses Neptunus ke dan sumber daya Amazon S3. SageMaker Ini harus tercantum dalam grup parameter cluster DB Anda atau kesalahan akan terjadi.
**Respons**
+ **status**— String, tipe: `string` (string yang dikodekan UTF-8).
Status pembatalan.
**Kesalahan**
+ [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)
## *Struktur pelatihan model:*
## CustomModelTrainingParameters (struktur)
Berisi parameter pelatihan model khusus. Lihat [Model khusus di Neptunus](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-custom-models.html) ML.
**Bidang**
+ **sourceS3DirectoryPath**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Jalur ke lokasi Amazon S3 tempat modul Python yang mengimplementasikan model Anda berada. Ini harus menunjuk ke lokasi Amazon S3 yang valid yang berisi, setidaknya, skrip pelatihan, skrip transformasi, dan file. `model-hpo-configuration.json`
+ **trainingEntryPointScript**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Nama titik masuk dalam modul skrip Anda yang melakukan pelatihan model dan menggunakan hyperparameters sebagai argumen baris perintah, termasuk hyperparameters tetap. Nilai default-nya `training.py`.
+ **transformEntryPointScript**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Nama titik masuk dalam modul skrip Anda yang harus dijalankan setelah model terbaik dari pencarian hyperparameter telah diidentifikasi, untuk menghitung artefak model yang diperlukan untuk penerapan model. Itu harus dapat berjalan tanpa argumen baris perintah. Defaultnya adalah. `transform.py`
# Model Neptunus Neptunus mengubah API
**Tindakan transformasi model:**
+ [Mulai MLModel TransformJob (tindakan)](#StartMLModelTransformJob)
+ [Daftar MLModel TransformJobs (tindakan)](#ListMLModelTransformJobs)
+ [Dapatkan MLModel TransformJob (tindakan)](#GetMLModelTransformJob)
+ [Batalkan MLModel TransformJob (tindakan)](#CancelMLModelTransformJob)
**Struktur transformasi model:**
+ [CustomModelTransformParameters (struktur)](#CustomModelTransformParameters)
## Mulai MLModel TransformJob (tindakan)
Nama AWS CLI untuk API ini adalah:. `start-ml-model-transform-job`
Menciptakan pekerjaan transformasi model baru. Lihat [Menggunakan model terlatih untuk menghasilkan artefak model baru](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html).
[Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan IAM Neptune-DB:start di cluster tersebut. MLModel TransformJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeltransformjob)
**Permintaan**
+ **baseProcessingInstanceType**(dalam CLI:`--base-processing-instance-type`) — String, tipe: `string` (string yang dikodekan UTF-8).
Jenis instance ML yang digunakan dalam mempersiapkan dan mengelola pelatihan model ML. Ini adalah instance komputasi ML yang dipilih berdasarkan persyaratan memori untuk memproses data dan model pelatihan.
+ **baseProcessingInstanceVolumeSizeInGB**(dalam CLI:`--base-processing-instance-volume-size-in-gb`) — Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Ukuran volume disk dari instance pelatihan dalam gigabyte. Default-nya adalah 0. Input data dan model output disimpan dalam disk, sehingga ukuran volume harus cukup besar untuk menahan kedua set data. Jika tidak ditentukan atau 0, Neptunus ML memilih ukuran volume disk berdasarkan rekomendasi yang dihasilkan dalam langkah pemrosesan data.
+ **customModelTransformParameters**(dalam CLI:`--custom-model-transform-parameters`) — Sebuah [CustomModelTransformParameters](#CustomModelTransformParameters) objek.
Informasi konfigurasi untuk transformasi model menggunakan model kustom. `customModelTransformParameters`Objek berisi bidang berikut, yang harus memiliki nilai yang kompatibel dengan parameter model yang disimpan dari pekerjaan pelatihan:
+ **dataProcessingJobId**(dalam CLI:`--data-processing-job-id`) — String, tipe: `string` (string yang dikodekan UTF-8).
ID pekerjaan dari pekerjaan pemrosesan data yang telah selesai. Anda harus menyertakan salah satu `dataProcessingJobId` dan`mlModelTrainingJobId`, atau a`trainingJobName`.
+ **id**(dalam CLI:`--id`) — String, tipe: `string` (string yang dikodekan UTF-8).
Pengenal unik untuk pekerjaan baru. Defaultnya adalah UUID yang dibuat secara otomatis.
+ **mlModelTrainingJobId**(dalam CLI:`--ml-model-training-job-id`) — String, tipe: `string` (string yang dikodekan UTF-8).
ID pekerjaan dari pekerjaan pelatihan model yang telah selesai. Anda harus menyertakan salah satu `dataProcessingJobId` dan`mlModelTrainingJobId`, atau a`trainingJobName`.
+ **modelTransformOutputS3Location**(dalam CLI:`--model-transform-output-s3-location`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
Lokasi di Amazon S3 tempat artefak model akan disimpan.
+ **neptuneIamRoleArn**(dalam CLI:`--neptune-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari peran IAM yang menyediakan akses Neptunus ke dan sumber daya Amazon S3. SageMaker Ini harus tercantum dalam grup parameter cluster DB Anda atau kesalahan akan terjadi.
+ **s3OutputEncryptionKMSKey**(dalam CLI:`--s-3-output-encryption-kms-key`) — String, tipe: `string` (string yang dikodekan UTF-8).
Kunci Amazon Key Management Service (KMS) yang SageMaker digunakan untuk mengenkripsi output dari pekerjaan pemrosesan. Defaultnya tidak ada.
+ **sagemakerIamRoleArn**(dalam CLI:`--sagemaker-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari peran IAM untuk eksekusi. SageMaker Ini harus tercantum dalam grup parameter cluster DB Anda atau kesalahan akan terjadi.
+ **securityGroupIds**(dalam CLI:`--security-group-ids`) — String, tipe: `string` (string yang dikodekan UTF-8).
Grup keamanan VPC. IDs Default-nya adalah Tidak Ada.
+ **subnets**(dalam CLI:`--subnets`) — String, tipe: `string` (string yang dikodekan UTF-8).
Subnet di VPC Neptunus. IDs Default-nya adalah Tidak Ada.
+ **trainingJobName**(dalam CLI:`--training-job-name`) — String, tipe: `string` (string yang dikodekan UTF-8).
Nama pekerjaan SageMaker pelatihan yang telah selesai. Anda harus menyertakan salah satu `dataProcessingJobId` dan`mlModelTrainingJobId`, atau a`trainingJobName`.
+ **volumeEncryptionKMSKey**(dalam CLI:`--volume-encryption-kms-key`) — String, tipe: `string` (string yang dikodekan UTF-8).
Kunci Amazon Key Management Service (KMS) yang SageMaker digunakan untuk mengenkripsi data pada volume penyimpanan yang dilampirkan ke instans komputasi ML yang menjalankan tugas pelatihan. Default-nya adalah Tidak Ada.
**Respons**
+ **arn**— String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari model mengubah pekerjaan.
+ **creationTimeInMillis**— Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Waktu pembuatan model mengubah pekerjaan, dalam milidetik.
+ **id**— String, tipe: `string` (string yang dikodekan UTF-8).
ID unik dari pekerjaan transformasi model baru.
**Kesalahan**
+ [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)
## Daftar MLModel TransformJobs (tindakan)
Nama AWS CLI untuk API ini adalah:. `list-ml-model-transform-jobs`
Mengembalikan daftar pekerjaan model transformasi IDs. Lihat [Menggunakan model terlatih untuk menghasilkan artefak model baru](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html).
[Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan IAM Neptune-DB:List di cluster tersebut. MLModel TransformJobs](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmlmodeltransformjobs)
**Permintaan**
+ **maxItems**(dalam CLI:`--max-items`) — Daftar ListMLModelTransformJobsInputMaxItemsInteger, tipe: `integer` (bilangan bulat 32-bit yang ditandatangani), tidak kurang dari 1 atau lebih dari 1024? st? s.
Jumlah maksimum item yang akan dikembalikan (dari 1 hingga 1024; defaultnya adalah 10).
+ **neptuneIamRoleArn**(dalam CLI:`--neptune-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari peran IAM yang menyediakan akses Neptunus ke dan sumber daya Amazon S3. SageMaker Ini harus tercantum dalam grup parameter cluster DB Anda atau kesalahan akan terjadi.
**Respons**
+ **ids**— String, tipe: `string` (string yang dikodekan UTF-8).
Halaman dari daftar transformasi model IDs.
**Kesalahan**
+ [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)
## Dapatkan MLModel TransformJob (tindakan)
Nama AWS CLI untuk API ini adalah:. `get-ml-model-transform-job`
Mendapat informasi tentang pekerjaan transformasi model tertentu. Lihat [Menggunakan model terlatih untuk menghasilkan artefak model baru](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html).
[Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan Neptunus-DB:get IAM di cluster tersebut. MLModel TransformJobStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlmodeltransformjobstatus)
**Permintaan**
+ **id**(dalam CLI:`--id`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
Pengidentifikasi unik dari pekerjaan transformasi model yang akan direetrieved.
+ **neptuneIamRoleArn**(dalam CLI:`--neptune-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari peran IAM yang menyediakan akses Neptunus ke dan sumber daya Amazon S3. SageMaker Ini harus tercantum dalam grup parameter cluster DB Anda atau kesalahan akan terjadi.
**Respons**
+ **baseProcessingJob** — Sebuah objek [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition).
Pekerjaan pemrosesan data dasar.
+ **id**— String, tipe: `string` (string yang dikodekan UTF-8).
Pengidentifikasi unik dari pekerjaan transformasi model yang akan diambil.
+ **models** – Susunan objek [MlConfigDefinition](data-api-dp-ml-data-processing.md#MlConfigDefinition).
Daftar informasi konfigurasi untuk model yang digunakan.
+ **remoteModelTransformJob** — Sebuah objek [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition).
Pekerjaan transformasi model jarak jauh.
+ **status**— String, tipe: `string` (string yang dikodekan UTF-8).
Status pekerjaan transformasi model.
**Kesalahan**
+ [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)
## Batalkan MLModel TransformJob (tindakan)
Nama AWS CLI untuk API ini adalah:. `cancel-ml-model-transform-job`
Membatalkan pekerjaan transformasi model tertentu. Lihat [Menggunakan model terlatih untuk menghasilkan artefak model baru](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html).
[Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan IAM Neptune-DB:Cancel di cluster tersebut. MLModel TransformJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltransformjob)
**Permintaan**
+ **clean**(dalam CLI:`--clean`) — Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Jika bendera ini disetel ke`TRUE`, semua artefak Neptunus ML S3 harus dihapus saat pekerjaan dihentikan. Nilai default-nya `FALSE`.
+ **id**(dalam CLI:`--id`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
ID unik dari pekerjaan transformasi model yang akan dibatalkan.
+ **neptuneIamRoleArn**(dalam CLI:`--neptune-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari peran IAM yang menyediakan akses Neptunus ke dan sumber daya Amazon S3. SageMaker Ini harus tercantum dalam grup parameter cluster DB Anda atau kesalahan akan terjadi.
**Respons**
+ **status**— String, tipe: `string` (string yang dikodekan UTF-8).
status pembatalan.
**Kesalahan**
+ [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)
## *Struktur transformasi model:*
## CustomModelTransformParameters (struktur)
Berisi parameter transformasi model kustom. Lihat [Menggunakan model terlatih untuk menghasilkan artefak model baru](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html).
**Bidang**
+ **sourceS3DirectoryPath**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Jalur ke lokasi Amazon S3 tempat modul Python yang mengimplementasikan model Anda berada. Ini harus menunjuk ke lokasi Amazon S3 yang valid yang berisi, setidaknya, skrip pelatihan, skrip transformasi, dan file. `model-hpo-configuration.json`
+ **transformEntryPointScript**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).
Nama titik masuk dalam modul skrip Anda yang harus dijalankan setelah model terbaik dari pencarian hyperparameter telah diidentifikasi, untuk menghitung artefak model yang diperlukan untuk penerapan model. Itu harus dapat berjalan tanpa argumen baris perintah. Nilai default-nya `transform.py`.
# API titik akhir inferensi Neptunus ML
**Tindakan titik akhir inferensi:**
+ [Buat MLEndpoint (tindakan)](#CreateMLEndpoint)
+ [Daftar MLEndpoints (tindakan)](#ListMLEndpoints)
+ [Dapatkan MLEndpoint (tindakan)](#GetMLEndpoint)
+ [Hapus MLEndpoint (tindakan)](#DeleteMLEndpoint)
## Buat MLEndpoint (tindakan)
Nama AWS CLI untuk API ini adalah:. `create-ml-endpoint`
Membuat titik akhir inferensi Neptunus ML baru yang memungkinkan Anda menanyakan satu model spesifik yang dibuat oleh proses pelatihan model. Lihat [Mengelola titik akhir inferensi menggunakan perintah endpoints](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html).
[Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan Neptune-DB:Create IAM di cluster tersebut. MLEndpoint](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#createmlendpoint)
**Permintaan**
+ **id**(dalam CLI:`--id`) — String, tipe: `string` (string yang dikodekan UTF-8).
Pengidentifikasi unik untuk titik akhir inferensi baru. Defaultnya adalah nama stempel waktu yang dibuat secara otomatis.
+ **instanceCount**(dalam CLI:`--instance-count`) — Integer, tipe: `integer` (integer 32-bit yang ditandatangani).
Jumlah minimum EC2 instans Amazon untuk diterapkan ke titik akhir untuk prediksi. Defaultnya adalah 1
+ **instanceType**(dalam CLI:`--instance-type`) — String, tipe: `string` (string yang dikodekan UTF-8).
Jenis instance Neptunus ML yang digunakan untuk servis online. Nilai default-nya `ml.m5.xlarge`. Memilih instans ML untuk titik akhir inferensi bergantung pada jenis tugas, ukuran grafik, dan anggaran Anda.
+ **mlModelTrainingJobId**(dalam CLI:`--ml-model-training-job-id`) — String, tipe: `string` (string yang dikodekan UTF-8).
Id pekerjaan dari pekerjaan pelatihan model yang telah diselesaikan yang telah menciptakan model yang akan ditunjukkan oleh titik akhir inferensi. Anda harus menyediakan salah satu `mlModelTrainingJobId` atau`mlModelTransformJobId`.
+ **mlModelTransformJobId**(dalam CLI:`--ml-model-transform-job-id`) — String, tipe: `string` (string yang dikodekan UTF-8).
Id pekerjaan dari pekerjaan transformasi model yang telah selesai. Anda harus menyediakan salah satu `mlModelTrainingJobId` atau`mlModelTransformJobId`.
+ **modelName**(dalam CLI:`--model-name`) — String, tipe: `string` (string yang dikodekan UTF-8).
Jenis model untuk pelatihan. Secara default model Neptunus Neptunus secara otomatis didasarkan pada `modelType` yang digunakan dalam pemrosesan data, tetapi Anda dapat menentukan jenis model yang berbeda di sini. Defaultnya adalah `rgcn` untuk grafik heterogen dan `kge` untuk grafik pengetahuan. Satu-satunya nilai yang valid untuk grafik heterogen adalah. `rgcn` Nilai yang valid untuk grafik pengetahuan adalah:`kge`,, `transe``distmult`, dan`rotate`.
+ **neptuneIamRoleArn**(dalam CLI:`--neptune-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari peran IAM menyediakan akses Neptunus ke dan sumber daya Amazon S3. SageMaker Ini harus terdaftar di grup parameter cluster DB Anda atau kesalahan akan dilemparkan.
+ **update**(dalam CLI:`--update`) — Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Jika disetel ke`true`, `update` menunjukkan bahwa ini adalah permintaan pembaruan. Nilai default-nya `false`. Anda harus menyediakan salah satu `mlModelTrainingJobId` atau`mlModelTransformJobId`.
+ **volumeEncryptionKMSKey**(dalam CLI:`--volume-encryption-kms-key`) — String, tipe: `string` (string yang dikodekan UTF-8).
Kunci Amazon Key Management Service (Amazon KMS) yang SageMaker digunakan untuk mengenkripsi data pada volume penyimpanan yang dilampirkan ke instans komputasi ML yang menjalankan tugas pelatihan. Default-nya adalah Tidak Ada.
**Respons**
+ **arn**— String, tipe: `string` (string yang dikodekan UTF-8).
ARN untuk titik akhir inferensi baru.
+ **creationTimeInMillis**— Panjang, tipe: `long` (integer 64-bit yang ditandatangani).
Waktu pembuatan titik akhir, dalam milidetik.
+ **id**— String, tipe: `string` (string yang dikodekan UTF-8).
ID unik dari titik akhir inferensi baru.
**Kesalahan**
+ [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)
## Daftar MLEndpoints (tindakan)
Nama AWS CLI untuk API ini adalah:. `list-ml-endpoints`
Daftar titik akhir inferensi yang ada. Lihat [Mengelola titik akhir inferensi menggunakan perintah endpoints](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html).
[Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan IAM Neptune-DB:List di cluster tersebut. MLEndpoints](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmlendpoints)
**Permintaan**
+ **maxItems**(dalam CLI:`--max-items`) — Daftar MLEndpointsInputMaxItemsInteger, tipe: `integer` (bilangan bulat 32-bit yang ditandatangani), tidak kurang dari 1 atau lebih dari 1024? st? s.
Jumlah maksimum item yang akan dikembalikan (dari 1 hingga 1024; defaultnya adalah 10.
+ **neptuneIamRoleArn**(dalam CLI:`--neptune-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari peran IAM yang menyediakan akses Neptunus ke dan sumber daya Amazon S3. SageMaker Ini harus tercantum dalam grup parameter cluster DB Anda atau kesalahan akan terjadi.
**Respons**
+ **ids**— String, tipe: `string` (string yang dikodekan UTF-8).
Halaman dari daftar titik akhir IDs inferensi.
**Kesalahan**
+ [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)
## Dapatkan MLEndpoint (tindakan)
Nama AWS CLI untuk API ini adalah:. `get-ml-endpoint`
Mengambil detail tentang titik akhir inferensi. Lihat [Mengelola titik akhir inferensi menggunakan perintah endpoints](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html).
Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan IAM Neptune-DB:Get Status di cluster [tersebut MLEndpoint](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlendpointstatus).
**Permintaan**
+ **id**(dalam CLI:`--id`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
Pengidentifikasi unik dari titik akhir inferensi.
+ **neptuneIamRoleArn**(dalam CLI:`--neptune-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari peran IAM yang menyediakan akses Neptunus ke dan sumber daya Amazon S3. SageMaker Ini harus tercantum dalam grup parameter cluster DB Anda atau kesalahan akan terjadi.
**Respons**
+ **endpoint** — Sebuah objek [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition).
Definisi titik akhir.
+ **endpointConfig** — Sebuah objek [MlConfigDefinition](data-api-dp-ml-data-processing.md#MlConfigDefinition).
Konfigurasi titik akhir
+ **id**— String, tipe: `string` (string yang dikodekan UTF-8).
Pengidentifikasi unik dari titik akhir inferensi.
+ **status**— String, tipe: `string` (string yang dikodekan UTF-8).
Status titik akhir inferensi.
**Kesalahan**
+ [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)
## Hapus MLEndpoint (tindakan)
Nama AWS CLI untuk API ini adalah:. `delete-ml-endpoint`
Membatalkan pembuatan titik akhir inferensi Neptunus ML. Lihat [Mengelola titik akhir inferensi menggunakan perintah endpoints](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html).
[Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan IAM Neptune-DB:delete di cluster tersebut. MLEndpoint](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletemlendpoint)
**Permintaan**
+ **clean**(dalam CLI:`--clean`) — Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).
Jika bendera ini disetel ke`TRUE`, semua artefak Neptunus ML S3 harus dihapus saat pekerjaan dihentikan. Nilai default-nya `FALSE`.
+ **id**(dalam CLI:`--id`) - *Diperlukan: String, tipe:* `string` (string yang dikodekan UTF-8).
Pengidentifikasi unik dari titik akhir inferensi.
+ **neptuneIamRoleArn**(dalam CLI:`--neptune-iam-role-arn`) — String, tipe: `string` (string yang dikodekan UTF-8).
ARN dari peran IAM menyediakan akses Neptunus ke dan sumber daya Amazon S3. SageMaker Ini harus terdaftar di grup parameter cluster DB Anda atau kesalahan akan dilemparkan.
**Respons**
+ **status**— String, tipe: `string` (string yang dikodekan UTF-8).
Status pembatalan.
**Kesalahan**
+ [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)
# Pengecualian API jalur data Neptunus
**Pengecualian:**
+ [AccessDeniedException (struktur)](#AccessDeniedException)
+ [BadRequestException (struktur)](#BadRequestException)
+ [BulkLoadIdNotFoundException (struktur)](#BulkLoadIdNotFoundException)
+ [CancelledByUserException (struktur)](#CancelledByUserException)
+ [ClientTimeoutException (struktur)](#ClientTimeoutException)
+ [ConcurrentModificationException (struktur)](#ConcurrentModificationException)
+ [ConstraintViolationException (struktur)](#ConstraintViolationException)
+ [ExpiredStreamException (struktur)](#ExpiredStreamException)
+ [FailureByQueryException (struktur)](#FailureByQueryException)
+ [IllegalArgumentException (struktur)](#IllegalArgumentException)
+ [InternalFailureException (struktur)](#InternalFailureException)
+ [InvalidArgumentException (struktur)](#InvalidArgumentException)
+ [InvalidNumericDataException (struktur)](#InvalidNumericDataException)
+ [InvalidParameterException (struktur)](#InvalidParameterException)
+ [LoadUrlAccessDeniedException (struktur)](#LoadUrlAccessDeniedException)
+ [MalformedQueryException (struktur)](#MalformedQueryException)
+ [MemoryLimitExceededException (struktur)](#MemoryLimitExceededException)
+ [MethodNotAllowedException (struktur)](#MethodNotAllowedException)
+ [MissingParameterException (struktur)](#MissingParameterException)
+ [MLResourceNotFoundException (struktur)](#MLResourceNotFoundException)
+ [ParsingException (struktur)](#ParsingException)
+ [PreconditionsFailedException (struktur)](#PreconditionsFailedException)
+ [QueryLimitExceededException (struktur)](#QueryLimitExceededException)
+ [QueryLimitException (struktur)](#QueryLimitException)
+ [QueryTooLargeException (struktur)](#QueryTooLargeException)
+ [ReadOnlyViolationException (struktur)](#ReadOnlyViolationException)
+ [S3Exception (struktur)](#S3Exception)
+ [ServerShutdownException (struktur)](#ServerShutdownException)
+ [StatisticsNotAvailableException (struktur)](#StatisticsNotAvailableException)
+ [StreamRecordsNotFoundException (struktur)](#StreamRecordsNotFoundException)
+ [ThrottlingException (struktur)](#ThrottlingException)
+ [TimeLimitExceededException (struktur)](#TimeLimitExceededException)
+ [TooManyRequestsException (struktur)](#TooManyRequestsException)
+ [UnsupportedOperationException (struktur)](#UnsupportedOperationException)
+ [UnloadUrlAccessDeniedException (struktur)](#UnloadUrlAccessDeniedException)
## AccessDeniedException (struktur)
Dibesarkan jika terjadi kegagalan otentikasi atau otorisasi.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## BadRequestException (struktur)
Dibesarkan ketika permintaan diajukan yang tidak dapat diproses.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang buruk.
## BulkLoadIdNotFoundException (struktur)
Diangkat ketika ID pekerjaan beban massal yang ditentukan tidak dapat ditemukan.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID pekerjaan beban massal yang tidak dapat ditemukan.
## CancelledByUserException (struktur)
Dibesarkan saat pengguna membatalkan permintaan.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## ClientTimeoutException (struktur)
Dibesarkan ketika permintaan habis waktu di klien.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## ConcurrentModificationException (struktur)
Diangkat ketika permintaan mencoba untuk memodifikasi data yang secara bersamaan sedang dimodifikasi oleh proses lain.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## ConstraintViolationException (struktur)
Dibesarkan ketika nilai di bidang permintaan tidak memenuhi batasan yang diperlukan.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## ExpiredStreamException (struktur)
Diangkat saat permintaan mencoba mengakses aliran yang telah kedaluwarsa.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## FailureByQueryException (struktur)
Dibesarkan saat permintaan gagal.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## IllegalArgumentException (struktur)
Diangkat ketika argumen dalam permintaan tidak didukung.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## InternalFailureException (struktur)
Dibesarkan ketika pemrosesan permintaan gagal secara tak terduga.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## InvalidArgumentException (struktur)
Diangkat ketika argumen dalam permintaan memiliki nilai yang tidak valid.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## InvalidNumericDataException (struktur)
Diangkat ketika data numerik yang tidak valid ditemui saat melayani permintaan.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## InvalidParameterException (struktur)
Dibesarkan ketika nilai parameter tidak valid.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang menyertakan parameter yang tidak valid.
## LoadUrlAccessDeniedException (struktur)
Dibesarkan saat akses ditolak ke URL pemuatan tertentu.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## MalformedQueryException (struktur)
Diangkat ketika kueri dikirimkan yang secara sintaksis salah atau tidak lulus validasi tambahan.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan kueri yang salah format.
## MemoryLimitExceededException (struktur)
Dibesarkan ketika permintaan gagal karena sumber daya memori yang tidak mencukupi. Permintaan dapat dicoba lagi.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang gagal.
## MethodNotAllowedException (struktur)
Dibesarkan ketika metode HTTP yang digunakan oleh permintaan tidak didukung oleh endpoint yang digunakan.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## MissingParameterException (struktur)
Dibesarkan ketika parameter yang diperlukan hilang.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan di mana parameter hilang.
## MLResourceNotFoundException (struktur)
Dibesarkan ketika sumber daya pembelajaran mesin tertentu tidak dapat ditemukan.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## ParsingException (struktur)
Dibesarkan saat masalah parsing ditemui.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## PreconditionsFailedException (struktur)
Dibesarkan ketika prasyarat untuk memproses permintaan tidak terpenuhi.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## QueryLimitExceededException (struktur)
Dibesarkan ketika jumlah kueri aktif melebihi apa yang dapat diproses server. Kueri yang dimaksud dapat dicoba ulang ketika sistem kurang sibuk.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang melebihi batas.
## QueryLimitException (struktur)
Dibesarkan ketika ukuran kueri melebihi batas sistem.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang melebihi batas.
## QueryTooLargeException (struktur)
Dibesarkan ketika badan kueri terlalu besar.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang terlalu besar.
## ReadOnlyViolationException (struktur)
Diangkat saat permintaan mencoba menulis ke sumber daya hanya-baca.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan di mana parameter hilang.
## S3Exception (struktur)
Dibesarkan ketika ada masalah mengakses Amazon S3.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## ServerShutdownException (struktur)
Dibesarkan saat server dimatikan saat memproses permintaan.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## StatisticsNotAvailableException (struktur)
Dibesarkan ketika statistik yang diperlukan untuk memenuhi permintaan tidak tersedia.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## StreamRecordsNotFoundException (struktur)
Diangkat saat rekaman aliran yang diminta oleh kueri tidak dapat ditemukan.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## ThrottlingException (struktur)
Dinaikkan ketika tingkat permintaan melebihi throughput maksimum. Permintaan dapat dicoba lagi setelah menghadapi pengecualian ini.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang tidak dapat diproses karena alasan ini.
## TimeLimitExceededException (struktur)
Dibesarkan ketika operasi melebihi batas waktu yang diizinkan untuk itu.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang tidak dapat diproses karena alasan ini.
## TooManyRequestsException (struktur)
Dibesarkan ketika jumlah permintaan yang diproses melebihi batas.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang tidak dapat diproses karena alasan ini.
## UnsupportedOperationException (struktur)
Diangkat ketika permintaan mencoba untuk memulai operasi yang tidak didukung.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.
## UnloadUrlAccessDeniedException (struktur)
Diangkat saat akses ditolak ke URL yang merupakan target pembongkaran.
**Bidang**
+ **code**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Kode status HTTP dikembalikan dengan pengecualian.
+ **detailedMessage**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
Pesan terperinci yang menjelaskan masalah.
+ **requestId**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).
ID permintaan yang dimaksud.