ListBots - Amazon Lex
요청 구문URI 요청 파라미터요청 본문응답 구문응답 요소오류참고 항목

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

ListBots

사용 가능한 봇 목록을 가져옵니다.

요청 구문

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

{
   "filters": [ 
      { 
         "name": "string",
         "operator": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "sortBy": { 
      "attribute": "string",
      "order": "string"
   }
}

URI 요청 파라미터

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

요청 본문

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

filters

응답에서 봇을 필터 사양과 일치하는 봇으로만 제한하는 데 사용되는 필터의 사양을 제공합니다. 필터링할 필터와 문자열 하나만 지정할 수 있습니다.

Type: 배열BotFilter사물

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

: 필수 아니요

maxResults

결과의 각 페이지에서 반환할 최대 봇 수입니다. 최대 페이지 크기보다 결과가 적으면 실제 결과 수만 반환됩니다.

Type: 정수

유효한 범위: 최소값 1. 최대값 1000입니다.

: 필수 아니요

nextToken

에서 응답하는 경우ListBots작업에 지정된 것보다 많은 결과가 포함되어 있습니다.maxResultsParameter를 사용하면 응답에서 토큰이 반환됩니다.

반환된 토큰 사용nextTokena 파라미터ListBots결과의 다음 페이지 반환을 요청합니다. 전체 결과 집합을 보려면 다음을 호출하십시오.ListBots까지 가동nextToken응답에서 반환은 null입니다.

Type: 문자열

: 필수 아니요

sortBy

봇 목록의 정렬 파라미터를 지정합니다. 목록을 봇 이름별로 정렬하거나 오름차순 또는 내림차순으로 정렬하도록 지정할 수 있습니다.

유형: BotSortBy 객체

: 필수 아니요

응답 구문

HTTP/1.1 200
Content-type: application/json

{
   "botSummaries": [ 
      { 
         "botId": "string",
         "botName": "string",
         "botStatus": "string",
         "description": "string",
         "lastUpdatedDateTime": number,
         "latestBotVersion": "string"
      }
   ],
   "nextToken": "string"
}

응답 요소

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

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

botSummaries

요청에 지정된 필터 기준을 충족하는 봇에 대한 요약 정보입니다. 목록의 길이는maxResults요청의 매개 변수입니다. 사용 가능한 봇이 더 많은 경우nextToken필드에는 결과의 다음 페이지로 연결되는 토큰이 포함되어 있습니다.

Type: 배열BotSummary사물

nextToken

에 대한 응답으로 반환할 결과가 더 있는지 여부를 나타내는 토큰ListBots작업. 만약nextToken필드가 있으면 내용을 다음과 같이 보냅니다.nextTokena 파라미터ListBots결과의 다음 페이지를 가져오는 작업 요청입니다.

Type: 문자열

오류

모든 작업에 공통적인 오류에 대한 자세한 내용은 단원을 참조하십시오.일반적인 오류.

InternalServerException

서비스에 예상치 못한 조건이 발생했습니다. 요청을 다시 시도하십시오.

HTTP 상태 코드: 500

ServiceQuotaExceededException

봇에 대한 할당량에 도달했습니다.

HTTP 상태 코드: 402

ThrottlingException

요청량이 너무 높습니다. 요청 횟수를 줄입니다.

HTTP 상태 코드: 429

ValidationException

요청의 입력 파라미터 중 하나가 잘못되었습니다. 파라미터를 확인하고 요청을 다시 시도하십시오.

HTTP 상태 코드: 400

참고 항목

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