Request Syntax URI 요청 파라미터 요청 본문 응답 구문 응답 요소 Errors 참고

DescribeSimulationJob

시뮬레이션 작업을 설명합니다.

Request Syntax


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

{
   "job": "string"
}

URI 요청 파라미터

요청은 URI 파라미터를 사용하지 않습니다.

요청 본문

요청은 JSON 형식으로 다음 데이터를 받습니다.

job

설명할 시뮬레이션 작업의 Amazon 리소스 이름(ARN)입니다.

유형: 문자열

길이 제약: 최소 길이 1. 최대 길이는 1224입니다.

패턴: arn:.*

필수 항목 여부: 예

응답 구문


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"
   }
}

응답 요소

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

arn

시뮬레이션 작업의 Amazon 리소스 이름(ARN)입니다.

유형: 문자열

길이 제약: 최소 길이 1. 최대 길이는 1224입니다.

패턴: arn:.*

clientRequestToken

요청 멱등성을 보장하기 위해 제공하는 고유한 대소문자 구분 식별자입니다.

유형: 문자열

길이 제한: 최소 길이는 1. 최대 길이는 64.

패턴: [a-zA-Z0-9_\-=]*

compute

시뮬레이션 작업에 대한 컴퓨팅 정보입니다.

유형: ComputeResponse객체

dataSources

시뮬레이션 작업의 데이터 소스입니다.

유형: DataSource객체 어레이

failureBehavior

시뮬레이션 작업의 실패 동작입니다.

타입: 문자열

유효 값: Fail | Continue

failureCode

시뮬레이션 작업 실패 시 발생하는 오류 코드:

InternalServiceError: 내부 서비스 오류.
RobotApplicationCrash: 로봇 애플리케이션이 비정상적으로 종료되었습니다.
SimulationApplicationCrash: 시뮬레이션 애플리케이션이 비정상적으로 종료되었습니다.
BadPermissionsRobotApplication: 로봇 애플리케이션 번들을 다운로드할 수 없습니다.
BadPermissionsSimulationApplication: 시뮬레이션 애플리케이션 번들을 다운로드할 수 없습니다.
BadPermissionsS3 출력: 출력을 고객이 제공한 S3 버킷에 게시할 수 없습니다.
BadPermissionsCloudwatchLogs: 고객이 CloudWatch 제공한 Logs 리소스에 로그를 게시할 수 없습니다.
SubnetIpLimitExceeded: 서브넷 IP 제한을 초과했습니다.
ENI LimitExceeded: ENI 제한을 초과했습니다.
BadPermissionsUserCredentials: 제공된 역할을 사용할 수 없습니다.
InvalidBundleRobotApplication: 로봇 번들을 추출할 수 없습니다(잘못된 형식, 번들링 오류 또는 기타 문제).
InvalidBundleSimulationApplication: 시뮬레이션 번들을 추출할 수 없습니다(잘못된 형식, 번들링 오류 또는 기타 문제).
RobotApplicationVersionMismatchedEtag: 버전 생성 중 Etag for 값이 일치하지 RobotApplication 않습니다.
SimulationApplicationVersionMismatchedEtag: 버전 생성 시 Etag for 값이 일치하지 SimulationApplication 않습니다.