ListRobots - AWS RoboMaker
Request SyntaxURI 요청 파라미터요청 본문응답 구문응답 요소Errors참고

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

ListRobots

이 작업은 사용 중단되었습니다.

중요

해당 API는 더 이상 지원되지 않습니다. 자세한 내용은 지원 정책 페이지에서 2022년 5월 2일 업데이트를 참조하세요.

로봇 목록을 반환합니다. 선택적으로 특정 로봇을 검색하기 위한 필터를 제공할 수 있습니다.

Request Syntax

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

{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}

URI 요청 파라미터

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

요청 본문

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

filters

결과를 제한하기 위한 선택적 필터입니다.

지원되는 필터 키는 status 및 fleetName 입니다. 필터링할 때는 필터링된 항목의 전체 값을 사용해야 합니다. 필터는 최대 3개까지 사용할 수 있지만, 이름이 동일한 항목에 대한 필어여야 합니다. 예를 들어, 상태 Registered 또는 상태 Available가 있는 항목을 검색하는 경우가 있습니다.

유형: Filter객체 어레이

배열 멤버: 고정된 항목 수는 1개입니다.

필수 여부: 아니요

maxResults

이 파라미터를 사용하면 ListRobots은 maxResults 응답 요소와 함께 단일 페이지에서 nextToken 결과만 반환합니다. 반환된 ListRobots 값과 함께 다른 nextToken 요청을 보내면 초기 요청의 나머지 결과를 확인할 수 있습니다. 이 값은 1~200이어야 합니다. 이 파라미터를 사용하지 않는 경우 ListRobots는 최대 200개의 결과와 해당하는 경우 nextToken 값을 반환합니다.

유형: 정수

필수 항목 여부: 아니요

nextToken

이전 페이지 매김 요청에서 나머지 결과를 모두 반환하지 않은 경우, 응답 객체의 nextToken 파라미터 값이 토큰으로 설정됩니다. 다음 결과 세트를 검색하려면 ListRobots를 다시 호출하여 해당 토큰을 요청 객체의 nextToken 파라미터에 할당합니다. 남은 결과가 없는 경우 이전 응답 개체의 NextToken 파라미터는 null로 설정됩니다.

유형: 문자열

길이 제약: 최소 길이는 1. 최대 길이는 2,048.

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

필수 여부: 아니요

응답 구문

HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "robots": [ 
      { 
         "architecture": "string",
         "arn": "string",
         "createdAt": number,
         "fleetArn": "string",
         "greenGrassGroupId": "string",
         "lastDeploymentJob": "string",
         "lastDeploymentTime": number,
         "name": "string",
         "status": "string"
      }
   ]
}

응답 요소

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

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

nextToken

이전 페이지 매김 요청에서 나머지 결과를 모두 반환하지 않은 경우, 응답 객체의 nextToken 파라미터 값이 토큰으로 설정됩니다. 다음 결과 세트를 검색하려면 ListRobots를 다시 호출하여 해당 토큰을 요청 객체의 nextToken 파라미터에 할당합니다. 남은 결과가 없는 경우 이전 응답 개체의 NextToken 매개 변수는 null로 설정됩니다.

유형: 문자열

길이 제약: 최소 길이는 1. 최대 길이는 2,048.

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

robots

요청 기준을 충족하는 로봇 목록입니다.

유형: Robot객체 어레이

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

Errors

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

InternalServerException

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

HTTP 상태 코드: 500

InvalidParameterException

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

HTTP 상태 코드: 400

ResourceNotFoundException

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

HTTP 상태 코드: 400

ThrottlingException

RoboMaker AWS는 일시적으로 요청을 처리할 수 없습니다. 호출을 다시 시도하세요.

HTTP 상태 코드: 400

참고

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