aws-sdk
Version:
AWS SDK for JavaScript
2,083 lines (2,082 loc) • 194 kB
JSON
{
"version": "2.0",
"metadata": {
"apiVersion": "2020-08-07",
"endpointPrefix": "models-v2-lex",
"jsonVersion": "1.1",
"protocol": "rest-json",
"protocols": [
"rest-json"
],
"serviceAbbreviation": "Lex Models V2",
"serviceFullName": "Amazon Lex Model Building V2",
"serviceId": "Lex Models V2",
"signatureVersion": "v4",
"signingName": "lex",
"uid": "models.lex.v2-2020-08-07",
"auth": [
"aws.auth#sigv4"
]
},
"operations": {
"BatchCreateCustomVocabularyItem": {
"http": {
"method": "PUT",
"requestUri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/batchcreate",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"botId",
"botVersion",
"localeId",
"customVocabularyItemList"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"localeId": {
"location": "uri",
"locationName": "localeId"
},
"customVocabularyItemList": {
"type": "list",
"member": {
"type": "structure",
"required": [
"phrase"
],
"members": {
"phrase": {},
"weight": {
"type": "integer"
},
"displayAs": {}
}
}
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"botVersion": {},
"localeId": {},
"errors": {
"shape": "Sa"
},
"resources": {
"shape": "Sf"
}
}
}
},
"BatchDeleteCustomVocabularyItem": {
"http": {
"requestUri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/batchdelete",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"botId",
"botVersion",
"localeId",
"customVocabularyItemList"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"localeId": {
"location": "uri",
"locationName": "localeId"
},
"customVocabularyItemList": {
"type": "list",
"member": {
"type": "structure",
"required": [
"itemId"
],
"members": {
"itemId": {}
}
}
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"botVersion": {},
"localeId": {},
"errors": {
"shape": "Sa"
},
"resources": {
"shape": "Sf"
}
}
}
},
"BatchUpdateCustomVocabularyItem": {
"http": {
"method": "PUT",
"requestUri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/batchupdate",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"botId",
"botVersion",
"localeId",
"customVocabularyItemList"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"localeId": {
"location": "uri",
"locationName": "localeId"
},
"customVocabularyItemList": {
"type": "list",
"member": {
"shape": "Sg"
}
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"botVersion": {},
"localeId": {},
"errors": {
"shape": "Sa"
},
"resources": {
"shape": "Sf"
}
}
}
},
"BuildBotLocale": {
"http": {
"requestUri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"botId",
"botVersion",
"localeId"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"localeId": {
"location": "uri",
"locationName": "localeId"
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"botVersion": {},
"localeId": {},
"botLocaleStatus": {},
"lastBuildSubmittedDateTime": {
"type": "timestamp"
}
}
}
},
"CreateBot": {
"http": {
"method": "PUT",
"requestUri": "/bots/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"botName",
"roleArn",
"dataPrivacy",
"idleSessionTTLInSeconds"
],
"members": {
"botName": {},
"description": {},
"roleArn": {},
"dataPrivacy": {
"shape": "Sx"
},
"idleSessionTTLInSeconds": {
"type": "integer"
},
"botTags": {
"shape": "S10"
},
"testBotAliasTags": {
"shape": "S10"
},
"botType": {},
"botMembers": {
"shape": "S14"
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"botName": {},
"description": {},
"roleArn": {},
"dataPrivacy": {
"shape": "Sx"
},
"idleSessionTTLInSeconds": {
"type": "integer"
},
"botStatus": {},
"creationDateTime": {
"type": "timestamp"
},
"botTags": {
"shape": "S10"
},
"testBotAliasTags": {
"shape": "S10"
},
"botType": {},
"botMembers": {
"shape": "S14"
}
}
}
},
"CreateBotAlias": {
"http": {
"method": "PUT",
"requestUri": "/bots/{botId}/botaliases/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"botAliasName",
"botId"
],
"members": {
"botAliasName": {},
"description": {},
"botVersion": {},
"botAliasLocaleSettings": {
"shape": "S1c"
},
"conversationLogSettings": {
"shape": "S1j"
},
"sentimentAnalysisSettings": {
"shape": "S1x"
},
"botId": {
"location": "uri",
"locationName": "botId"
},
"tags": {
"shape": "S10"
}
}
},
"output": {
"type": "structure",
"members": {
"botAliasId": {},
"botAliasName": {},
"description": {},
"botVersion": {},
"botAliasLocaleSettings": {
"shape": "S1c"
},
"conversationLogSettings": {
"shape": "S1j"
},
"sentimentAnalysisSettings": {
"shape": "S1x"
},
"botAliasStatus": {},
"botId": {},
"creationDateTime": {
"type": "timestamp"
},
"tags": {
"shape": "S10"
}
}
}
},
"CreateBotLocale": {
"http": {
"method": "PUT",
"requestUri": "/bots/{botId}/botversions/{botVersion}/botlocales/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"botId",
"botVersion",
"localeId",
"nluIntentConfidenceThreshold"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"localeId": {},
"description": {},
"nluIntentConfidenceThreshold": {
"type": "double"
},
"voiceSettings": {
"shape": "S22"
},
"generativeAISettings": {
"shape": "S25"
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"botVersion": {},
"localeName": {},
"localeId": {},
"description": {},
"nluIntentConfidenceThreshold": {
"type": "double"
},
"voiceSettings": {
"shape": "S22"
},
"botLocaleStatus": {},
"creationDateTime": {
"type": "timestamp"
},
"generativeAISettings": {
"shape": "S25"
}
}
}
},
"CreateBotReplica": {
"http": {
"method": "PUT",
"requestUri": "/bots/{botId}/replicas/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"botId",
"replicaRegion"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"replicaRegion": {}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"replicaRegion": {},
"sourceRegion": {},
"creationDateTime": {
"type": "timestamp"
},
"botReplicaStatus": {}
}
}
},
"CreateBotVersion": {
"http": {
"method": "PUT",
"requestUri": "/bots/{botId}/botversions/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"botId",
"botVersionLocaleSpecification"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"description": {},
"botVersionLocaleSpecification": {
"shape": "S2q"
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"description": {},
"botVersion": {},
"botVersionLocaleSpecification": {
"shape": "S2q"
},
"botStatus": {},
"creationDateTime": {
"type": "timestamp"
}
}
}
},
"CreateExport": {
"http": {
"method": "PUT",
"requestUri": "/exports/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"resourceSpecification",
"fileFormat"
],
"members": {
"resourceSpecification": {
"shape": "S2u"
},
"fileFormat": {},
"filePassword": {
"shape": "S30"
}
}
},
"output": {
"type": "structure",
"members": {
"exportId": {},
"resourceSpecification": {
"shape": "S2u"
},
"fileFormat": {},
"exportStatus": {},
"creationDateTime": {
"type": "timestamp"
}
}
}
},
"CreateIntent": {
"http": {
"method": "PUT",
"requestUri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"intentName",
"botId",
"botVersion",
"localeId"
],
"members": {
"intentName": {},
"description": {},
"parentIntentSignature": {},
"sampleUtterances": {
"shape": "S35"
},
"dialogCodeHook": {
"shape": "S38"
},
"fulfillmentCodeHook": {
"shape": "S39"
},
"intentConfirmationSetting": {
"shape": "S4h"
},
"intentClosingSetting": {
"shape": "S4z"
},
"inputContexts": {
"shape": "S50"
},
"outputContexts": {
"shape": "S52"
},
"kendraConfiguration": {
"shape": "S56"
},
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"localeId": {
"location": "uri",
"locationName": "localeId"
},
"initialResponseSetting": {
"shape": "S59"
},
"qnAIntentConfiguration": {
"shape": "S5a"
}
}
},
"output": {
"type": "structure",
"members": {
"intentId": {},
"intentName": {},
"description": {},
"parentIntentSignature": {},
"sampleUtterances": {
"shape": "S35"
},
"dialogCodeHook": {
"shape": "S38"
},
"fulfillmentCodeHook": {
"shape": "S39"
},
"intentConfirmationSetting": {
"shape": "S4h"
},
"intentClosingSetting": {
"shape": "S4z"
},
"inputContexts": {
"shape": "S50"
},
"outputContexts": {
"shape": "S52"
},
"kendraConfiguration": {
"shape": "S56"
},
"botId": {},
"botVersion": {},
"localeId": {},
"creationDateTime": {
"type": "timestamp"
},
"initialResponseSetting": {
"shape": "S59"
},
"qnAIntentConfiguration": {
"shape": "S5a"
}
}
}
},
"CreateResourcePolicy": {
"http": {
"requestUri": "/policy/{resourceArn}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"resourceArn",
"policy"
],
"members": {
"resourceArn": {
"location": "uri",
"locationName": "resourceArn"
},
"policy": {}
}
},
"output": {
"type": "structure",
"members": {
"resourceArn": {},
"revisionId": {}
}
}
},
"CreateResourcePolicyStatement": {
"http": {
"requestUri": "/policy/{resourceArn}/statements/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"resourceArn",
"statementId",
"effect",
"principal",
"action"
],
"members": {
"resourceArn": {
"location": "uri",
"locationName": "resourceArn"
},
"statementId": {},
"effect": {},
"principal": {
"type": "list",
"member": {
"type": "structure",
"members": {
"service": {},
"arn": {}
}
}
},
"action": {
"type": "list",
"member": {}
},
"condition": {
"type": "map",
"key": {},
"value": {
"type": "map",
"key": {},
"value": {}
}
},
"expectedRevisionId": {
"location": "querystring",
"locationName": "expectedRevisionId"
}
}
},
"output": {
"type": "structure",
"members": {
"resourceArn": {},
"revisionId": {}
}
}
},
"CreateSlot": {
"http": {
"method": "PUT",
"requestUri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"slotName",
"valueElicitationSetting",
"botId",
"botVersion",
"localeId",
"intentId"
],
"members": {
"slotName": {},
"description": {},
"slotTypeId": {},
"valueElicitationSetting": {
"shape": "S6a"
},
"obfuscationSetting": {
"shape": "S6n"
},
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"localeId": {
"location": "uri",
"locationName": "localeId"
},
"intentId": {
"location": "uri",
"locationName": "intentId"
},
"multipleValuesSetting": {
"shape": "S6p"
},
"subSlotSetting": {
"shape": "S6q"
}
}
},
"output": {
"type": "structure",
"members": {
"slotId": {},
"slotName": {},
"description": {},
"slotTypeId": {},
"valueElicitationSetting": {
"shape": "S6a"
},
"obfuscationSetting": {
"shape": "S6n"
},
"botId": {},
"botVersion": {},
"localeId": {},
"intentId": {},
"creationDateTime": {
"type": "timestamp"
},
"multipleValuesSetting": {
"shape": "S6p"
},
"subSlotSetting": {
"shape": "S6q"
}
}
}
},
"CreateSlotType": {
"http": {
"method": "PUT",
"requestUri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"slotTypeName",
"botId",
"botVersion",
"localeId"
],
"members": {
"slotTypeName": {},
"description": {},
"slotTypeValues": {
"shape": "S6x"
},
"valueSelectionSetting": {
"shape": "S72"
},
"parentSlotTypeSignature": {},
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"localeId": {
"location": "uri",
"locationName": "localeId"
},
"externalSourceSetting": {
"shape": "S79"
},
"compositeSlotTypeSetting": {
"shape": "S7e"
}
}
},
"output": {
"type": "structure",
"members": {
"slotTypeId": {},
"slotTypeName": {},
"description": {},
"slotTypeValues": {
"shape": "S6x"
},
"valueSelectionSetting": {
"shape": "S72"
},
"parentSlotTypeSignature": {},
"botId": {},
"botVersion": {},
"localeId": {},
"creationDateTime": {
"type": "timestamp"
},
"externalSourceSetting": {
"shape": "S79"
},
"compositeSlotTypeSetting": {
"shape": "S7e"
}
}
}
},
"CreateTestSetDiscrepancyReport": {
"http": {
"requestUri": "/testsets/{testSetId}/testsetdiscrepancy",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"testSetId",
"target"
],
"members": {
"testSetId": {
"location": "uri",
"locationName": "testSetId"
},
"target": {
"shape": "S7j"
}
}
},
"output": {
"type": "structure",
"members": {
"testSetDiscrepancyReportId": {},
"creationDateTime": {
"type": "timestamp"
},
"testSetId": {},
"target": {
"shape": "S7j"
}
}
}
},
"CreateUploadUrl": {
"http": {
"requestUri": "/createuploadurl/",
"responseCode": 200
},
"input": {
"type": "structure",
"members": {}
},
"output": {
"type": "structure",
"members": {
"importId": {},
"uploadUrl": {}
}
}
},
"DeleteBot": {
"http": {
"method": "DELETE",
"requestUri": "/bots/{botId}/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"botId"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"skipResourceInUseCheck": {
"location": "querystring",
"locationName": "skipResourceInUseCheck",
"type": "boolean"
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"botStatus": {}
}
}
},
"DeleteBotAlias": {
"http": {
"method": "DELETE",
"requestUri": "/bots/{botId}/botaliases/{botAliasId}/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"botAliasId",
"botId"
],
"members": {
"botAliasId": {
"location": "uri",
"locationName": "botAliasId"
},
"botId": {
"location": "uri",
"locationName": "botId"
},
"skipResourceInUseCheck": {
"location": "querystring",
"locationName": "skipResourceInUseCheck",
"type": "boolean"
}
}
},
"output": {
"type": "structure",
"members": {
"botAliasId": {},
"botId": {},
"botAliasStatus": {}
}
}
},
"DeleteBotLocale": {
"http": {
"method": "DELETE",
"requestUri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"botId",
"botVersion",
"localeId"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"localeId": {
"location": "uri",
"locationName": "localeId"
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"botVersion": {},
"localeId": {},
"botLocaleStatus": {}
}
}
},
"DeleteBotReplica": {
"http": {
"method": "DELETE",
"requestUri": "/bots/{botId}/replicas/{replicaRegion}/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"botId",
"replicaRegion"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"replicaRegion": {
"location": "uri",
"locationName": "replicaRegion"
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"replicaRegion": {},
"botReplicaStatus": {}
}
}
},
"DeleteBotVersion": {
"http": {
"method": "DELETE",
"requestUri": "/bots/{botId}/botversions/{botVersion}/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"botId",
"botVersion"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"skipResourceInUseCheck": {
"location": "querystring",
"locationName": "skipResourceInUseCheck",
"type": "boolean"
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"botVersion": {},
"botStatus": {}
}
}
},
"DeleteCustomVocabulary": {
"http": {
"method": "DELETE",
"requestUri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"botId",
"botVersion",
"localeId"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"localeId": {
"location": "uri",
"locationName": "localeId"
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"botVersion": {},
"localeId": {},
"customVocabularyStatus": {}
}
}
},
"DeleteExport": {
"http": {
"method": "DELETE",
"requestUri": "/exports/{exportId}/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"exportId"
],
"members": {
"exportId": {
"location": "uri",
"locationName": "exportId"
}
}
},
"output": {
"type": "structure",
"members": {
"exportId": {},
"exportStatus": {}
}
}
},
"DeleteImport": {
"http": {
"method": "DELETE",
"requestUri": "/imports/{importId}/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"importId"
],
"members": {
"importId": {
"location": "uri",
"locationName": "importId"
}
}
},
"output": {
"type": "structure",
"members": {
"importId": {},
"importStatus": {}
}
}
},
"DeleteIntent": {
"http": {
"method": "DELETE",
"requestUri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"intentId",
"botId",
"botVersion",
"localeId"
],
"members": {
"intentId": {
"location": "uri",
"locationName": "intentId"
},
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"localeId": {
"location": "uri",
"locationName": "localeId"
}
}
}
},
"DeleteResourcePolicy": {
"http": {
"method": "DELETE",
"requestUri": "/policy/{resourceArn}/",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"resourceArn"
],
"members": {
"resourceArn": {
"location": "uri",
"locationName": "resourceArn"
},
"expectedRevisionId": {
"location": "querystring",
"locationName": "expectedRevisionId"
}
}
},
"output": {
"type": "structure",
"members": {
"resourceArn": {},
"revisionId": {}
}
}
},
"DeleteResourcePolicyStatement": {
"http": {
"method": "DELETE",
"requestUri": "/policy/{resourceArn}/statements/{statementId}/",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"resourceArn",
"statementId"
],
"members": {
"resourceArn": {
"location": "uri",
"locationName": "resourceArn"
},
"statementId": {
"location": "uri",
"locationName": "statementId"
},
"expectedRevisionId": {
"location": "querystring",
"locationName": "expectedRevisionId"
}
}
},
"output": {
"type": "structure",
"members": {
"resourceArn": {},
"revisionId": {}
}
}
},
"DeleteSlot": {
"http": {
"method": "DELETE",
"requestUri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots/{slotId}/",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"slotId",
"botId",
"botVersion",
"localeId",
"intentId"
],
"members": {
"slotId": {
"location": "uri",
"locationName": "slotId"
},
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"localeId": {
"location": "uri",
"locationName": "localeId"
},
"intentId": {
"location": "uri",
"locationName": "intentId"
}
}
}
},
"DeleteSlotType": {
"http": {
"method": "DELETE",
"requestUri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/{slotTypeId}/",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"slotTypeId",
"botId",
"botVersion",
"localeId"
],
"members": {
"slotTypeId": {
"location": "uri",
"locationName": "slotTypeId"
},
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"localeId": {
"location": "uri",
"locationName": "localeId"
},
"skipResourceInUseCheck": {
"location": "querystring",
"locationName": "skipResourceInUseCheck",
"type": "boolean"
}
}
}
},
"DeleteTestSet": {
"http": {
"method": "DELETE",
"requestUri": "/testsets/{testSetId}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"testSetId"
],
"members": {
"testSetId": {
"location": "uri",
"locationName": "testSetId"
}
}
},
"idempotent": true
},
"DeleteUtterances": {
"http": {
"method": "DELETE",
"requestUri": "/bots/{botId}/utterances/",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"botId"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"localeId": {
"location": "querystring",
"locationName": "localeId"
},
"sessionId": {
"location": "querystring",
"locationName": "sessionId"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DescribeBot": {
"http": {
"method": "GET",
"requestUri": "/bots/{botId}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"botId"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"botName": {},
"description": {},
"roleArn": {},
"dataPrivacy": {
"shape": "Sx"
},
"idleSessionTTLInSeconds": {
"type": "integer"
},
"botStatus": {},
"creationDateTime": {
"type": "timestamp"
},
"lastUpdatedDateTime": {
"type": "timestamp"
},
"botType": {},
"botMembers": {
"shape": "S14"
},
"failureReasons": {
"shape": "S8l"
}
}
}
},
"DescribeBotAlias": {
"http": {
"method": "GET",
"requestUri": "/bots/{botId}/botaliases/{botAliasId}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"botAliasId",
"botId"
],
"members": {
"botAliasId": {
"location": "uri",
"locationName": "botAliasId"
},
"botId": {
"location": "uri",
"locationName": "botId"
}
}
},
"output": {
"type": "structure",
"members": {
"botAliasId": {},
"botAliasName": {},
"description": {},
"botVersion": {},
"botAliasLocaleSettings": {
"shape": "S1c"
},
"conversationLogSettings": {
"shape": "S1j"
},
"sentimentAnalysisSettings": {
"shape": "S1x"
},
"botAliasHistoryEvents": {
"type": "list",
"member": {
"type": "structure",
"members": {
"botVersion": {},
"startDate": {
"type": "timestamp"
},
"endDate": {
"type": "timestamp"
}
}
}
},
"botAliasStatus": {},
"botId": {},
"creationDateTime": {
"type": "timestamp"
},
"lastUpdatedDateTime": {
"type": "timestamp"
},
"parentBotNetworks": {
"shape": "S8r"
}
}
}
},
"DescribeBotLocale": {
"http": {
"method": "GET",
"requestUri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"botId",
"botVersion",
"localeId"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"localeId": {
"location": "uri",
"locationName": "localeId"
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"botVersion": {},
"localeId": {},
"localeName": {},
"description": {},
"nluIntentConfidenceThreshold": {
"type": "double"
},
"voiceSettings": {
"shape": "S22"
},
"intentsCount": {
"type": "integer"
},
"slotTypesCount": {
"type": "integer"
},
"botLocaleStatus": {},
"failureReasons": {
"shape": "S8l"
},
"creationDateTime": {
"type": "timestamp"
},
"lastUpdatedDateTime": {
"type": "timestamp"
},
"lastBuildSubmittedDateTime": {
"type": "timestamp"
},
"botLocaleHistoryEvents": {
"type": "list",
"member": {
"type": "structure",
"required": [
"event",
"eventDate"
],
"members": {
"event": {},
"eventDate": {
"type": "timestamp"
}
}
}
},
"recommendedActions": {
"shape": "S8z"
},
"generativeAISettings": {
"shape": "S25"
}
}
}
},
"DescribeBotRecommendation": {
"http": {
"method": "GET",
"requestUri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"botId",
"botVersion",
"localeId",
"botRecommendationId"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"localeId": {
"location": "uri",
"locationName": "localeId"
},
"botRecommendationId": {
"location": "uri",
"locationName": "botRecommendationId"
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"botVersion": {},
"localeId": {},
"botRecommendationStatus": {},
"botRecommendationId": {},
"failureReasons": {
"shape": "S8l"
},
"creationDateTime": {
"type": "timestamp"
},
"lastUpdatedDateTime": {
"type": "timestamp"
},
"transcriptSourceSetting": {
"shape": "S94"
},
"encryptionSetting": {
"shape": "S9d"
},
"botRecommendationResults": {
"type": "structure",
"members": {
"botLocaleExportUrl": {},
"associatedTranscriptsUrl": {},
"statistics": {
"type": "structure",
"members": {
"intents": {
"type": "structure",
"members": {
"discoveredIntentCount": {
"type": "integer"
}
}
},
"slotTypes": {
"type": "structure",
"members": {
"discoveredSlotTypeCount": {
"type": "integer"
}
}
}
}
}
}
}
}
}
},
"DescribeBotReplica": {
"http": {
"method": "GET",
"requestUri": "/bots/{botId}/replicas/{replicaRegion}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"botId",
"replicaRegion"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"replicaRegion": {
"location": "uri",
"locationName": "replicaRegion"
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"replicaRegion": {},
"sourceRegion": {},
"creationDateTime": {
"type": "timestamp"
},
"botReplicaStatus": {},
"failureReasons": {
"shape": "S8l"
}
}
}
},
"DescribeBotResourceGeneration": {
"http": {
"method": "GET",
"requestUri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/generations/{generationId}",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"botId",
"botVersion",
"localeId",
"generationId"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"localeId": {
"location": "uri",
"locationName": "localeId"
},
"generationId": {
"location": "uri",
"locationName": "generationId"
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"botVersion": {},
"localeId": {},
"generationId": {},
"failureReasons": {
"shape": "S8l"
},
"generationStatus": {},
"generationInputPrompt": {},
"generatedBotLocaleUrl": {},
"creationDateTime": {
"type": "timestamp"
},
"modelArn": {},
"lastUpdatedDateTime": {
"type": "timestamp"
}
}
}
},
"DescribeBotVersion": {
"http": {
"method": "GET",
"requestUri": "/bots/{botId}/botversions/{botVersion}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"botId",
"botVersion"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"botName": {},
"botVersion": {},
"description": {},
"roleArn": {},
"dataPrivacy": {
"shape": "Sx"
},
"idleSessionTTLInSeconds": {
"type": "integer"
},
"botStatus": {},
"failureReasons": {
"shape": "S8l"
},
"creationDateTime": {
"type": "timestamp"
},
"parentBotNetworks": {
"shape": "S8r"
},
"botType": {},
"botMembers": {
"shape": "S14"
}
}
}
},
"DescribeCustomVocabularyMetadata": {
"http": {
"method": "GET",
"requestUri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/metadata",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"botId",
"botVersion",
"localeId"
],
"members": {
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"localeId": {
"location": "uri",
"locationName": "localeId"
}
}
},
"output": {
"type": "structure",
"members": {
"botId": {},
"botVersion": {},
"localeId": {},
"customVocabularyStatus": {},
"creationDateTime": {
"type": "timestamp"
},
"lastUpdatedDateTime": {
"type": "timestamp"
}
}
}
},
"DescribeExport": {
"http": {
"method": "GET",
"requestUri": "/exports/{exportId}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"exportId"
],
"members": {
"exportId": {
"location": "uri",
"locationName": "exportId"
}
}
},
"output": {
"type": "structure",
"members": {
"exportId": {},
"resourceSpecification": {
"shape": "S2u"
},
"fileFormat": {},
"exportStatus": {},
"failureReasons": {
"shape": "S8l"
},
"downloadUrl": {},
"creationDateTime": {
"type": "timestamp"
},
"lastUpdatedDateTime": {
"type": "timestamp"
}
}
}
},
"DescribeImport": {
"http": {
"method": "GET",
"requestUri": "/imports/{importId}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"importId"
],
"members": {
"importId": {
"location": "uri",
"locationName": "importId"
}
}
},
"output": {
"type": "structure",
"members": {
"importId": {},
"resourceSpecification": {
"shape": "S9y"
},
"importedResourceId": {},
"importedResourceName": {},
"mergeStrategy": {},
"importStatus": {},
"failureReasons": {
"shape": "S8l"
},
"creationDateTime": {
"type": "timestamp"
},
"lastUpdatedDateTime": {
"type": "timestamp"
}
}
}
},
"DescribeIntent": {
"http": {
"method": "GET",
"requestUri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"intentId",
"botId",
"botVersion",
"localeId"
],
"members": {
"intentId": {
"location": "uri",
"locationName": "intentId"
},
"botId": {
"location": "uri",
"locationName": "botId"
},
"botVersion": {
"location": "uri",
"locationName": "botVersion"
},
"localeId": {
"location": "uri",
"locationName": "localeId"
}
}
},
"output": {
"type": "structure",
"members": {
"intentId": {},
"intentName": {},
"description": {},
"parentIntentSignature": {},
"sampleUtterances": {
"shape": "S35"
},
"dialogCodeHook": {
"shape": "S38"
},
"fulfillmentCodeHook": {
"shape": "S39"
},
"slotPriorities": {
"shape": "Saa"
},
"intentConfirmationSetting": {
"shape": "S4h"
},
"intentClosingSetting": {
"shape": "S4z"
},
"inputContexts": {
"shape": "S50"
},
"outputContexts": {
"shape": "S52"
},
"kendraConfiguration": {
"shape": "S56"
},
"botId": {},
"botVersion": {},
"localeId": {},
"creationDateTime": {
"type": "timestamp"
},
"lastUpdatedDateTime": {
"type": "timestamp"
},
"initialResponseSetting": {
"shape": "S59"
},
"qnAIntentConfiguration": {
"shape": "S5a"
}
}
}
},
"DescribeResourcePolicy": {
"http": {
"method": "GET",
"requestUri": "/policy/{resourceArn}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"resourceArn"
],
"members": {
"resourceArn": {
"location": "uri",
"locationName": "resourceArn"
}
}
},
"output": {
"type": "structure",
"members": {
"resourceArn": {},
"policy": {},