本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
DescribeSimulationJobBatch
描述模拟作业批处理。
请求语法
POST /describeSimulationJobBatch HTTP/1.1
Content-type: application/json
{
"batch": "string"
}URI 请求参数
该请求不使用任何 URI 参数。
请求体
请求接受采用 JSON 格式的以下数据。
- batch
-
要描述的批处理 ID。
类型：字符串
长度限制：长度下限为 1。最大长度为 1224。
模式：
arn:.*必需：是
响应语法
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"batchPolicy": {
"maxConcurrency": number,
"timeoutInSeconds": number
},
"clientRequestToken": "string",
"createdAt": number,
"createdRequests": [
{
"arn": "string",
"computeType": "string",
"dataSourceNames": [ "string" ],
"lastUpdatedAt": number,
"name": "string",
"robotApplicationNames": [ "string" ],
"simulationApplicationNames": [ "string" ],
"status": "string"
}
],
"failedRequests": [
{
"failedAt": number,
"failureCode": "string",
"failureReason": "string",
"request": {
"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"
},
"useDefaultApplications": boolean,
"vpcConfig": {
"assignPublicIp": boolean,
"securityGroups": [ "string" ],
"subnets": [ "string" ]
}
}
}
],
"failureCode": "string",
"failureReason": "string",
"lastUpdatedAt": number,
"pendingRequests": [
{
"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"
},
"useDefaultApplications": boolean,
"vpcConfig": {
"assignPublicIp": boolean,
"securityGroups": [ "string" ],
"subnets": [ "string" ]
}
}
],
"status": "string",
"tags": {
"string" : "string"
}
}响应元素
如果此操作成功，则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
- arn
-
批处理的 Amazon 资源名称（ARN）。
类型：字符串
长度限制：长度下限为 1。最大长度为 1224。
模式：
arn:.* - batchPolicy
-
批处理策略。
类型：BatchPolicy 对象
- clientRequestToken
-
用于确保请求的幂等性而提供的唯一、区分大小写的标识符。
类型：字符串
长度限制：长度下限为 1。长度上限为 64。
模式：
[a-zA-Z0-9_\-=]* - createdAt
-
创建模拟作业批处理的时间，用从纪元开始的毫秒数表示。
类型：时间戳
- createdRequests
-
已创建的模拟作业汇总列表。
类型：SimulationJobSummary 对象数组
数组成员：最少 0 个物品。最多 100 个项目。
- failedRequests
-
创建失败的模拟作业请求列表。在模拟作业中创建请求失败。请求失败便没有模拟作业 ID。
类型：FailedCreateSimulationJobRequest 对象数组
- failureCode
-
模拟作业批处理的失败代码。
类型：字符串
有效值：
InternalServiceError - failureReason
-
模拟作业批处理失败的原因。
类型：字符串
长度约束：最小长度为 0。最大长度为 1024。
模式：
.* - lastUpdatedAt
-
上次更新模拟作业批处理的时间，用从纪元开始的毫秒数表示。
类型：时间戳
- pendingRequests
-
待处理模拟作业请求列表。这些请求尚未创建到模拟作业中。
类型：SimulationJobRequest 对象数组
数组成员：最少 1 个物品。最多 1000 项。
- status
-
批处理的状态。
- 待处理
-
模拟作业批处理请求待处理。
- InProgress
-
模拟作业批处理正在进行中。
- 失败
-
模拟作业批处理失败。由于内部故障（例如
InternalServiceError），无法完成一个或多个模拟作业请求。有关更多信息，请参阅failureCode和failureReason。 - 已完成
-
模拟批处理作业已完成。如果 (1) 批处理中没有待处理模拟作业请求，也不存在模拟作业请求因
InternalServiceError而失败；(2) 所有已创建的模拟作业都已达到最终状态（例如，Completed或Failed），批处理即告完成。 - 已取消
-
模拟批处理作业已取消。
- 正在取消
-
模拟批处理作业正在取消。
- 正在完成
-
模拟批处理作业正在完成。
- TimingOut
-
模拟批处理作业即将超时。
如果批处理超时，并且有待处理的请求因内部故障（例如
InternalServiceError）而失败，则批处理状态将为Failed。如果没有此类失败请求，则批处理状态将为TimedOut。 - TimedOut
-
模拟批处理作业已超时。
类型：字符串
有效值：
Pending | InProgress | Failed | Completed | Canceled | Canceling | Completing | TimingOut | TimedOut -
包含附加到模拟作业批处理的标签键和标签值的映射。
类型：字符串到字符串映射
映射条目：最低 0 项。最多 50 项。
密钥长度限制：最小长度为 1。长度上限为 128。
键模式：
[a-zA-Z0-9 _.\-\/+=:]*值长度限制：最小长度为 0。最大长度为 256。
价值模式：
[a-zA-Z0-9 _.\-\/+=:]*
错误
有关所有操作的常见错误信息，请参阅常见错误。
- InternalServerException
-
AWS RoboMaker 遇到了服务问题。重新尝试您的调用。
HTTP 状态代码：500
- InvalidParameterException
-
在请求中指定的参数无效、不受支持，或无法使用。请求的消息解释错误值。
HTTP 状态代码：400
- ResourceNotFoundException
-
指定的资源不存在。
HTTP 状态代码：400
另请参阅
有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
