기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
DescribeWorld
월드 설명입니다.
Request Syntax
POST /describeWorld HTTP/1.1
Content-type: application/json
{
"world": "string"
}URI 요청 파라미터
요청은 URI 파라미터를 사용하지 않습니다.
요청 본문
요청은 JSON 형식으로 다음 데이터를 받습니다.
- world
-
설명하려는 월드의 Amazon 리소스 이름(ARN)입니다.
유형: 문자열
길이 제약: 최소 길이 1. 최대 길이는 1224입니다.
패턴:
arn:.*필수 항목 여부: 예
응답 구문
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"createdAt": number,
"generationJob": "string",
"tags": {
"string" : "string"
},
"template": "string",
"worldDescriptionBody": "string"
}응답 요소
작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.
다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.
- arn
-
월드의 Amazon 리소스 이름(ARN)입니다.
유형: 문자열
길이 제약: 최소 길이 1. 최대 길이는 1224입니다.
패턴:
arn:.* - createdAt
-
월드가 생성된 epoch 이후 경과 시간(밀리초)입니다.
유형: 타임스탬프
- generationJob
-
월드 생성 작업을 생성한 월드 생성 작업의 Amazon 리소스 이름(ARN)입니다.
유형: 문자열
길이 제약: 최소 길이 1. 최대 길이는 1224입니다.
패턴:
arn:.* -
월드에 연결된 태그 키 및 태그 값을 포함하는 맵입니다.
유형: 문자열-문자열 맵
맵 항목: 최소 항목 수는 0개입니다. 최대 항목 수는 50개입니다.
키 길이 제약 조건: 최소 길이는 1. 최대 길이 128.
키 패턴:
[a-zA-Z0-9 _.\-\/+=:]*값 길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 256.
가치 패턴:
[a-zA-Z0-9 _.\-\/+=:]* - template
-
월드 템플릿.
유형: 문자열
길이 제약: 최소 길이 1. 최대 길이는 1224입니다.
패턴:
arn:.* - worldDescriptionBody
-
월드의 콘텐츠를 설명하는 JSON 형식의 문자열을 반환합니다.
유형: 문자열
길이 제약: 최소 길이 1. 최대 길이는 262144자입니다.
패턴:
[\S\s]+
Errors
모든 작업에서 발생하는 일반적인 오류에 대한 자세한 내용은 일반적인 오류 섹션을 참조하세요.
- InternalServerException
-
RoboMaker AWS에서 서비스 문제가 발생했습니다. 호출을 다시 시도하세요.
HTTP 상태 코드: 500
- InvalidParameterException
-
요청에 지정된 파라미터는 유효하지 않거나, 지원되지 않거나, 사용할 수 없습니다. 반환된 메시지는 오류 값에 대한 설명을 제공합니다.
HTTP 상태 코드: 400
- ResourceNotFoundException
-
지정한 리소스가 존재하지 않습니다.
HTTP 상태 코드: 400
- ThrottlingException
-
RoboMaker AWS는 일시적으로 요청을 처리할 수 없습니다. 호출을 다시 시도하세요.
HTTP 상태 코드: 400
참고
언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
