openapi-directory/api/amazonaws.com/models.lex.v2.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"version":"2020-08-07","x-release":"v4","title":"Amazon Lex Model Building V2","description":"<p/>","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"models.lex.v2","x-aws-signingName":"lex","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/models.lex.v2-2020-08-07.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/models-v2-lex/"},"servers":[{"url":"http://models-v2-lex.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Lex Models V2 multi-region endpoint"},{"url":"https://models-v2-lex.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Lex Models V2 multi-region endpoint"},{"url":"http://models-v2-lex.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Lex Models V2 endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://models-v2-lex.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Lex Models V2 endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/batchcreate":{"put":{"operationId":"BatchCreateCustomVocabularyItem","description":"Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreateCustomVocabularyItemResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"botId","in":"path","required":true,"description":"The identifier of the bot associated with this custom vocabulary.","schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":10,"maxLength":10}},{"name":"botVersion","in":"path","required":true,"description":"The identifier of the version of the bot associated with this custom vocabulary.","schema":{"type":"string","pattern":"^(DRAFT|[0-9]+)$","minLength":1,"maxLength":5}},{"name":"localeId","in":"path","required":true,"description":"The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html\"> Supported Languages </a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customVocabularyItemList"],"properties":{"customVocabularyItemList":{"description":"A list of new custom vocabulary items. Each entry must contain a phrase and can optionally contain a displayAs and/or a weight.","type":"array","items":{"$ref":"#/components/schemas/NewCustomVocabularyItem"},"minItems":1,"maxItems":10}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/batchdelete":{"post":{"operationId":"BatchDeleteCustomVocabularyItem","description":"Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchDeleteCustomVocabularyItemResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"botId","in":"path","required":true,"description":"The identifier of the bot associated with this custom vocabulary.","schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":10,"maxLength":10}},{"name":"botVersion","in":"path","required":true,"description":"The identifier of the version of the bot associated with this custom vocabulary.","schema":{"type":"string","pattern":"^(DRAFT|[0-9]+)$","minLength":1,"maxLength":5}},{"name":"localeId","in":"path","required":true,"description":"The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html\"> Supported Languages </a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customVocabularyItemList"],"properties":{"customVocabularyItemList":{"description":"A list of custom vocabulary items requested to be deleted. Each entry must contain the unique custom vocabulary entry identifier.","type":"array","items":{"$ref":"#/components/schemas/CustomVocabularyEntryId"},"minItems":1,"maxItems":10}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/batchupdate":{"put":{"operationId":"BatchUpdateCustomVocabularyItem","description":"Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchUpdateCustomVocabularyItemResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"botId","in":"path","required":true,"description":"The identifier of the bot associated with this custom vocabulary","schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":10,"maxLength":10}},{"name":"botVersion","in":"path","required":true,"description":"The identifier of the version of the bot associated with this custom vocabulary.","schema":{"type":"string","pattern":"^(DRAFT|[0-9]+)$","minLength":1,"maxLength":5}},{"name":"localeId","in":"path","required":true,"description":"The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html\"> Supported Languages </a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customVocabularyItemList"],"properties":{"customVocabularyItemList":{"description":"A list of custom vocabulary items with updated fields. Each entry must contain a phrase and can optionally contain a displayAs and/or a weight.","type":"array","items":{"$ref":"#/components/schemas/CustomVocabularyItem"},"minItems":1,"maxItems":10}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/":{"post":{"operationId":"BuildBotLocale","description":"Builds a bot, its intents, and its slot types into a specific locale. A bot can be built into multiple locales. At runtime the locale is used to choose a specific build of the bot.","responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildBotLocaleResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"PreconditionFailedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionFailedException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"485":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"botId","in":"path","required":true,"description":"The identifier of the bot to build. The identifier is returned in the response from the <a href=\"https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html\">CreateBot</a> operation.","schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":10,"maxLength":10}},{"name":"botVersion","in":"path","required":true,"description":"The version of the bot to build. This can only be the draft version of the bot.","schema":{"type":"string","pattern":"^DRAFT$","minLength":5,"maxLength":5}},{"name":"localeId","in":"path","required":true,"description":"The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html\">Supported languages</a>.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DeleteBotLocale","description":"<p>Removes a locale from a bot.</p> <p>When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.</p>","responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBotLocaleResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"PreconditionFailedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionFailedException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"485":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"botId","in":"path","required":true,"description":"The unique identifier of the bot that contains the locale.","schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":10,"maxLength":10}},{"name":"botVersion","in":"path","required":true,"description":"The version of the bot that contains the locale. ","schema":{"type":"string","pattern":"^DRAFT$","minLength":5,"maxLength":5}},{"name":"localeId","in":"path","required":true,"description":"The identifier of the language and locale that will be deleted. The string must match one of the supported locales. For more information, see <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html\">Supported languages</a>.","schema":{"type":"string"}}]},"get":{"operationId":"DescribeBotLocale","description":"Describes the settings that a bot has for a specific locale. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeBotLocaleResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"botId","in":"path","required":true,"description":"The identifier of the bot associated with the locale.","schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":10,"maxLength":10}},{"name":"botVersion","in":"path","required":true,"description":"The version of the bot associated with the locale.","schema":{"type":"string","pattern":"^(DRAFT|[0-9]+)$","minLength":1,"maxLength":5}},{"name":"localeId","in":"path","required":true,"description":"The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html\">Supported languages</a>. ","schema":{"type":"string"}}]},"put":{"operationId":"UpdateBotLocale","description":"Updates the settings that a bot has for a specific locale.","responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBotLocaleResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"PreconditionFailedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionFailedException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"485":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"botId","in":"path","required":true,"description":"The unique identifier of the bot that contains the locale.","schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":10,"maxLength":10}},{"name":"botVersion","in":"path","required":true,"description":"The version of the bot that contains the locale to be updated. The version can only be the <code>DRAFT</code> version.","schema":{"type":"string","pattern":"^DRAFT$","minLength":5,"maxLength":5}},{"name":"localeId","in":"path","required":true,"description":"The identifier of the language and locale to update. The string must match one of the supported locales. For more information, see <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html\">Supported languages</a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["nluIntentConfidenceThreshold"],"properties":{"description":{"description":"The new description of the locale.","type":"string","minLength":0,"maxLength":200},"nluIntentConfidenceThreshold":{"description":"The new confidence threshold where Amazon Lex inserts the <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> intents in the list of possible intents for an utterance.","type":"number","format":"double","minimum":0,"maximum":1},"voiceSettings":{"description":"Defines settings for using an Amazon Polly voice to communicate with a user.","type":"object","properties":{"voiceId":{"allOf":[{"$ref":"#/components/schemas/VoiceId"},{"description":"The identifier of the Amazon Polly voice to use."}]},"engine":{"allOf":[{"$ref":"#/components/schemas/VoiceEngine"},{"description":"<p>Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the <a href=\"https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine\"> <code>engine</code> parameter of the <code>SynthesizeSpeech</code> operation</a> in the <i>Amazon Polly developer guide</i>.</p> <p>If you do not specify a value, the default is <code>standard</code>.</p>"}]}}}}}}}}}},"/bots/":{"put":{"operationId":"CreateBot","description":"Creates an Amazon Lex conversational bot. ","responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBotResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"PreconditionFailedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionFailedException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"485":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["botName","roleArn","dataPrivacy","idleSessionTTLInSeconds"],"properties":{"botName":{"description":"The name of the bot. The bot name must be unique in the account that creates the bot.","type":"string","pattern":"^([0-9a-zA-Z][_-]?){1,100}$","minLength":1,"maxLength":100},"description":{"description":"A description of the bot. It appears in lists to help you identify a particular bot.","type":"string","minLength":0,"maxLength":200},"roleArn":{"description":"The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.","type":"string","pattern":"^arn:aws:iam::[0-9]{12}:role/.*$","minLength":32,"maxLength":2048},"dataPrivacy":{"description":"By default, data stored by Amazon Lex is encrypted. The <code>DataPrivacy</code> structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot. ","type":"object","properties":{"childDirected":{"allOf":[{"$ref":"#/components/schemas/ChildDirected"},{"description":"For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying <code>true</code> or <code>false</code> in the <code>childDirected</code> field. By specifying <code>true</code> in the <code>childDirected</code> field, you confirm that your use of Amazon Lex <b>is</b> related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying <code>false</code> in the <code>childDirected</code> field, you confirm that your use of Amazon Lex <b>is not</b> related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the <code>childDirected</code> field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the <a href=\"http://aws.amazon.com/lex/faqs#data-security\">Amazon Lex FAQ</a>."}]}}},"idleSessionTTLInSeconds":{"description":"<p>The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot. </p> <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.</p> <p>You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.</p>","type":"integer","minimum":60,"maximum":86400},"botTags":{"description":"A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the <code>UpdateBot</code> operation to update tags. To update tags, use the <code>TagResource</code> operation.","type":"object","minProperties":0,"maxProperties":200,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}},"testBotAliasTags":{"description":"A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the <code>UpdateAlias</code> operation to update tags. To update tags on the test alias, use the <code>TagResource</code> operation.","type":"object","minProperties":0,"maxProperties":200,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}},"botType":{"description":"The type of a bot to create.","type":"string","enum":["Bot","BotNetwork"]},"botMembers":{"description":"The list of bot members in a network to be created.","type":"array","items":{"$ref":"#/components/schemas/BotMember"},"minItems":0,"maxItems":10}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"operationId":"ListBots","description":"Gets a list of available bots.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBotsResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"maxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"nextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sortBy":{"description":"Specifies attributes for sorting a list of bots.","type":"object","properties":{"attribute":{"allOf":[{"$ref":"#/components/schemas/BotSortAttribute"},{"description":"The attribute to use to sort the list of bots."}]},"order":{"allOf":[{"$ref":"#/components/schemas/SortOrder"},{"description":"The order to sort the list. You can choose ascending or descending."}]}}},"filters":{"description":"Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.","type":"array","items":{"$ref":"#/components/schemas/BotFilter"},"minItems":1,"maxItems":2},"maxResults":{"description":"The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.","type":"integer","minimum":1,"maximum":1000},"nextToken":{"description":"<p>If the response from the <code>ListBots</code> operation contains more results than specified in the <code>maxResults</code> parameter, a token is returned in the response. </p> <p>Use the returned token in the <code>nextToken</code> parameter of a <code>ListBots</code> request to return the next page of results. For a complete set of results, call the <code>ListBots</code> operation until the <code>nextToken</code> returned in the response is null.</p>","type":"string"}}}}}}}},"/bots/{botId}/botaliases/":{"put":{"operationId":"CreateBotAlias","description":"<p>Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.</p> <p>For example, you can create an alias called \"PROD\" that your applications use to call the Amazon Lex bot. </p>","responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBotAliasResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"PreconditionFailedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionFailedException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"485":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"botId","in":"path","required":true,"description":"The unique identifier of the bot that the alias applies to.","schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":10,"maxLength":10}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["botAliasName"],"properties":{"botAliasName":{"description":"The alias to create. The name must be unique for the bot.","type":"string","pattern":"^([0-9a-zA-Z][_-]?){1,100}$","minLength":1,"maxLength":100},"description":{"description":"A description of the alias. Use this description to help identify the alias.","type":"string","minLength":0,"maxLength":200},"botVersion":{"description":"The version of the bot that this alias points to. You can use the <a href=\"https://docs.aws.amazon.com/lexv2/latest/APIReference/API_UpdateBotAlias.html\">UpdateBotAlias</a> operation to change the bot version associated with the alias.","type":"string","pattern":"^[0-9]+$","minLength":1,"maxLength":5},"botAliasLocaleSettings":{"description":"Maps configuration information to a specific locale. You can use this parameter to specify a specific Lambda function to run different functions in different locales.","type":"object","minProperties":1,"additionalProperties":{"$ref":"#/components/schemas/BotAliasLocaleSettings"}},"conversationLogSettings":{"description":"Configures conversation logging that saves audio, text, and metadata for the conversations with your users.","type":"object","properties":{"textLogSettings":{"allOf":[{"$ref":"#/components/schemas/TextLogSettingsList"},{"description":"The Amazon CloudWatch Logs settings for logging text and metadata."}]},"audioLogSettings":{"allOf":[{"$ref":"#/components/schemas/AudioLogSettingsList"},{"description":"The Amazon S3 settings for logging audio to an S3 bucket."}]}}},"sentimentAnalysisSettings":{"description":"Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.","type":"object","properties":{"detectSentiment":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances."}]}}},"tags":{"description":"A list of tags to add to the bot alias. You can only add tags when you create an alias, you can't use the <code>UpdateBotAlias</code> operation to update the tags on a bot alias. To update tags, use the <code>TagResource</code> operation.","type":"object","minProperties":0,"maxProperties":200,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"operationId":"ListBotAliases","description":"Gets a list of aliases for the specified bot.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBotAliasesResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"botId","in":"path","required":true,"description":"The identifier of the bot to list aliases for.","schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":10,"maxLength":10}},{"name":"maxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"nextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"maxResults":{"description":"The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.","type":"integer","minimum":1,"maximum":1000},"nextToken":{"description":"If the response from the <code>ListBotAliases</code> operation contains more results than specified in the <code>maxResults</code> parameter, a token is returned in the response. Use that token in the <code>nextToken</code> parameter to return the next page of results.","type":"string"}}}}}}}},"/bots/{botId}/botversions/{botVersion}/botlocales/":{"put":{"operationId":"CreateBotLocale","description":"Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.","responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBotLocaleResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"PreconditionFailedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionFailedException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"485":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"botId","in":"path","required":true,"description":"The identifier of the bot to create the locale for.","schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":10,"maxLength":10}},{"name":"botVersion","in":"path","required":true,"description":"The version of the bot to create the locale for. This can only be the draft version of the bot.","schema":{"type":"string","pattern":"^DRAFT$","minLength":5,"maxLength":5}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["localeId","nluIntentConfidenceThreshold"],"properties":{"localeId":{"description":"The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html\">Supported languages</a>.","type":"string"},"description":{"description":"A description of the bot locale. Use this to help identify the bot locale in lists.","type":"string","minLength":0,"maxLength":200},"nluIntentConfidenceThreshold":{"description":"<p>Determines the threshold where Amazon Lex will insert the <code>AMAZON.FallbackIntent</code>, <code>AMAZON.KendraSearchIntent</code>, or both when returning alternative intents. <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> are only inserted if they are configured for the bot.</p> <p>For example, suppose a bot is configured with the confidence threshold of 0.80 and the <code>AMAZON.FallbackIntent</code>. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the <code>RecognizeText</code> operation would be:</p> <ul> <li> <p>AMAZON.FallbackIntent</p> </li> <li> <p>IntentA</p> </li> <li> <p>IntentB</p> </li> <li> <p>IntentC</p> </li> </ul>","type":"number","format":"double","minimum":0,"maximum":1},"voiceSettings":{"description":"Defines settings for using an Amazon Polly voice to communicate with a user.","type":"object","properties":{"voiceId":{"allOf":[{"$ref":"#/components/schemas/VoiceId"},{"description":"The identifier of the Amazon Polly voice to use."}]},"engine":{"allOf":[{"$ref":"#/components/schemas/VoiceEngine"},{"description":"<p>Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the <a href=\"https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine\"> <code>engine</code> parameter of the <code>SynthesizeSpeech</code> operation</a> in the <i>Amazon Polly developer guide</i>.</p> <p>If you do not specify a value, the default is <code>standard</code>.</p>"}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"operationId":"ListBotLocales","description":"Gets a list of locales for the specified bot.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBotLocalesResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"botId","in":"path","required":true,"description":"The identifier of the bot to list locales for.","schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":10,"maxLength":10}},{"name":"botVersion","in":"path","required":true,"description":"The version of the bot to list locales for.","schema":{"type":"string","pattern":"^(DRAFT|[0-9]+)$","minLength":1,"maxLength":5}},{"name":"maxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"nextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sortBy":{"description":"Specifies attributes for sorting a list of bot locales.","type":"object","properties":{"attribute":{"allOf":[{"$ref":"#/components/schemas/BotLocaleSortAttribute"},{"description":"The bot locale attribute to sort by."}]},"order":{"allOf":[{"$ref":"#/components/schemas/SortOrder"},{"description":"Specifies whether to sort the bot locales in ascending or descending order."}]}}},"filters":{"description":"Provides the specification for a filter used to limit the response to only those locales that match the filter specification. You can only specify one filter and one value to filter on.","type":"array","items":{"$ref":"#/components/schemas/BotLocaleFilter"},"minItems":1,"maxItems":1},"maxResults":{"description":"The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.","type":"integer","minimum":1,"maximum":1000},"nextToken":{"description":"If the response from the <code>ListBotLocales</code> operation contains more results than specified in the <code>maxResults</code> parameter, a token is returned in the response. Use that token as the <code>nextToken</code> parameter to return the next page of results. ","type":"string"}}}}}}}},"/bots/{botId}/botversions/":{"put":{"operationId":"CreateBotVersion","description":"<p>Creates a new version of the bot based on the <code>DRAFT</code> version. If the <code>DRAFT</code> version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version, it returns the last created version.</p> <p>When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1.</p>","responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBotVersionResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"PreconditionFailedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionFailedException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"485":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"botId","in":"path","required":true,"description":"The identifier of the bot to create the version for.","schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":10,"maxLength":10}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["botVersionLocaleSpecification"],"properties":{"description":{"description":"A description of the version. Use the description to help identify the version in lists.","type":"string","minLength":0,"maxLength":200},"botVersionLocaleSpecification":{"description":"Specifies the locales that Amazon Lex adds to this version. You can choose the <code>Draft</code> version or any other previously published version for each locale. When you specify a source version, the locale data is copied from the source version to the new version.","type":"object","minProperties":1,"additionalProperties":{"$ref":"#/components/schemas/BotVersionLocaleDetails"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"operationId":"ListBotVersions","description":"<p>Gets information about all of the versions of a bot.</p> <p>The <code>ListBotVersions</code> operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the <code>ListBotVersions</code> operation returns for summaries, one for each numbered version and one for the <code>DRAFT</code> version.</p> <p>The <code>ListBotVersions</code> operation always returns at least one version, the <code>DRAFT</code> version.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBotVersionsResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"botId","in":"path","required":true,"description":"The identifier of the bot to list versions for.","schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":10,"maxLength":10}},{"name":"maxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"nextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sortBy":{"description":"Specifies attributes for sorting a list of bot versions.","type":"object","properties":{"attribute":{"allOf":[{"$ref":"#/components/schemas/BotVersionSortAttribute"},{"description":"The attribute to use to sort the list of versions."}]},"order":{"allOf":[{"$ref":"#/components/schemas/SortOrder"},{"description":"The order to sort the list. You can specify ascending or descending order."}]}}},"maxResults":{"description":"The maximum number of versions to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.","type":"integer","minimum":1,"maximum":1000},"nextToken":{"description":"If the response to the <code>ListBotVersion</code> operation contains more results than specified in the <code>maxResults</code> parameter, a token is returned in the response. Use that token in the <code>nextToken</code> parameter to return the next page of results.","type":"string"}}}}}}}},"/exports/":{"put":{"operationId":"CreateExport","description":"<p>Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot.</p> <p>You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale.</p> <p>For more information about exporting bots, and about the structure of the export archive, see <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/importing-exporting.html\"> Importing and exporting bots </a> </p>","responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExportResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"485":{"descrip