Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
CreateSimulationJob
Membuat pekerjaan simulasi.
catatan
Setelah 90 hari, pekerjaan simulasi berakhir dan akan dihapus. Mereka tidak akan lagi dapat diakses.
Minta Sintaks
POST /createSimulationJob HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"compute": {
"computeType": "string",
"gpuUnitLimit": number,
"simulationUnitLimit": number
},
"dataSources": [
{
"destination": "string",
"name": "string",
"s3Bucket": "string",
"s3Keys": [ "string" ],
"type": "string"
}
],
"failureBehavior": "string",
"iamRole": "string",
"loggingConfig": {
"recordAllRosTopics": boolean
},
"maxJobDurationInSeconds": number,
"outputLocation": {
"s3Bucket": "string",
"s3Prefix": "string"
},
"robotApplications": [
{
"application": "string",
"applicationVersion": "string",
"launchConfig": {
"command": [ "string" ],
"environmentVariables": {
"string" : "string"
},
"launchFile": "string",
"packageName": "string",
"portForwardingConfig": {
"portMappings": [
{
"applicationPort": number,
"enableOnPublicIp": boolean,
"jobPort": number
}
]
},
"streamUI": boolean
},
"tools": [
{
"command": "string",
"exitBehavior": "string",
"name": "string",
"streamOutputToCloudWatch": boolean,
"streamUI": boolean
}
],
"uploadConfigurations": [
{
"name": "string",
"path": "string",
"uploadBehavior": "string"
}
],
"useDefaultTools": boolean,
"useDefaultUploadConfigurations": boolean
}
],
"simulationApplications": [
{
"application": "string",
"applicationVersion": "string",
"launchConfig": {
"command": [ "string" ],
"environmentVariables": {
"string" : "string"
},
"launchFile": "string",
"packageName": "string",
"portForwardingConfig": {
"portMappings": [
{
"applicationPort": number,
"enableOnPublicIp": boolean,
"jobPort": number
}
]
},
"streamUI": boolean
},
"tools": [
{
"command": "string",
"exitBehavior": "string",
"name": "string",
"streamOutputToCloudWatch": boolean,
"streamUI": boolean
}
],
"uploadConfigurations": [
{
"name": "string",
"path": "string",
"uploadBehavior": "string"
}
],
"useDefaultTools": boolean,
"useDefaultUploadConfigurations": boolean,
"worldConfigs": [
{
"world": "string"
}
]
}
],
"tags": {
"string" : "string"
},
"vpcConfig": {
"assignPublicIp": boolean,
"securityGroups": [ "string" ],
"subnets": [ "string" ]
}
}Parameter Permintaan URI
Permintaan tidak menggunakan parameter URI apa pun.
Isi Permintaan
Permintaan menerima data berikut dalam format JSON.
- clientRequestToken
-
Pengidentifikasi unik dan peka huruf besar/kecil yang Anda berikan untuk memastikan idempotensi permintaan.
Jenis: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum adalah 64.
Pola:
[a-zA-Z0-9_\-=]*Wajib: Tidak
- compute
-
Menghitung informasi untuk pekerjaan simulasi.
Tipe: Objek Compute
Wajib: Tidak
- dataSources
-
Tentukan sumber data untuk memasang file hanya-baca dari S3 ke dalam simulasi Anda. File-file ini tersedia di bawah
/opt/robomaker/datasources/data_source_name.catatan
Ada batas 100 file dan ukuran gabungan 25GB untuk semua
DataSourceConfigobjek.Tipe: Array objek DataSourceConfig
Anggota Array: Jumlah minimum 1 item. Jumlah maksimum 6 item.
Wajib: Tidak
- failureBehavior
-
Perilaku kegagalan pekerjaan simulasi.
- Lanjutkan
-
Membiarkan instance berjalan untuk durasi batas waktu maksimum setelah kode
4XXkesalahan. - Gagal
-
Hentikan pekerjaan simulasi dan hentikan instance.
Jenis: String
Nilai yang Valid:
Fail | ContinueWajib: Tidak
- iamRole
-
Nama peran IAM yang memungkinkan instans simulasi memanggil AWS API yang ditentukan dalam kebijakan terkait atas nama Anda. Ini adalah bagaimana kredensil diteruskan ke pekerjaan simulasi Anda.
Jenis: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.
Pola:
arn:aws:iam::\w+:role/.*Wajib: Ya
- loggingConfig
-
Konfigurasi logging.
Tipe: Objek LoggingConfig
Wajib: Tidak
- maxJobDurationInSeconds
-
Durasi pekerjaan simulasi maksimum dalam hitungan detik (hingga 14 hari atau 1.209.600 detik. Ketika
maxJobDurationInSecondstercapai, pekerjaan simulasi akan status akan bertransisi keCompleted.Tipe: Long
Wajib: Ya
- outputLocation
-
Lokasi untuk file output yang dihasilkan oleh pekerjaan simulasi.
Tipe: Objek OutputLocation
Wajib: Tidak
- robotApplications
-
Aplikasi robot untuk digunakan dalam pekerjaan simulasi.
Tipe: Array objek RobotApplicationConfig
Anggota Array: Jumlah tetap 1 item.
Wajib: Tidak
- simulationApplications
-
Aplikasi simulasi untuk digunakan dalam pekerjaan simulasi.
Tipe: Array objek SimulationApplicationConfig
Anggota Array: Jumlah tetap 1 item.
Wajib: Tidak
-
Peta yang berisi kunci tag dan nilai tag yang dilampirkan ke pekerjaan simulasi.
Tipe: Peta string ke string
Entri Peta: Jumlah minimum 0 item. Jumlah maksimum 50 item.
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.
Pola Kunci:
[a-zA-Z0-9 _.\-\/+=:]*Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.
Pola nilai:
[a-zA-Z0-9 _.\-\/+=:]*Wajib: Tidak
- vpcConfig
-
Jika pekerjaan simulasi Anda mengakses sumber daya dalam VPC, Anda memberikan parameter ini untuk mengidentifikasi daftar ID grup keamanan dan ID subnet. Ini harus milik VPC yang sama. Anda harus memberikan setidaknya satu grup keamanan dan satu subnet ID.
Tipe: Objek VPCConfig
Wajib: Tidak
Sintaksis Respons
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"clientRequestToken": "string",
"compute": {
"computeType": "string",
"gpuUnitLimit": number,
"simulationUnitLimit": number
},
"dataSources": [
{
"destination": "string",
"name": "string",
"s3Bucket": "string",
"s3Keys": [
{
"etag": "string",
"s3Key": "string"
}
],
"type": "string"
}
],
"failureBehavior": "string",
"failureCode": "string",
"iamRole": "string",
"lastStartedAt": number,
"lastUpdatedAt": number,
"loggingConfig": {
"recordAllRosTopics": boolean
},
"maxJobDurationInSeconds": number,
"outputLocation": {
"s3Bucket": "string",
"s3Prefix": "string"
},
"robotApplications": [
{
"application": "string",
"applicationVersion": "string",
"launchConfig": {
"command": [ "string" ],
"environmentVariables": {
"string" : "string"
},
"launchFile": "string",
"packageName": "string",
"portForwardingConfig": {
"portMappings": [
{
"applicationPort": number,
"enableOnPublicIp": boolean,
"jobPort": number
}
]
},
"streamUI": boolean
},
"tools": [
{
"command": "string",
"exitBehavior": "string",
"name": "string",
"streamOutputToCloudWatch": boolean,
"streamUI": boolean
}
],
"uploadConfigurations": [
{
"name": "string",
"path": "string",
"uploadBehavior": "string"
}
],
"useDefaultTools": boolean,
"useDefaultUploadConfigurations": boolean
}
],
"simulationApplications": [
{
"application": "string",
"applicationVersion": "string",
"launchConfig": {
"command": [ "string" ],
"environmentVariables": {
"string" : "string"
},
"launchFile": "string",
"packageName": "string",
"portForwardingConfig": {
"portMappings": [
{
"applicationPort": number,
"enableOnPublicIp": boolean,
"jobPort": number
}
]
},
"streamUI": boolean
},
"tools": [
{
"command": "string",
"exitBehavior": "string",
"name": "string",
"streamOutputToCloudWatch": boolean,
"streamUI": boolean
}
],
"uploadConfigurations": [
{
"name": "string",
"path": "string",
"uploadBehavior": "string"
}
],
"useDefaultTools": boolean,
"useDefaultUploadConfigurations": boolean,
"worldConfigs": [
{
"world": "string"
}
]
}
],
"simulationTimeMillis": number,
"status": "string",
"tags": {
"string" : "string"
},
"vpcConfig": {
"assignPublicIp": boolean,
"securityGroups": [ "string" ],
"subnets": [ "string" ],
"vpcId": "string"
}
}Elemen Respons
Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.
Layanan mengembalikan data berikut dalam format JSON.
- arn
-
Nama Sumber Daya Amazon (ARN) dari pekerjaan simulasi.
Jenis: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum 1224.
Pola:
arn:.* - clientRequestToken
-
Pengidentifikasi unik dan peka huruf besar/kecil yang Anda berikan untuk memastikan idempotensi permintaan.
Jenis: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum adalah 64.
Pola:
[a-zA-Z0-9_\-=]* - compute
-
Menghitung informasi untuk pekerjaan simulasi.
Tipe: Objek ComputeResponse
- dataSources
-
Sumber data untuk pekerjaan simulasi.
Tipe: Array objek DataSource
- failureBehavior
-
perilaku kegagalan untuk pekerjaan simulasi.
Jenis: String
Nilai yang Valid:
Fail | Continue - failureCode
-
Kode kegagalan pekerjaan simulasi jika gagal:
- InternalServiceError
-
Kesalahan layanan internal.
- RobotApplicationCrash
-
Aplikasi robot keluar secara tidak normal.
- SimulationApplicationCrash
-
Aplikasi simulasi keluar secara tidak normal.
- BadPermissionsRobotApplication
-
Bundel aplikasi robot tidak dapat diunduh.
- BadPermissionsSimulationApplication
-
Bundel aplikasi simulasi tidak dapat diunduh.
- BadPermissionsKeluaran S3
-
Tidak dapat mempublikasikan output ke bucket S3 yang disediakan pelanggan.
- BadPermissionsCloudwatchLogs
-
Tidak dapat mempublikasikan log ke sumber Log yang disediakan pelanggan CloudWatch .
- SubnetIpLimitExceeded
-
Batas IP subnet terlampaui.
- ENI LimitExceeded
-
Batas ENI terlampaui.
- BadPermissionsUserCredentials
-
Tidak dapat menggunakan Peran yang disediakan.
- InvalidBundleRobotApplication
-
Bundel robot tidak dapat diekstraksi (format tidak valid, kesalahan bundling, atau masalah lainnya).
- InvalidBundleSimulationApplication
-
Bundel simulasi tidak dapat diekstraksi (format tidak valid, kesalahan bundling, atau masalah lainnya).
- RobotApplicationVersionMismatchedEtag
-
Etag for RobotApplication tidak cocok dengan nilai selama pembuatan versi.
- SimulationApplicationVersionMismatchedEtag
-
Etag for SimulationApplication tidak cocok dengan nilai selama pembuatan versi.
Jenis: String
Nilai yang Valid:
InternalServiceError | RobotApplicationCrash | SimulationApplicationCrash | RobotApplicationHealthCheckFailure | SimulationApplicationHealthCheckFailure | BadPermissionsRobotApplication | BadPermissionsSimulationApplication | BadPermissionsS3Object | BadPermissionsS3Output | BadPermissionsCloudwatchLogs | SubnetIpLimitExceeded | ENILimitExceeded | BadPermissionsUserCredentials | InvalidBundleRobotApplication | InvalidBundleSimulationApplication | InvalidS3Resource | ThrottlingError | LimitExceeded | MismatchedEtag | RobotApplicationVersionMismatchedEtag | SimulationApplicationVersionMismatchedEtag | ResourceNotFound | RequestThrottled | BatchTimedOut | BatchCanceled | InvalidInput | WrongRegionS3Bucket | WrongRegionS3Output | WrongRegionRobotApplication | WrongRegionSimulationApplication | UploadContentMismatchError - iamRole
-
Peran IAM yang memungkinkan pekerjaan simulasi memanggil AWS API yang ditentukan dalam kebijakan terkait atas nama Anda.
Jenis: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.
Pola:
arn:aws:iam::\w+:role/.* - lastStartedAt
-
Waktu, dalam milidetik sejak zaman, ketika pekerjaan simulasi terakhir dimulai.
Tipe: Timestamp
- lastUpdatedAt
-
Waktu, dalam milidetik sejak zaman, ketika pekerjaan simulasi terakhir diperbarui.
Tipe: Timestamp
- loggingConfig
-
Konfigurasi logging.
Tipe: Objek LoggingConfig
- maxJobDurationInSeconds
-
Durasi pekerjaan simulasi maksimum dalam hitungan detik.
Tipe: Long
- outputLocation
-
Lokasi file keluaran pekerjaan simulasi.
Tipe: Objek OutputLocation
- robotApplications
-
Aplikasi robot yang digunakan oleh pekerjaan simulasi.
Tipe: Array objek RobotApplicationConfig
Anggota Array: Jumlah tetap 1 item.
- simulationApplications
-
Aplikasi simulasi yang digunakan oleh pekerjaan simulasi.
Tipe: Array objek SimulationApplicationConfig
Anggota Array: Jumlah tetap 1 item.
- simulationTimeMillis
-
Durasi eksekusi pekerjaan simulasi dalam milidetik.
Tipe: Long
- status
-
Status pekerjaan simulasi.
Jenis: String
Nilai yang Valid:
Pending | Preparing | Running | Restarting | Completed | Failed | RunningFailed | Terminating | Terminated | Canceled -
Daftar semua tag ditambahkan ke pekerjaan simulasi.
Tipe: Peta string ke string
Entri Peta: Jumlah minimum 0 item. Jumlah maksimum 50 item.
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.
Pola Kunci:
[a-zA-Z0-9 _.\-\/+=:]*Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.
Pola nilai:
[a-zA-Z0-9 _.\-\/+=:]* - vpcConfig
-
Informasi tentang konfigurasi vpc.
Tipe: Objek VPCConfigResponse
Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.
- IdempotentParameterMismatchException
-
Permintaan menggunakan token klien yang sama dengan permintaan sebelumnya, tetapi tidak identik. Jangan menggunakan kembali token klien dengan permintaan yang berbeda, kecuali permintaannya identik.
Kode Status HTTP: 400
- InternalServerException
-
AWS RoboMaker mengalami masalah layanan. Coba lagi panggilan Anda.
Kode Status HTTP: 500
- InvalidParameterException
-
Parameter yang ditentukan dalam permintaan tidak valid, tidak didukung, atau tidak dapat digunakan. Pesan yang dikembalikan memberikan penjelasan tentang nilai kesalahan.
Kode Status HTTP: 400
- LimitExceededException
-
Sumber daya yang diminta melebihi jumlah maksimum yang diizinkan, atau jumlah permintaan aliran bersamaan melebihi jumlah maksimum yang diizinkan.
Kode Status HTTP: 400
- ResourceNotFoundException
-
Sumber daya yang ditentukan tidak ada.
Kode Status HTTP: 400
- ServiceUnavailableException
-
Permintaan telah gagal karena kegagalan sementara server.
Kode Status HTTP: 503
- ThrottlingException
-
RoboMaker AWS untuk sementara tidak dapat memproses permintaan. Coba lagi panggilan Anda.
Kode Status HTTP: 400
Lihat Juga
Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini:
