DescribeBot - Amazon Lex

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

DescribeBot

봇에 대한 메타데이터 정보를 제공합니다.

요청 구문

GET /bots/botId/ HTTP/1.1

URI 요청 파라미터

요청은 다음의 URI 파라미터를 사용합니다.

botId

설명할 봇의 고유한 식별자입니다.

길이 제약 조건: 고정 길이 10입니다.

Pattern: ^[0-9a-zA-Z]+$

: 필수 사항 예

요청 본문

요청에 요청 본문이 없습니다.

응답 구문

HTTP/1.1 200 Content-type: application/json { "botId": "string", "botName": "string", "botStatus": "string", "creationDateTime": number, "dataPrivacy": { "childDirected": boolean }, "description": "string", "idleSessionTTLInSeconds": number, "lastUpdatedDateTime": number, "roleArn": "string" }

응답 요소

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

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

botId

봇의 고유한 식별자입니다.

Type: 문자열

길이 제약 조건: 고정 길이 10입니다.

Pattern: ^[0-9a-zA-Z]+$

botName

봇의 이름

Type: 문자열

길이 제약 조건: 최소 길이는 1이고, 최대 길이는 100입니다.

Pattern: ^([0-9a-zA-Z][_-]?)+$

botStatus

봇의 현재 상태. 상태가 다음과 같을 때Available봇은 사용자와의 대화에 사용할 준비가 되었습니다.

Type: 문자열

유효한 값: Creating | Available | Inactive | Deleting | Failed | Versioning | Importing

creationDateTime

봇이 생성된 날짜와 시간의 타임스탬프입니다.

Type: 타임스탬프

dataPrivacy

봇의 데이터 개인 정보 보호 및 사용자와의 대화를 관리하기 위한 설정입니다.

유형: DataPrivacy 객체

description

봇에 대한 설명입니다.

Type: 문자열

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

idleSessionTTLInSeconds

Amazon Lex가 대화에서 수집된 데이터를 보관하는 최대 시간 (초) 입니다.

Type: 정수

유효한 범위: 최소값은 60입니다. 최대값은 86400입니다.

lastUpdatedDateTime

봇이 마지막으로 업데이트된 날짜와 시간의 타임스탬프입니다.

Type: 타임스탬프

roleArn

봇에 액세스할 수 있는 권한을 가진 IAM 역할의 Amazon 리소스 이름 (ARN) 입니다.

Type: 문자열

길이 제약 조건: 최소 길이는 32이고, 최대 길이 2048.

Pattern: ^arn:aws:iam::[0-9]{12}:role/.*$

오류

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

InternalServerException

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

HTTP 상태 코드: 500

ResourceNotFoundException

사용자가 존재하지 않는 리소스를 설명하도록 요청했습니다. 요청하는 리소스를 확인하고 다시 시도하십시오.

HTTP 상태 코드: 404

ServiceQuotaExceededException

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

HTTP 상태 코드: 402

ThrottlingException

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

HTTP 상태 코드: 429

ValidationException

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

HTTP 상태 코드: 400

참고 항목

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