DescribeSlot - Amazon Lex

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

DescribeSlot

슬롯에 대한 메타데이터 정보를 가져옵니다.

요청 구문

GET /bots/botId/botversions/botVersion/botlocales/localeId/intents/intentId/slots/slotId/ HTTP/1.1

URI 요청 파라미터

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

botId

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

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

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

: 필수 예

botVersion

슬롯과 연결된 봇의 버전입니다.

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

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

: 필수 예

intentId

슬롯을 포함하는 인텐트의 식별자입니다.

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

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

: 필수 예

localeId

설명할 슬롯의 언어 및 로케일의 식별자입니다. 문자열은 지원되는 로케일 중 하나와 일치해야 합니다. 자세한 내용은 단원을 참조하십시오.지원되는 언어.

: 필수 예

slotId

슬롯의 고유 식별자입니다.

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

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

: 필수 예

요청 본문

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

응답 구문

HTTP/1.1 200 Content-type: application/json { "botId": "string", "botVersion": "string", "creationDateTime": number, "description": "string", "intentId": "string", "lastUpdatedDateTime": number, "localeId": "string", "multipleValuesSetting": { "allowMultipleValues": boolean }, "obfuscationSetting": { "obfuscationSettingType": "string" }, "slotId": "string", "slotName": "string", "slotTypeId": "string", "valueElicitationSetting": { "defaultValueSpecification": { "defaultValueList": [ { "defaultValue": "string" } ] }, "promptSpecification": { "allowInterrupt": boolean, "maxRetries": number, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "sampleUtterances": [ { "utterance": "string" } ], "slotConstraint": "string", "waitAndContinueSpecification": { "active": boolean, "continueResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "stillWaitingResponse": { "allowInterrupt": boolean, "frequencyInSeconds": number, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ], "timeoutInSeconds": number }, "waitingResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } } }

응답 요소

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

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

botId

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

Type: 문자열

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

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

botVersion

슬롯과 연결된 봇의 버전입니다.

Type: 문자열

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

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

creationDateTime

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

Type: 타임스탬프

description

슬롯에 지정된 설명입니다.

Type: 문자열

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

intentId

슬롯과 연결된 인텐트의 식별자입니다.

Type: 문자열

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

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

lastUpdatedDateTime

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

Type: 타임스탬프

localeId

슬롯에 지정된 언어 및 로캘입니다.

Type: 문자열

multipleValuesSetting

슬롯이 단일 발언으로 여러 값을 허용하는지 여부를 나타냅니다.

만약multipleValuesSetting을 설정하지 않을 경우 기본값은 다음과 같습니다.false.

유형: MultipleValuesSetting 객체

obfuscationSetting

슬롯 값이 Amazon CloudWatch 로그에 표시되는지 여부입니다. 값이 다음과 같으면None슬롯의 실제 값이 로그에 표시됩니다.

유형: ObfuscationSetting 객체

slotId

슬롯에 대해 생성된 고유 식별자입니다.

Type: 문자열

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

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

slotName

슬롯에 지정된 이름입니다.

Type: 문자열

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

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

slotTypeId

슬롯에 입력된 값을 결정하는 슬롯 유형의 식별자입니다.

Type: 문자열

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

Pattern: ^((AMAZON\.)[a-zA-Z_]+?|[0-9a-zA-Z]+)$

valueElicitationSetting

Amazon Lex가 슬롯 값을 이끌어내기 위해 사용하는 메시지를 표시합니다.

유형: SlotValueElicitationSetting 객체

오류

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

InternalServerException

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

HTTP 상태 코드: 500

ResourceNotFoundException

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

HTTP 상태 코드: 404

ServiceQuotaExceededException

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

HTTP 상태 코드: 402

ThrottlingException

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

HTTP 상태 코드: 429

ValidationException

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

HTTP 상태 코드: 400

참고 항목

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