DescribeSimulationJobBatch - AWS RoboMaker

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

DescribeSimulationJobBatch

시뮬레이션 작업 배치를 설명합니다.

Request Syntax

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

시뮬레이션 작업 배치가 마지막으로 생성된 epoch 이후 경과 시간(밀리초)입니다.

유형: 타임스탬프

createdRequests

생성된 시뮬레이션 작업 요약 목록입니다.

유형: SimulationJobSummary객체 어레이

어레이 멤버: 최소 항목 수 0개. 최대 항목 수는 100개입니다.

failedRequests

실패한 시뮬레이션 작업 생성 요청 목록입니다. 요청이 시뮬레이션 작업을 생성하는데 실패했습니다. 실패한 요청에는 시뮬레이션 작업 ID가 없습니다.

유형: FailedCreateSimulationJobRequest객체 어레이

failureCode

시뮬레이션 작업 배치의 실패 코드입니다.

타입: 문자열

유효 값: InternalServiceError

failureReason

시뮬레이션 작업 배치가 실패한 이유입니다.

타입: 문자열

길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 1024입니다.

패턴: .*

lastUpdatedAt

시뮬레이션 작업 배치가 마지막으로 업데이트된 epoch 이후 경과 시간(밀리초)입니다.

유형: 타임스탬프

pendingRequests

보류 중인 시뮬레이션 작업 요청 목록입니다. 이러한 요청은 아직 시뮬레이션 작업에 생성되지 않았습니다.

유형: SimulationJobRequest객체 어레이

배열 멤버: 최소 항목 수는 1입니다. 최대 항목 수는 1000개입니다.

status

배치의 상태입니다.

보류중

시뮬레이션 작업 배치 요청이 보류 중입니다.

InProgress

시뮬레이션 작업 배치가 진행 중입니다.

Failed

시뮬레이션 작업 배치가 실패했습니다. 내부 장애(예: InternalServiceError)로 인해 하나 이상의 시뮬레이션 작업 요청을 완료할 수 없습니다. 자세한 내용은 failureCodefailureReason 섹션을 참조하세요.

완료됨

시뮬레이션 배치 작업이 완료되었습니다. 다음의 경우 배치가 완료됩니다. (1) 배치에 보류 중인 시뮬레이션 작업 요청이 없고 실패한 시뮬레이션 작업 요청 모두가 InternalServiceError로 인한 것이 아닌 경우, (2) 생성된 모든 시뮬레이션 작업이 최종 상태(예: Completed 또는 Failed)에 도달한 경우.

취소됨

시뮬레이션 배치 작업이 취소되었습니다.

취소 중

시뮬레이션 배치 작업을 취소 중입니다.

완료 중

시뮬레이션 배치 작업을 완료 중입니다.

TimingOut

시뮬레이션 작업 배치 시간이 초과되었습니다.

배치 시간이 초과되고 내부 장애(예: InternalServiceError)로 인해 실패한 보류 중인 요청이 있는 경우, 배치 상태는 Failed입니다. 이러한 실패한 요청이 없는 경우 배치 상태는 TimedOut입니다.

TimedOut

시뮬레이션 배치 작업 시간이 초과되었습니다.

타입: 문자열

유효 값: Pending | InProgress | Failed | Completed | Canceled | Canceling | Completing | TimingOut | TimedOut

tags

시뮬레이션 작업 배치에 연결된 태그 키 및 태그 값을 포함하는 맵입니다.

유형: 문자열-문자열 맵

맵 항목: 최소 항목 수는 0개입니다. 최대 항목 수는 50개입니다.

키 길이 제약 조건: 최소 길이는 1. 최대 길이 128.

키 패턴: [a-zA-Z0-9 _.\-\/+=:]*

값 길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 256.

가치 패턴: [a-zA-Z0-9 _.\-\/+=:]*

Errors

모든 작업에서 발생하는 일반적인 오류에 대한 자세한 내용은 일반적인 오류 섹션을 참조하세요.

InternalServerException

RoboMaker AWS에서 서비스 문제가 발생했습니다. 호출을 다시 시도하세요.

HTTP 상태 코드: 500

InvalidParameterException

요청에 지정된 파라미터는 유효하지 않거나, 지원되지 않거나, 사용할 수 없습니다. 반환된 메시지는 오류 값에 대한 설명을 제공합니다.

HTTP 상태 코드: 400

ResourceNotFoundException

지정한 리소스가 존재하지 않습니다.

HTTP 상태 코드: 400

참고

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.