2025/04/02 - Amazon Lex Model Building V2 - 8 updated api methods
{'errorLogSettings': {'enabled': 'boolean'}}
Creates an Amazon Lex conversational bot.
See also: AWS API Documentation
Request Syntax
client.create_bot(
botName='string',
description='string',
roleArn='string',
dataPrivacy={
'childDirected': True|False
},
idleSessionTTLInSeconds=123,
botTags={
'string': 'string'
},
testBotAliasTags={
'string': 'string'
},
botType='Bot'|'BotNetwork',
botMembers=[
{
'botMemberId': 'string',
'botMemberName': 'string',
'botMemberAliasId': 'string',
'botMemberAliasName': 'string',
'botMemberVersion': 'string'
},
],
errorLogSettings={
'enabled': True|False
}
)
string
[REQUIRED]
The name of the bot. The bot name must be unique in the account that creates the bot.
string
A description of the bot. It appears in lists to help you identify a particular bot.
string
[REQUIRED]
The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
dict
[REQUIRED]
Provides information on additional privacy protections Amazon Lex should use with the bot's data.
childDirected (boolean) -- [REQUIRED]
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 true or false in the childDirected field. By specifying true in the childDirected field, you confirm that 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. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not 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 childDirected 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 Amazon Lex FAQ.
integer
[REQUIRED]
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
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.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
dict
A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.
(string) --
(string) --
dict
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 UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.
(string) --
(string) --
string
The type of a bot to create.
list
The list of bot members in a network to be created.
(dict) --
A bot that is a member of a network of bots.
botMemberId (string) -- [REQUIRED]
The unique ID of a bot that is a member of this network of bots.
botMemberName (string) -- [REQUIRED]
The unique name of a bot that is a member of this network of bots.
botMemberAliasId (string) -- [REQUIRED]
The alias ID of a bot that is a member of this network of bots.
botMemberAliasName (string) -- [REQUIRED]
The alias name of a bot that is a member of this network of bots.
botMemberVersion (string) -- [REQUIRED]
The version of a bot that is a member of this network of bots.
dict
Specifies the configuration for error logging during bot creation.
enabled (boolean) -- [REQUIRED]
Settings parameters for the error logs, when it is enabled.
dict
Response Syntax
{
'botId': 'string',
'botName': 'string',
'description': 'string',
'roleArn': 'string',
'dataPrivacy': {
'childDirected': True|False
},
'idleSessionTTLInSeconds': 123,
'botStatus': 'Creating'|'Available'|'Inactive'|'Deleting'|'Failed'|'Versioning'|'Importing'|'Updating',
'creationDateTime': datetime(2015, 1, 1),
'botTags': {
'string': 'string'
},
'testBotAliasTags': {
'string': 'string'
},
'botType': 'Bot'|'BotNetwork',
'botMembers': [
{
'botMemberId': 'string',
'botMemberName': 'string',
'botMemberAliasId': 'string',
'botMemberAliasName': 'string',
'botMemberVersion': 'string'
},
],
'errorLogSettings': {
'enabled': True|False
}
}
Response Structure
(dict) --
botId (string) --
A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.
botName (string) --
The name specified for the bot.
description (string) --
The description specified for the bot.
roleArn (string) --
The IAM role specified for the bot.
dataPrivacy (dict) --
The data privacy settings specified for the bot.
childDirected (boolean) --
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 true or false in the childDirected field. By specifying true in the childDirected field, you confirm that 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. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not 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 childDirected 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 Amazon Lex FAQ.
idleSessionTTLInSeconds (integer) --
The session idle time specified for the bot.
botStatus (string) --
Shows the current status of the bot. The bot is first in the Creating status. Once the bot is read for use, it changes to the Available status. After the bot is created, you can use the DRAFT version of the bot.
creationDateTime (datetime) --
A timestamp indicating the date and time that the bot was created.
botTags (dict) --
A list of tags associated with the bot.
(string) --
(string) --
testBotAliasTags (dict) --
A list of tags associated with the test alias for the bot.
(string) --
(string) --
botType (string) --
The type of a bot that was created.
botMembers (list) --
The list of bots in a network that was created.
(dict) --
A bot that is a member of a network of bots.
botMemberId (string) --
The unique ID of a bot that is a member of this network of bots.
botMemberName (string) --
The unique name of a bot that is a member of this network of bots.
botMemberAliasId (string) --
The alias ID of a bot that is a member of this network of bots.
botMemberAliasName (string) --
The alias name of a bot that is a member of this network of bots.
botMemberVersion (string) --
The version of a bot that is a member of this network of bots.
errorLogSettings (dict) --
Specifies configuration settings for delivering error logs to Cloudwatch Logs in an Amazon Lex bot response.
enabled (boolean) --
Settings parameters for the error logs, when it is enabled.
{'qInConnectIntentConfiguration': {'qInConnectAssistantConfiguration': {'assistantArn': 'string'}}}
Creates an intent.
To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an OrderPizza intent.
When you create an intent, you must provide a name. You can optionally provide the following:
Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents.
Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application.
How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available.
A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?"
A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza."
A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?"
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'errorLogSettings': {'enabled': 'boolean'}}
Provides metadata information about a bot.
See also: AWS API Documentation
Request Syntax
client.describe_bot(
botId='string'
)
string
[REQUIRED]
The unique identifier of the bot to describe.
dict
Response Syntax
{
'botId': 'string',
'botName': 'string',
'description': 'string',
'roleArn': 'string',
'dataPrivacy': {
'childDirected': True|False
},
'idleSessionTTLInSeconds': 123,
'botStatus': 'Creating'|'Available'|'Inactive'|'Deleting'|'Failed'|'Versioning'|'Importing'|'Updating',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'botType': 'Bot'|'BotNetwork',
'botMembers': [
{
'botMemberId': 'string',
'botMemberName': 'string',
'botMemberAliasId': 'string',
'botMemberAliasName': 'string',
'botMemberVersion': 'string'
},
],
'failureReasons': [
'string',
],
'errorLogSettings': {
'enabled': True|False
}
}
Response Structure
(dict) --
botId (string) --
The unique identifier of the bot.
botName (string) --
The name of the bot.
description (string) --
The description of the bot.
roleArn (string) --
The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
dataPrivacy (dict) --
Settings for managing data privacy of the bot and its conversations with users.
childDirected (boolean) --
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 true or false in the childDirected field. By specifying true in the childDirected field, you confirm that 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. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not 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 childDirected 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 Amazon Lex FAQ.
idleSessionTTLInSeconds (integer) --
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
botStatus (string) --
The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.
creationDateTime (datetime) --
A timestamp of the date and time that the bot was created.
lastUpdatedDateTime (datetime) --
A timestamp of the date and time that the bot was last updated.
botType (string) --
The type of the bot that was described.
botMembers (list) --
The list of bots in the network that was described.
(dict) --
A bot that is a member of a network of bots.
botMemberId (string) --
The unique ID of a bot that is a member of this network of bots.
botMemberName (string) --
The unique name of a bot that is a member of this network of bots.
botMemberAliasId (string) --
The alias ID of a bot that is a member of this network of bots.
botMemberAliasName (string) --
The alias name of a bot that is a member of this network of bots.
botMemberVersion (string) --
The version of a bot that is a member of this network of bots.
failureReasons (list) --
If the botStatus is Failed, this contains a list of reasons that the bot couldn't be built.
(string) --
errorLogSettings (dict) --
Contains the configuration for error logging that specifies where and how bot errors are recorded, including destinations like CloudWatch Logs.
enabled (boolean) --
Settings parameters for the error logs, when it is enabled.
{'resourceSpecification': {'botImportSpecification': {'errorLogSettings': {'enabled': 'boolean'}}}}
Gets information about a specific import.
See also: AWS API Documentation
Request Syntax
client.describe_import(
importId='string'
)
string
[REQUIRED]
The unique identifier of the import to describe.
dict
Response Syntax
{
'importId': 'string',
'resourceSpecification': {
'botImportSpecification': {
'botName': 'string',
'roleArn': 'string',
'dataPrivacy': {
'childDirected': True|False
},
'errorLogSettings': {
'enabled': True|False
},
'idleSessionTTLInSeconds': 123,
'botTags': {
'string': 'string'
},
'testBotAliasTags': {
'string': 'string'
}
},
'botLocaleImportSpecification': {
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'nluIntentConfidenceThreshold': 123.0,
'voiceSettings': {
'voiceId': 'string',
'engine': 'standard'|'neural'|'long-form'|'generative'
}
},
'customVocabularyImportSpecification': {
'botId': 'string',
'botVersion': 'string',
'localeId': 'string'
},
'testSetImportResourceSpecification': {
'testSetName': 'string',
'description': 'string',
'roleArn': 'string',
'storageLocation': {
's3BucketName': 'string',
's3Path': 'string',
'kmsKeyArn': 'string'
},
'importInputLocation': {
's3BucketName': 'string',
's3Path': 'string'
},
'modality': 'Text'|'Audio',
'testSetTags': {
'string': 'string'
}
}
},
'importedResourceId': 'string',
'importedResourceName': 'string',
'mergeStrategy': 'Overwrite'|'FailOnConflict'|'Append',
'importStatus': 'InProgress'|'Completed'|'Failed'|'Deleting',
'failureReasons': [
'string',
],
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
importId (string) --
The unique identifier of the described import.
resourceSpecification (dict) --
The specifications of the imported bot, bot locale, or custom vocabulary.
botImportSpecification (dict) --
Parameters for importing a bot.
botName (string) --
The name that Amazon Lex should use for the bot.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
dataPrivacy (dict) --
By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.
childDirected (boolean) --
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 true or false in the childDirected field. By specifying true in the childDirected field, you confirm that 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. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not 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 childDirected 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 Amazon Lex FAQ.
errorLogSettings (dict) --
Allows you to configure destinations where error logs will be published during the bot import process.
enabled (boolean) --
Settings parameters for the error logs, when it is enabled.
idleSessionTTLInSeconds (integer) --
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
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.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
botTags (dict) --
A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.
(string) --
(string) --
testBotAliasTags (dict) --
A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.
(string) --
(string) --
botLocaleImportSpecification (dict) --
Parameters for importing a bot locale.
botId (string) --
The identifier of the bot to import the locale to.
botVersion (string) --
The version of the bot to import the locale to. This can only be the DRAFT version of the bot.
localeId (string) --
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 Supported languages.
nluIntentConfidenceThreshold (float) --
Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.
For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the PostText operation would be:
AMAZON.FallbackIntent
IntentA
IntentB
IntentC
voiceSettings (dict) --
Defines settings for using an Amazon Polly voice to communicate with a user.
Valid values include:
standard
neural
long-form
generative
voiceId (string) --
The identifier of the Amazon Polly voice to use.
engine (string) --
Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.
If you do not specify a value, the default is standard.
customVocabularyImportSpecification (dict) --
Provides the parameters required for importing a custom vocabulary.
botId (string) --
The identifier of the bot to import the custom vocabulary to.
botVersion (string) --
The version of the bot to import the custom vocabulary to.
localeId (string) --
The identifier of the local to import the custom vocabulary to. The value must be en_GB.
testSetImportResourceSpecification (dict) --
Specifications for the test set that is imported.
testSetName (string) --
The name of the test set.
description (string) --
The description of the test set.
roleArn (string) --
The Amazon Resource Name (ARN) of an IAM role that has permission to access the test set.
storageLocation (dict) --
Contains information about the location that Amazon Lex uses to store the test-set.
s3BucketName (string) --
The name of the Amazon S3 bucket in which the test set is stored.
s3Path (string) --
The path inside the Amazon S3 bucket where the test set is stored.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.
importInputLocation (dict) --
Contains information about the input location from where test-set should be imported.
s3BucketName (string) --
The name of the Amazon S3 bucket.
s3Path (string) --
The path inside the Amazon S3 bucket pointing to the test-set CSV file.
modality (string) --
Specifies whether the test-set being imported contains written or spoken data.
testSetTags (dict) --
A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the UpdateTestSet operation to update tags. To update tags, use the TagResource operation.
(string) --
(string) --
importedResourceId (string) --
The unique identifier that Amazon Lex assigned to the resource created by the import.
importedResourceName (string) --
The name of the imported resource.
mergeStrategy (string) --
The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.
importStatus (string) --
The status of the import process. When the status is Completed the resource is imported and ready for use.
failureReasons (list) --
If the importStatus field is Failed, this provides one or more reasons for the failure.
(string) --
creationDateTime (datetime) --
The date and time that the import was created.
lastUpdatedDateTime (datetime) --
The date and time that the import was last updated.
{'qInConnectIntentConfiguration': {'qInConnectAssistantConfiguration': {'assistantArn': 'string'}}}
Returns metadata about an intent.
See also: AWS API Documentation
Request Syntax
client.describe_intent(
intentId='string',
botId='string',
botVersion='string',
localeId='string'
)
string
[REQUIRED]
The identifier of the intent to describe.
string
[REQUIRED]
The identifier of the bot associated with the intent.
string
[REQUIRED]
The version of the bot associated with the intent.
string
[REQUIRED]
The identifier of the language and locale of the intent to describe. The string must match one of the supported locales. For more information, see Supported languages.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'resourceSpecification': {'botImportSpecification': {'errorLogSettings': {'enabled': 'boolean'}}}}
Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.
See also: AWS API Documentation
Request Syntax
client.start_import(
importId='string',
resourceSpecification={
'botImportSpecification': {
'botName': 'string',
'roleArn': 'string',
'dataPrivacy': {
'childDirected': True|False
},
'errorLogSettings': {
'enabled': True|False
},
'idleSessionTTLInSeconds': 123,
'botTags': {
'string': 'string'
},
'testBotAliasTags': {
'string': 'string'
}
},
'botLocaleImportSpecification': {
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'nluIntentConfidenceThreshold': 123.0,
'voiceSettings': {
'voiceId': 'string',
'engine': 'standard'|'neural'|'long-form'|'generative'
}
},
'customVocabularyImportSpecification': {
'botId': 'string',
'botVersion': 'string',
'localeId': 'string'
},
'testSetImportResourceSpecification': {
'testSetName': 'string',
'description': 'string',
'roleArn': 'string',
'storageLocation': {
's3BucketName': 'string',
's3Path': 'string',
'kmsKeyArn': 'string'
},
'importInputLocation': {
's3BucketName': 'string',
's3Path': 'string'
},
'modality': 'Text'|'Audio',
'testSetTags': {
'string': 'string'
}
}
},
mergeStrategy='Overwrite'|'FailOnConflict'|'Append',
filePassword='string'
)
string
[REQUIRED]
The unique identifier for the import. It is included in the response from the CreateUploadUrl operation.
dict
[REQUIRED]
Parameters for creating the bot, bot locale or custom vocabulary.
botImportSpecification (dict) --
Parameters for importing a bot.
botName (string) -- [REQUIRED]
The name that Amazon Lex should use for the bot.
roleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
dataPrivacy (dict) -- [REQUIRED]
By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.
childDirected (boolean) -- [REQUIRED]
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 true or false in the childDirected field. By specifying true in the childDirected field, you confirm that 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. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not 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 childDirected 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 Amazon Lex FAQ.
errorLogSettings (dict) --
Allows you to configure destinations where error logs will be published during the bot import process.
enabled (boolean) -- [REQUIRED]
Settings parameters for the error logs, when it is enabled.
idleSessionTTLInSeconds (integer) --
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
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.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
botTags (dict) --
A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.
(string) --
(string) --
testBotAliasTags (dict) --
A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.
(string) --
(string) --
botLocaleImportSpecification (dict) --
Parameters for importing a bot locale.
botId (string) -- [REQUIRED]
The identifier of the bot to import the locale to.
botVersion (string) -- [REQUIRED]
The version of the bot to import the locale to. This can only be the DRAFT version of the bot.
localeId (string) -- [REQUIRED]
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 Supported languages.
nluIntentConfidenceThreshold (float) --
Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.
For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the PostText operation would be:
AMAZON.FallbackIntent
IntentA
IntentB
IntentC
voiceSettings (dict) --
Defines settings for using an Amazon Polly voice to communicate with a user.
Valid values include:
standard
neural
long-form
generative
voiceId (string) -- [REQUIRED]
The identifier of the Amazon Polly voice to use.
engine (string) --
Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.
If you do not specify a value, the default is standard.
customVocabularyImportSpecification (dict) --
Provides the parameters required for importing a custom vocabulary.
botId (string) -- [REQUIRED]
The identifier of the bot to import the custom vocabulary to.
botVersion (string) -- [REQUIRED]
The version of the bot to import the custom vocabulary to.
localeId (string) -- [REQUIRED]
The identifier of the local to import the custom vocabulary to. The value must be en_GB.
testSetImportResourceSpecification (dict) --
Specifications for the test set that is imported.
testSetName (string) -- [REQUIRED]
The name of the test set.
description (string) --
The description of the test set.
roleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of an IAM role that has permission to access the test set.
storageLocation (dict) -- [REQUIRED]
Contains information about the location that Amazon Lex uses to store the test-set.
s3BucketName (string) -- [REQUIRED]
The name of the Amazon S3 bucket in which the test set is stored.
s3Path (string) -- [REQUIRED]
The path inside the Amazon S3 bucket where the test set is stored.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.
importInputLocation (dict) -- [REQUIRED]
Contains information about the input location from where test-set should be imported.
s3BucketName (string) -- [REQUIRED]
The name of the Amazon S3 bucket.
s3Path (string) -- [REQUIRED]
The path inside the Amazon S3 bucket pointing to the test-set CSV file.
modality (string) -- [REQUIRED]
Specifies whether the test-set being imported contains written or spoken data.
testSetTags (dict) --
A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the UpdateTestSet operation to update tags. To update tags, use the TagResource operation.
(string) --
(string) --
string
[REQUIRED]
The strategy to use when there is a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.
string
The password used to encrypt the zip archive that contains the resource definition. You should always encrypt the zip archive to protect it during transit between your site and Amazon Lex.
dict
Response Syntax
{
'importId': 'string',
'resourceSpecification': {
'botImportSpecification': {
'botName': 'string',
'roleArn': 'string',
'dataPrivacy': {
'childDirected': True|False
},
'errorLogSettings': {
'enabled': True|False
},
'idleSessionTTLInSeconds': 123,
'botTags': {
'string': 'string'
},
'testBotAliasTags': {
'string': 'string'
}
},
'botLocaleImportSpecification': {
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'nluIntentConfidenceThreshold': 123.0,
'voiceSettings': {
'voiceId': 'string',
'engine': 'standard'|'neural'|'long-form'|'generative'
}
},
'customVocabularyImportSpecification': {
'botId': 'string',
'botVersion': 'string',
'localeId': 'string'
},
'testSetImportResourceSpecification': {
'testSetName': 'string',
'description': 'string',
'roleArn': 'string',
'storageLocation': {
's3BucketName': 'string',
's3Path': 'string',
'kmsKeyArn': 'string'
},
'importInputLocation': {
's3BucketName': 'string',
's3Path': 'string'
},
'modality': 'Text'|'Audio',
'testSetTags': {
'string': 'string'
}
}
},
'mergeStrategy': 'Overwrite'|'FailOnConflict'|'Append',
'importStatus': 'InProgress'|'Completed'|'Failed'|'Deleting',
'creationDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
importId (string) --
A unique identifier for the import.
resourceSpecification (dict) --
The parameters used when importing the resource.
botImportSpecification (dict) --
Parameters for importing a bot.
botName (string) --
The name that Amazon Lex should use for the bot.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
dataPrivacy (dict) --
By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.
childDirected (boolean) --
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 true or false in the childDirected field. By specifying true in the childDirected field, you confirm that 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. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not 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 childDirected 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 Amazon Lex FAQ.
errorLogSettings (dict) --
Allows you to configure destinations where error logs will be published during the bot import process.
enabled (boolean) --
Settings parameters for the error logs, when it is enabled.
idleSessionTTLInSeconds (integer) --
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
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.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
botTags (dict) --
A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.
(string) --
(string) --
testBotAliasTags (dict) --
A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.
(string) --
(string) --
botLocaleImportSpecification (dict) --
Parameters for importing a bot locale.
botId (string) --
The identifier of the bot to import the locale to.
botVersion (string) --
The version of the bot to import the locale to. This can only be the DRAFT version of the bot.
localeId (string) --
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 Supported languages.
nluIntentConfidenceThreshold (float) --
Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.
For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the PostText operation would be:
AMAZON.FallbackIntent
IntentA
IntentB
IntentC
voiceSettings (dict) --
Defines settings for using an Amazon Polly voice to communicate with a user.
Valid values include:
standard
neural
long-form
generative
voiceId (string) --
The identifier of the Amazon Polly voice to use.
engine (string) --
Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.
If you do not specify a value, the default is standard.
customVocabularyImportSpecification (dict) --
Provides the parameters required for importing a custom vocabulary.
botId (string) --
The identifier of the bot to import the custom vocabulary to.
botVersion (string) --
The version of the bot to import the custom vocabulary to.
localeId (string) --
The identifier of the local to import the custom vocabulary to. The value must be en_GB.
testSetImportResourceSpecification (dict) --
Specifications for the test set that is imported.
testSetName (string) --
The name of the test set.
description (string) --
The description of the test set.
roleArn (string) --
The Amazon Resource Name (ARN) of an IAM role that has permission to access the test set.
storageLocation (dict) --
Contains information about the location that Amazon Lex uses to store the test-set.
s3BucketName (string) --
The name of the Amazon S3 bucket in which the test set is stored.
s3Path (string) --
The path inside the Amazon S3 bucket where the test set is stored.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.
importInputLocation (dict) --
Contains information about the input location from where test-set should be imported.
s3BucketName (string) --
The name of the Amazon S3 bucket.
s3Path (string) --
The path inside the Amazon S3 bucket pointing to the test-set CSV file.
modality (string) --
Specifies whether the test-set being imported contains written or spoken data.
testSetTags (dict) --
A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the UpdateTestSet operation to update tags. To update tags, use the TagResource operation.
(string) --
(string) --
mergeStrategy (string) --
The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.
importStatus (string) --
The current status of the import. When the status is Complete the bot, bot alias, or custom vocabulary is ready to use.
creationDateTime (datetime) --
The date and time that the import request was created.
{'errorLogSettings': {'enabled': 'boolean'}}
Updates the configuration of an existing bot.
See also: AWS API Documentation
Request Syntax
client.update_bot(
botId='string',
botName='string',
description='string',
roleArn='string',
dataPrivacy={
'childDirected': True|False
},
idleSessionTTLInSeconds=123,
botType='Bot'|'BotNetwork',
botMembers=[
{
'botMemberId': 'string',
'botMemberName': 'string',
'botMemberAliasId': 'string',
'botMemberAliasName': 'string',
'botMemberVersion': 'string'
},
],
errorLogSettings={
'enabled': True|False
}
)
string
[REQUIRED]
The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.
string
[REQUIRED]
The new name of the bot. The name must be unique in the account that creates the bot.
string
A description of the bot.
string
[REQUIRED]
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.
dict
[REQUIRED]
Provides information on additional privacy protections Amazon Lex should use with the bot's data.
childDirected (boolean) -- [REQUIRED]
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 true or false in the childDirected field. By specifying true in the childDirected field, you confirm that 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. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not 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 childDirected 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 Amazon Lex FAQ.
integer
[REQUIRED]
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
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.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
string
The type of the bot to be updated.
list
The list of bot members in the network associated with the update action.
(dict) --
A bot that is a member of a network of bots.
botMemberId (string) -- [REQUIRED]
The unique ID of a bot that is a member of this network of bots.
botMemberName (string) -- [REQUIRED]
The unique name of a bot that is a member of this network of bots.
botMemberAliasId (string) -- [REQUIRED]
The alias ID of a bot that is a member of this network of bots.
botMemberAliasName (string) -- [REQUIRED]
The alias name of a bot that is a member of this network of bots.
botMemberVersion (string) -- [REQUIRED]
The version of a bot that is a member of this network of bots.
dict
Allows you to modify how Amazon Lex logs errors during bot interactions, including destinations for error logs and the types of errors to be captured.
enabled (boolean) -- [REQUIRED]
Settings parameters for the error logs, when it is enabled.
dict
Response Syntax
{
'botId': 'string',
'botName': 'string',
'description': 'string',
'roleArn': 'string',
'dataPrivacy': {
'childDirected': True|False
},
'idleSessionTTLInSeconds': 123,
'botStatus': 'Creating'|'Available'|'Inactive'|'Deleting'|'Failed'|'Versioning'|'Importing'|'Updating',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'botType': 'Bot'|'BotNetwork',
'botMembers': [
{
'botMemberId': 'string',
'botMemberName': 'string',
'botMemberAliasId': 'string',
'botMemberAliasName': 'string',
'botMemberVersion': 'string'
},
],
'errorLogSettings': {
'enabled': True|False
}
}
Response Structure
(dict) --
botId (string) --
The unique identifier of the bot that was updated.
botName (string) --
The name of the bot after the update.
description (string) --
The description of the bot after the update.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used by the bot after the update.
dataPrivacy (dict) --
The data privacy settings for the bot after the update.
childDirected (boolean) --
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 true or false in the childDirected field. By specifying true in the childDirected field, you confirm that 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. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not 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 childDirected 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 Amazon Lex FAQ.
idleSessionTTLInSeconds (integer) --
The session timeout, in seconds, for the bot after the update.
botStatus (string) --
Shows the current status of the bot. The bot is first in the Creating status. Once the bot is read for use, it changes to the Available status. After the bot is created, you can use the DRAFT version of the bot.
creationDateTime (datetime) --
A timestamp of the date and time that the bot was created.
lastUpdatedDateTime (datetime) --
A timestamp of the date and time that the bot was last updated.
botType (string) --
The type of the bot that was updated.
botMembers (list) --
The list of bot members in the network that was updated.
(dict) --
A bot that is a member of a network of bots.
botMemberId (string) --
The unique ID of a bot that is a member of this network of bots.
botMemberName (string) --
The unique name of a bot that is a member of this network of bots.
botMemberAliasId (string) --
The alias ID of a bot that is a member of this network of bots.
botMemberAliasName (string) --
The alias name of a bot that is a member of this network of bots.
botMemberVersion (string) --
The version of a bot that is a member of this network of bots.
errorLogSettings (dict) --
Settings for managing error logs within the response of an update bot operation.
enabled (boolean) --
Settings parameters for the error logs, when it is enabled.
{'qInConnectIntentConfiguration': {'qInConnectAssistantConfiguration': {'assistantArn': 'string'}}}
Updates the settings for an intent.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.