DescribeBotAlias - Amazon Lex

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

DescribeBotAlias

특정 봇 별칭에 대한 정보를 가져옵니다.

요청 구문

GET /bots/botId/botaliases/botAliasId/ HTTP/1.1

URI 요청 파라미터

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

botAliasId

설명할 봇 별칭의 식별자입니다.

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

Pattern: ^(\bTSTALIASID\b|[0-9a-zA-Z]+)$

: 필수 예

botId

설명할 봇 별칭과 연결된 봇의 식별자입니다.

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

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

: 필수 예

요청 본문

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

응답 구문

HTTP/1.1 200 Content-type: application/json { "botAliasHistoryEvents": [ { "botVersion": "string", "endDate": number, "startDate": number } ], "botAliasId": "string", "botAliasLocaleSettings": { "string" : { "codeHookSpecification": { "lambdaCodeHook": { "codeHookInterfaceVersion": "string", "lambdaARN": "string" } }, "enabled": boolean } }, "botAliasName": "string", "botAliasStatus": "string", "botId": "string", "botVersion": "string", "conversationLogSettings": { "audioLogSettings": [ { "destination": { "s3Bucket": { "kmsKeyArn": "string", "logPrefix": "string", "s3BucketArn": "string" } }, "enabled": boolean } ], "textLogSettings": [ { "destination": { "cloudWatch": { "cloudWatchLogGroupArn": "string", "logPrefix": "string" } }, "enabled": boolean } ] }, "creationDateTime": number, "description": "string", "lastUpdatedDateTime": number, "sentimentAnalysisSettings": { "detectSentiment": boolean } }

응답 요소

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

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

botAliasHistoryEvents

봇 별칭에 영향을 주는 이벤트 목록입니다. 예를 들어 별칭이 가리키는 버전이 변경될 때 이벤트가 기록됩니다.

Type: 배열BotAliasHistoryEvent사물

botAliasId

봇 별칭의 식별자입니다.

Type: 문자열

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

Pattern: ^(\bTSTALIASID\b|[0-9a-zA-Z]+)$

botAliasLocaleSettings

별칭에 고유한 로캘 설정입니다.

Type: 문자열:BotAliasLocaleSettings오브젝트 맵

맵 항목: 최대 항목 수입니다.

botAliasName

봇 별칭의 이름

Type: 문자열

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

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

botAliasStatus

별칭의 현재 상태입니다. 별칭이 다음과 같은 경우Available이 별칭을 봇과 함께 사용할 수 있습니다.

Type: 문자열

유효한 값: Creating | Available | Deleting | Failed

botId

봇 별칭과 연결된 봇의 식별자입니다.

Type: 문자열

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

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

botVersion

봇 별칭과 연결된 봇의 버전입니다.

Type: 문자열

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

Pattern: ^(DRAFT|[0-9]+)$

conversationLogSettings

Amazon Lex가 별칭과 연결된 봇과 텍스트 및 오디오 대화를 기록하는 방법에 대한 구체적인 내용입니다.

유형: ConversationLogSettings 객체

creationDateTime

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

Type: 타임스탬프

description

봇 별칭에 대한 설명입니다.

Type: 문자열

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

lastUpdatedDateTime

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

Type: 타임스탬프

sentimentAnalysisSettings

Amazon Lex가 Amazon Comprehend를 사용하여 사용자 발언의 감정을 감지할지 여부를 결정합니다.

유형: SentimentAnalysisSettings 객체

오류

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

InternalServerException

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

HTTP 상태 코드: 500

ResourceNotFoundException

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

HTTP 상태 코드: 404

ServiceQuotaExceededException

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

HTTP 상태 코드: 402

ThrottlingException

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

HTTP 상태 코드: 429

ValidationException

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

HTTP 상태 코드: 400

참고 항목

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