{ "version": "2.0", "metadata": { "apiVersion": "2017-04-19", "endpointPrefix": "models.lex", "jsonVersion": "1.1", "protocol": "rest-json", "serviceFullName": "Amazon Lex Model Building Service", "serviceId": "Lex Model Building Service", "signatureVersion": "v4", "signingName": "lex", "uid": "lex-models-2017-04-19" }, "operations": { "CreateBotVersion": { "http": { "requestUri": "/bots/{name}/versions", "responseCode": 201 }, "input": { "type": "structure", "required": [ "name" ], "members": { "name": { "location": "uri", "locationName": "name" }, "checksum": {} } }, "output": { "type": "structure", "members": { "name": {}, "description": {}, "intents": { "shape": "S6" }, "clarificationPrompt": { "shape": "Sa" }, "abortStatement": { "shape": "Si" }, "status": {}, "failureReason": {}, "lastUpdatedDate": { "type": "timestamp" }, "createdDate": { "type": "timestamp" }, "idleSessionTTLInSeconds": { "type": "integer" }, "voiceId": {}, "checksum": {}, "version": {}, "locale": {}, "childDirected": { "type": "boolean" } } } }, "CreateIntentVersion": { "http": { "requestUri": "/intents/{name}/versions", "responseCode": 201 }, "input": { "type": "structure", "required": [ "name" ], "members": { "name": { "location": "uri", "locationName": "name" }, "checksum": {} } }, "output": { "type": "structure", "members": { "name": {}, "description": {}, "slots": { "shape": "Sq" }, "sampleUtterances": { "shape": "Sy" }, "confirmationPrompt": { "shape": "Sa" }, "rejectionStatement": { "shape": "Si" }, "followUpPrompt": { "shape": "Sz" }, "conclusionStatement": { "shape": "Si" }, "dialogCodeHook": { "shape": "S10" }, "fulfillmentActivity": { "shape": "S13" }, "parentIntentSignature": {}, "lastUpdatedDate": { "type": "timestamp" }, "createdDate": { "type": "timestamp" }, "version": {}, "checksum": {} } } }, "CreateSlotTypeVersion": { "http": { "requestUri": "/slottypes/{name}/versions", "responseCode": 201 }, "input": { "type": "structure", "required": [ "name" ], "members": { "name": { "location": "uri", "locationName": "name" }, "checksum": {} } }, "output": { "type": "structure", "members": { "name": {}, "description": {}, "enumerationValues": { "shape": "S19" }, "lastUpdatedDate": { "type": "timestamp" }, "createdDate": { "type": "timestamp" }, "version": {}, "checksum": {}, "valueSelectionStrategy": {} } } }, "DeleteBot": { "http": { "method": "DELETE", "requestUri": "/bots/{name}", "responseCode": 204 }, "input": { "type": "structure", "required": [ "name" ], "members": { "name": { "location": "uri", "locationName": "name" } } } }, "DeleteBotAlias": { "http": { "method": "DELETE", "requestUri": "/bots/{botName}/aliases/{name}", "responseCode": 204 }, "input": { "type": "structure", "required": [ "name", "botName" ], "members": { "name": { "location": "uri", "locationName": "name" }, "botName": { "location": "uri", "locationName": "botName" } } } }, "DeleteBotChannelAssociation": { "http": { "method": "DELETE", "requestUri": "/bots/{botName}/aliases/{aliasName}/channels/{name}", "responseCode": 204 }, "input": { "type": "structure", "required": [ "name", "botName", "botAlias" ], "members": { "name": { "location": "uri", "locationName": "name" }, "botName": { "location": "uri", "locationName": "botName" }, "botAlias": { "location": "uri", "locationName": "aliasName" } } } }, "DeleteBotVersion": { "http": { "method": "DELETE", "requestUri": "/bots/{name}/versions/{version}", "responseCode": 204 }, "input": { "type": "structure", "required": [ "name", "version" ], "members": { "name": { "location": "uri", "locationName": "name" }, "version": { "location": "uri", "locationName": "version" } } } }, "DeleteIntent": { "http": { "method": "DELETE", "requestUri": "/intents/{name}", "responseCode": 204 }, "input": { "type": "structure", "required": [ "name" ], "members": { "name": { "location": "uri", "locationName": "name" } } } }, "DeleteIntentVersion": { "http": { "method": "DELETE", "requestUri": "/intents/{name}/versions/{version}", "responseCode": 204 }, "input": { "type": "structure", "required": [ "name", "version" ], "members": { "name": { "location": "uri", "locationName": "name" }, "version": { "location": "uri", "locationName": "version" } } } }, "DeleteSlotType": { "http": { "method": "DELETE", "requestUri": "/slottypes/{name}", "responseCode": 204 }, "input": { "type": "structure", "required": [ "name" ], "members": { "name": { "location": "uri", "locationName": "name" } } } }, "DeleteSlotTypeVersion": { "http": { "method": "DELETE", "requestUri": "/slottypes/{name}/version/{version}", "responseCode": 204 }, "input": { "type": "structure", "required": [ "name", "version" ], "members": { "name": { "location": "uri", "locationName": "name" }, "version": { "location": "uri", "locationName": "version" } } } }, "DeleteUtterances": { "http": { "method": "DELETE", "requestUri": "/bots/{botName}/utterances/{userId}", "responseCode": 204 }, "input": { "type": "structure", "required": [ "botName", "userId" ], "members": { "botName": { "location": "uri", "locationName": "botName" }, "userId": { "location": "uri", "locationName": "userId" } } } }, "GetBot": { "http": { "method": "GET", "requestUri": "/bots/{name}/versions/{versionoralias}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "name", "versionOrAlias" ], "members": { "name": { "location": "uri", "locationName": "name" }, "versionOrAlias": { "location": "uri", "locationName": "versionoralias" } } }, "output": { "type": "structure", "members": { "name": {}, "description": {}, "intents": { "shape": "S6" }, "clarificationPrompt": { "shape": "Sa" }, "abortStatement": { "shape": "Si" }, "status": {}, "failureReason": {}, "lastUpdatedDate": { "type": "timestamp" }, "createdDate": { "type": "timestamp" }, "idleSessionTTLInSeconds": { "type": "integer" }, "voiceId": {}, "checksum": {}, "version": {}, "locale": {}, "childDirected": { "type": "boolean" } } } }, "GetBotAlias": { "http": { "method": "GET", "requestUri": "/bots/{botName}/aliases/{name}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "name", "botName" ], "members": { "name": { "location": "uri", "locationName": "name" }, "botName": { "location": "uri", "locationName": "botName" } } }, "output": { "type": "structure", "members": { "name": {}, "description": {}, "botVersion": {}, "botName": {}, "lastUpdatedDate": { "type": "timestamp" }, "createdDate": { "type": "timestamp" }, "checksum": {} } } }, "GetBotAliases": { "http": { "method": "GET", "requestUri": "/bots/{botName}/aliases/", "responseCode": 200 }, "input": { "type": "structure", "required": [ "botName" ], "members": { "botName": { "location": "uri", "locationName": "botName" }, "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" }, "nameContains": { "location": "querystring", "locationName": "nameContains" } } }, "output": { "type": "structure", "members": { "BotAliases": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "description": {}, "botVersion": {}, "botName": {}, "lastUpdatedDate": { "type": "timestamp" }, "createdDate": { "type": "timestamp" }, "checksum": {} } } }, "nextToken": {} } } }, "GetBotChannelAssociation": { "http": { "method": "GET", "requestUri": "/bots/{botName}/aliases/{aliasName}/channels/{name}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "name", "botName", "botAlias" ], "members": { "name": { "location": "uri", "locationName": "name" }, "botName": { "location": "uri", "locationName": "botName" }, "botAlias": { "location": "uri", "locationName": "aliasName" } } }, "output": { "type": "structure", "members": { "name": {}, "description": {}, "botAlias": {}, "botName": {}, "createdDate": { "type": "timestamp" }, "type": {}, "botConfiguration": { "shape": "S24" }, "status": {}, "failureReason": {} } } }, "GetBotChannelAssociations": { "http": { "method": "GET", "requestUri": "/bots/{botName}/aliases/{aliasName}/channels/", "responseCode": 200 }, "input": { "type": "structure", "required": [ "botName", "botAlias" ], "members": { "botName": { "location": "uri", "locationName": "botName" }, "botAlias": { "location": "uri", "locationName": "aliasName" }, "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" }, "nameContains": { "location": "querystring", "locationName": "nameContains" } } }, "output": { "type": "structure", "members": { "botChannelAssociations": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "description": {}, "botAlias": {}, "botName": {}, "createdDate": { "type": "timestamp" }, "type": {}, "botConfiguration": { "shape": "S24" }, "status": {}, "failureReason": {} } } }, "nextToken": {} } } }, "GetBotVersions": { "http": { "method": "GET", "requestUri": "/bots/{name}/versions/", "responseCode": 200 }, "input": { "type": "structure", "required": [ "name" ], "members": { "name": { "location": "uri", "locationName": "name" }, "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" } } }, "output": { "type": "structure", "members": { "bots": { "shape": "S2d" }, "nextToken": {} } } }, "GetBots": { "http": { "method": "GET", "requestUri": "/bots/", "responseCode": 200 }, "input": { "type": "structure", "members": { "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" }, "nameContains": { "location": "querystring", "locationName": "nameContains" } } }, "output": { "type": "structure", "members": { "bots": { "shape": "S2d" }, "nextToken": {} } } }, "GetBuiltinIntent": { "http": { "method": "GET", "requestUri": "/builtins/intents/{signature}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "signature" ], "members": { "signature": { "location": "uri", "locationName": "signature" } } }, "output": { "type": "structure", "members": { "signature": {}, "supportedLocales": { "shape": "S2j" }, "slots": { "type": "list", "member": { "type": "structure", "members": { "name": {} } } } } } }, "GetBuiltinIntents": { "http": { "method": "GET", "requestUri": "/builtins/intents/", "responseCode": 200 }, "input": { "type": "structure", "members": { "locale": { "location": "querystring", "locationName": "locale" }, "signatureContains": { "location": "querystring", "locationName": "signatureContains" }, "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" } } }, "output": { "type": "structure", "members": { "intents": { "type": "list", "member": { "type": "structure", "members": { "signature": {}, "supportedLocales": { "shape": "S2j" } } } }, "nextToken": {} } } }, "GetBuiltinSlotTypes": { "http": { "method": "GET", "requestUri": "/builtins/slottypes/", "responseCode": 200 }, "input": { "type": "structure", "members": { "locale": { "location": "querystring", "locationName": "locale" }, "signatureContains": { "location": "querystring", "locationName": "signatureContains" }, "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" } } }, "output": { "type": "structure", "members": { "slotTypes": { "type": "list", "member": { "type": "structure", "members": { "signature": {}, "supportedLocales": { "shape": "S2j" } } } }, "nextToken": {} } } }, "GetExport": { "http": { "method": "GET", "requestUri": "/exports/", "responseCode": 200 }, "input": { "type": "structure", "required": [ "name", "version", "resourceType", "exportType" ], "members": { "name": { "location": "querystring", "locationName": "name" }, "version": { "location": "querystring", "locationName": "version" }, "resourceType": { "location": "querystring", "locationName": "resourceType" }, "exportType": { "location": "querystring", "locationName": "exportType" } } }, "output": { "type": "structure", "members": { "name": {}, "version": {}, "resourceType": {}, "exportType": {}, "exportStatus": {}, "failureReason": {}, "url": {} } } }, "GetImport": { "http": { "method": "GET", "requestUri": "/imports/{importId}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "importId" ], "members": { "importId": { "location": "uri", "locationName": "importId" } } }, "output": { "type": "structure", "members": { "name": {}, "resourceType": {}, "mergeStrategy": {}, "importId": {}, "importStatus": {}, "failureReason": { "type": "list", "member": {} }, "createdDate": { "type": "timestamp" } } } }, "GetIntent": { "http": { "method": "GET", "requestUri": "/intents/{name}/versions/{version}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "name", "version" ], "members": { "name": { "location": "uri", "locationName": "name" }, "version": { "location": "uri", "locationName": "version" } } }, "output": { "type": "structure", "members": { "name": {}, "description": {}, "slots": { "shape": "Sq" }, "sampleUtterances": { "shape": "Sy" }, "confirmationPrompt": { "shape": "Sa" }, "rejectionStatement": { "shape": "Si" }, "followUpPrompt": { "shape": "Sz" }, "conclusionStatement": { "shape": "Si" }, "dialogCodeHook": { "shape": "S10" }, "fulfillmentActivity": { "shape": "S13" }, "parentIntentSignature": {}, "lastUpdatedDate": { "type": "timestamp" }, "createdDate": { "type": "timestamp" }, "version": {}, "checksum": {} } } }, "GetIntentVersions": { "http": { "method": "GET", "requestUri": "/intents/{name}/versions/", "responseCode": 200 }, "input": { "type": "structure", "required": [ "name" ], "members": { "name": { "location": "uri", "locationName": "name" }, "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" } } }, "output": { "type": "structure", "members": { "intents": { "shape": "S3a" }, "nextToken": {} } } }, "GetIntents": { "http": { "method": "GET", "requestUri": "/intents/", "responseCode": 200 }, "input": { "type": "structure", "members": { "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" }, "nameContains": { "location": "querystring", "locationName": "nameContains" } } }, "output": { "type": "structure", "members": { "intents": { "shape": "S3a" }, "nextToken": {} } } }, "GetSlotType": { "http": { "method": "GET", "requestUri": "/slottypes/{name}/versions/{version}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "name", "version" ], "members": { "name": { "location": "uri", "locationName": "name" }, "version": { "location": "uri", "locationName": "version" } } }, "output": { "type": "structure", "members": { "name": {}, "description": {}, "enumerationValues": { "shape": "S19" }, "lastUpdatedDate": { "type": "timestamp" }, "createdDate": { "type": "timestamp" }, "version": {}, "checksum": {}, "valueSelectionStrategy": {} } } }, "GetSlotTypeVersions": { "http": { "method": "GET", "requestUri": "/slottypes/{name}/versions/", "responseCode": 200 }, "input": { "type": "structure", "required": [ "name" ], "members": { "name": { "location": "uri", "locationName": "name" }, "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" } } }, "output": { "type": "structure", "members": { "slotTypes": { "shape": "S3i" }, "nextToken": {} } } }, "GetSlotTypes": { "http": { "method": "GET", "requestUri": "/slottypes/", "responseCode": 200 }, "input": { "type": "structure", "members": { "nextToken": { "location": "querystring", "locationName": "nextToken" }, "maxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" }, "nameContains": { "location": "querystring", "locationName": "nameContains" } } }, "output": { "type": "structure", "members": { "slotTypes": { "shape": "S3i" }, "nextToken": {} } } }, "GetUtterancesView": { "http": { "method": "GET", "requestUri": "/bots/{botname}/utterances?view=aggregation", "responseCode": 200 }, "input": { "type": "structure", "required": [ "botName", "botVersions", "statusType" ], "members": { "botName": { "location": "uri", "locationName": "botname" }, "botVersions": { "location": "querystring", "locationName": "bot_versions", "type": "list", "member": {} }, "statusType": { "location": "querystring", "locationName": "status_type" } } }, "output": { "type": "structure", "members": { "botName": {}, "utterances": { "type": "list", "member": { "type": "structure", "members": { "botVersion": {}, "utterances": { "type": "list", "member": { "type": "structure", "members": { "utteranceString": {}, "count": { "type": "integer" }, "distinctUsers": { "type": "integer" }, "firstUtteredDate": { "type": "timestamp" }, "lastUtteredDate": { "type": "timestamp" } } } } } } } } } }, "PutBot": { "http": { "method": "PUT", "requestUri": "/bots/{name}/versions/$LATEST", "responseCode": 200 }, "input": { "type": "structure", "required": [ "name", "locale", "childDirected" ], "members": { "name": { "location": "uri", "locationName": "name" }, "description": {}, "intents": { "shape": "S6" }, "clarificationPrompt": { "shape": "Sa" }, "abortStatement": { "shape": "Si" }, "idleSessionTTLInSeconds": { "type": "integer" }, "voiceId": {}, "checksum": {}, "processBehavior": {}, "locale": {}, "childDirected": { "type": "boolean" }, "createVersion": { "type": "boolean" } } }, "output": { "type": "structure", "members": { "name": {}, "description": {}, "intents": { "shape": "S6" }, "clarificationPrompt": { "shape": "Sa" }, "abortStatement": { "shape": "Si" }, "status": {}, "failureReason": {}, "lastUpdatedDate": { "type": "timestamp" }, "createdDate": { "type": "timestamp" }, "idleSessionTTLInSeconds": { "type": "integer" }, "voiceId": {}, "checksum": {}, "version": {}, "locale": {}, "childDirected": { "type": "boolean" }, "createVersion": { "type": "boolean" } } } }, "PutBotAlias": { "http": { "method": "PUT", "requestUri": "/bots/{botName}/aliases/{name}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "name", "botVersion", "botName" ], "members": { "name": { "location": "uri", "locationName": "name" }, "description": {}, "botVersion": {}, "botName": { "location": "uri", "locationName": "botName" }, "checksum": {} } }, "output": { "type": "structure", "members": { "name": {}, "description": {}, "botVersion": {}, "botName": {}, "lastUpdatedDate": { "type": "timestamp" }, "createdDate": { "type": "timestamp" }, "checksum": {} } } }, "PutIntent": { "http": { "method": "PUT", "requestUri": "/intents/{name}/versions/$LATEST", "responseCode": 200 }, "input": { "type": "structure", "required": [ "name" ], "members": { "name": { "location": "uri", "locationName": "name" }, "description": {}, "slots": { "shape": "Sq" }, "sampleUtterances": { "shape": "Sy" }, "confirmationPrompt": { "shape": "Sa" }, "rejectionStatement": { "shape": "Si" }, "followUpPrompt": { "shape": "Sz" }, "conclusionStatement": { "shape": "Si" }, "dialogCodeHook": { "shape": "S10" }, "fulfillmentActivity": { "shape": "S13" }, "parentIntentSignature": {}, "checksum": {}, "createVersion": { "type": "boolean" } } }, "output": { "type": "structure", "members": { "name": {}, "description": {}, "slots": { "shape": "Sq" }, "sampleUtterances": { "shape": "Sy" }, "confirmationPrompt": { "shape": "Sa" }, "rejectionStatement": { "shape": "Si" }, "followUpPrompt": { "shape": "Sz" }, "conclusionStatement": { "shape": "Si" }, "dialogCodeHook": { "shape": "S10" }, "fulfillmentActivity": { "shape": "S13" }, "parentIntentSignature": {}, "lastUpdatedDate": { "type": "timestamp" }, "createdDate": { "type": "timestamp" }, "version": {}, "checksum": {}, "createVersion": { "type": "boolean" } } } }, "PutSlotType": { "http": { "method": "PUT", "requestUri": "/slottypes/{name}/versions/$LATEST", "responseCode": 200 }, "input": { "type": "structure", "required": [ "name" ], "members": { "name": { "location": "uri", "locationName": "name" }, "description": {}, "enumerationValues": { "shape": "S19" }, "checksum": {}, "valueSelectionStrategy": {}, "createVersion": { "type": "boolean" } } }, "output": { "type": "structure", "members": { "name": {}, "description": {}, "enumerationValues": { "shape": "S19" }, "lastUpdatedDate": { "type": "timestamp" }, "createdDate": { "type": "timestamp" }, "version": {}, "checksum": {}, "valueSelectionStrategy": {}, "createVersion": { "type": "boolean" } } } }, "StartImport": { "http": { "requestUri": "/imports/", "responseCode": 201 }, "input": { "type": "structure", "required": [ "payload", "resourceType", "mergeStrategy" ], "members": { "payload": { "type": "blob" }, "resourceType": {}, "mergeStrategy": {} } }, "output": { "type": "structure", "members": { "name": {}, "resourceType": {}, "mergeStrategy": {}, "importId": {}, "importStatus": {}, "createdDate": { "type": "timestamp" } } } } }, "shapes": { "S6": { "type": "list", "member": { "type": "structure", "required": [ "intentName", "intentVersion" ], "members": { "intentName": {}, "intentVersion": {} } } }, "Sa": { "type": "structure", "required": [ "messages", "maxAttempts" ], "members": { "messages": { "shape": "Sb" }, "maxAttempts": { "type": "integer" }, "responseCard": {} } }, "Sb": { "type": "list", "member": { "type": "structure", "required": [ "contentType", "content" ], "members": { "contentType": {}, "content": {}, "groupNumber": { "type": "integer" } } } }, "Si": { "type": "structure", "required": [ "messages" ], "members": { "messages": { "shape": "Sb" }, "responseCard": {} } }, "Sq": { "type": "list", "member": { "type": "structure", "required": [ "name", "slotConstraint" ], "members": { "name": {}, "description": {}, "slotConstraint": {}, "slotType": {}, "slotTypeVersion": {}, "valueElicitationPrompt": { "shape": "Sa" }, "priority": { "type": "integer" }, "sampleUtterances": { "type": "list", "member": {} }, "responseCard": {} } } }, "Sy": { "type": "list", "member": {} }, "Sz": { "type": "structure", "required": [ "prompt", "rejectionStatement" ], "members": { "prompt": { "shape": "Sa" }, "rejectionStatement": { "shape": "Si" } } }, "S10": { "type": "structure", "required": [ "uri", "messageVersion" ], "members": { "uri": {}, "messageVersion": {} } }, "S13": { "type": "structure", "required": [ "type" ], "members": { "type": {}, "codeHook": { "shape": "S10" } } }, "S19": { "type": "list", "member": { "type": "structure", "required": [ "value" ], "members": { "value": {}, "synonyms": { "type": "list", "member": {} } } } }, "S24": { "type": "map", "key": {}, "value": {}, "sensitive": true }, "S2d": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "description": {}, "status": {}, "lastUpdatedDate": { "type": "timestamp" }, "createdDate": { "type": "timestamp" }, "version": {} } } }, "S2j": { "type": "list", "member": {} }, "S3a": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "description": {}, "lastUpdatedDate": { "type": "timestamp" }, "createdDate": { "type": "timestamp" }, "version": {} } } }, "S3i": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "description": {}, "lastUpdatedDate": { "type": "timestamp" }, "createdDate": { "type": "timestamp" }, "version": {} } } } } }