DescribeSimulationJob - AWS RoboMaker
Minta SintaksParameter Permintaan URIIsi PermintaanSintaksis ResponsElemen ResponsKesalahanLihat Juga

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

DescribeSimulationJob

Menjelaskan pekerjaan simulasi.

Minta Sintaks

POST /describeSimulationJob HTTP/1.1
Content-type: application/json

{
   "job": "string"
}

Parameter Permintaan URI

Permintaan tidak menggunakan parameter URI apa pun.

Isi Permintaan

Permintaan menerima data berikut dalam format JSON.

job

Nama Sumber Daya Amazon (ARN) dari pekerjaan simulasi yang akan dijelaskan.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 1224.

Pola: arn:.*

Diperlukan: Ya

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",
   "failureReason": "string",
   "iamRole": "string",
   "lastStartedAt": number,
   "lastUpdatedAt": number,
   "loggingConfig": { 
      "recordAllRosTopics": boolean
   },
   "maxJobDurationInSeconds": number,
   "name": "string",
   "networkInterface": { 
      "networkInterfaceId": "string",
      "privateIpAddress": "string",
      "publicIpAddress": "string"
   },
   "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 memublikasikan log ke sumber CloudWatch Log yang disediakan pelanggan.

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

failureReason

Detail tentang mengapa pekerjaan simulasi gagal. Untuk informasi selengkapnya tentang pemecahan masalah, lihat Pemecahan Masalah.

Jenis: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 1024.

Pola: .*

iamRole

Peran IAM yang memungkinkan instans 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 maksimum dalam hitungan detik. Nilai harus 8 hari (691.200 detik) atau kurang.

Tipe: Long

name

Nama pekerjaan simulasi.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.

Pola: [a-zA-Z0-9_\-]*

networkInterface

Informasi antarmuka jaringan untuk pekerjaan simulasi.

Tipe: Objek NetworkInterface

outputLocation

Lokasi untuk file output yang dihasilkan oleh pekerjaan simulasi.

Tipe: Objek OutputLocation

robotApplications

Daftar aplikasi robot.

Tipe: Array objek RobotApplicationConfig

Anggota Array: Jumlah tetap 1 item.

simulationApplications

Daftar aplikasi 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

tags

Daftar semua tag ditambahkan ke pekerjaan simulasi yang ditentukan.

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

Konfigurasi VPC.

Tipe: Objek VPCConfigResponse

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

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

ResourceNotFoundException

Sumber daya yang ditentukan tidak ada.

Kode Status HTTP: 400

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: