2022/08/22 - Amazon Lex Model Building V2 - 1 new 4 updated api methods
Changes This release introduces a new feature to stop a running BotRecommendation Job for Automated Chatbot Designer.
Stop an already running Bot Recommendation request.
See also: AWS API Documentation
Request Syntax
client.stop_bot_recommendation(
botId='string',
botVersion='string',
localeId='string',
botRecommendationId='string'
)
string
[REQUIRED]
The unique identifier of the bot containing the bot recommendation to be stopped.
string
[REQUIRED]
The version of the bot containing the bot recommendation.
string
[REQUIRED]
The identifier of the language and locale of the bot recommendation to stop. The string must match one of the supported locales. For more information, see Supported languages
string
[REQUIRED]
The unique identifier of the bot recommendation to be stopped.
dict
Response Syntax
{
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'botRecommendationStatus': 'Processing'|'Deleting'|'Deleted'|'Downloading'|'Updating'|'Available'|'Failed'|'Stopping'|'Stopped',
'botRecommendationId': 'string'
}
Response Structure
(dict) --
botId (string) --
The unique identifier of the bot containing the bot recommendation that is being stopped.
botVersion (string) --
The version of the bot containing the recommendation that is being stopped.
localeId (string) --
The identifier of the language and locale of the bot response to stop. The string must match one of the supported locales. For more information, see Supported languages
botRecommendationStatus (string) --
The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
botRecommendationId (string) --
The unique identifier of the bot recommendation that is being stopped.
{'botRecommendationStatus': {'Stopped', 'Stopping'}}
Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.
See also: AWS API Documentation
Request Syntax
client.describe_bot_recommendation(
botId='string',
botVersion='string',
localeId='string',
botRecommendationId='string'
)
string
[REQUIRED]
The unique identifier of the bot associated with the bot recommendation.
string
[REQUIRED]
The version of the bot associated with the bot recommendation.
string
[REQUIRED]
The identifier of the language and locale of the bot recommendation to describe. The string must match one of the supported locales. For more information, see Supported languages.
string
[REQUIRED]
The identifier of the bot recommendation to describe.
dict
Response Syntax
{
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'botRecommendationStatus': 'Processing'|'Deleting'|'Deleted'|'Downloading'|'Updating'|'Available'|'Failed'|'Stopping'|'Stopped',
'botRecommendationId': 'string',
'failureReasons': [
'string',
],
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'transcriptSourceSetting': {
's3BucketTranscriptSource': {
's3BucketName': 'string',
'pathFormat': {
'objectPrefixes': [
'string',
]
},
'transcriptFormat': 'Lex',
'transcriptFilter': {
'lexTranscriptFilter': {
'dateRangeFilter': {
'startDateTime': datetime(2015, 1, 1),
'endDateTime': datetime(2015, 1, 1)
}
}
},
'kmsKeyArn': 'string'
}
},
'encryptionSetting': {
'kmsKeyArn': 'string',
'botLocaleExportPassword': 'string',
'associatedTranscriptsPassword': 'string'
},
'botRecommendationResults': {
'botLocaleExportUrl': 'string',
'associatedTranscriptsUrl': 'string',
'statistics': {
'intents': {
'discoveredIntentCount': 123
},
'slotTypes': {
'discoveredSlotTypeCount': 123
}
}
}
}
Response Structure
(dict) --
botId (string) --
The identifier of the bot associated with the bot recommendation.
botVersion (string) --
The version of the bot associated with the bot recommendation.
localeId (string) --
The identifier of the language and locale of the bot recommendation to describe.
botRecommendationStatus (string) --
The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
botRecommendationId (string) --
The identifier of the bot recommendation being described.
failureReasons (list) --
If botRecommendationStatus is Failed, Amazon Lex explains why.
(string) --
creationDateTime (datetime) --
The date and time that the bot recommendation was created.
lastUpdatedDateTime (datetime) --
The date and time that the bot recommendation was last updated.
transcriptSourceSetting (dict) --
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
s3BucketTranscriptSource (dict) --
Indicates the setting of the Amazon S3 bucket where the transcript is stored.
s3BucketName (string) --
The name of the bucket containing the transcript and the associated metadata.
pathFormat (dict) --
The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.
objectPrefixes (list) --
A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3 bucket. Specify this list if you only want Lex to read the files under this set of sub-folders.
(string) --
transcriptFormat (string) --
The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.
transcriptFilter (dict) --
The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.
lexTranscriptFilter (dict) --
The object representing the filter that Amazon Lex will use to select the appropriate transcript when the transcript format is the Amazon Lex format.
dateRangeFilter (dict) --
The object that contains a date range filter that will be applied to the transcript. Specify this object if you want Amazon Lex to only read the files that are within the date range.
startDateTime (datetime) --
A timestamp indicating the start date for the date range filter.
endDateTime (datetime) --
A timestamp indicating the end date for the date range filter.
kmsKeyArn (string) --
The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.
encryptionSetting (dict) --
The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
kmsKeyArn (string) --
The KMS key ARN used to encrypt the metadata associated with the bot recommendation.
botLocaleExportPassword (string) --
The password used to encrypt the recommended bot recommendation file.
associatedTranscriptsPassword (string) --
The password used to encrypt the associated transcript file.
botRecommendationResults (dict) --
The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.
botLocaleExportUrl (string) --
The presigned URL link of the recommended bot definition.
associatedTranscriptsUrl (string) --
The presigned url link of the associated transcript.
statistics (dict) --
The statistical summary of the bot recommendation results.
intents (dict) --
Statistical information about about the intents associated with the bot recommendation results.
discoveredIntentCount (integer) --
The number of recommended intents associated with the bot recommendation.
slotTypes (dict) --
Statistical information about the slot types associated with the bot recommendation results.
discoveredSlotTypeCount (integer) --
The number of recommended slot types associated with the bot recommendation.
{'botRecommendationSummaries': {'botRecommendationStatus': {'Stopped',
'Stopping'}}}
Get a list of bot recommendations that meet the specified criteria.
See also: AWS API Documentation
Request Syntax
client.list_bot_recommendations(
botId='string',
botVersion='string',
localeId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The unique identifier of the bot that contains the bot recommendation list.
string
[REQUIRED]
The version of the bot that contains the bot recommendation list.
string
[REQUIRED]
The identifier of the language and locale of the bot recommendation list.
integer
The maximum number of bot recommendations 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.
string
If the response from the ListBotRecommendation operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
dict
Response Syntax
{
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'botRecommendationSummaries': [
{
'botRecommendationStatus': 'Processing'|'Deleting'|'Deleted'|'Downloading'|'Updating'|'Available'|'Failed'|'Stopping'|'Stopped',
'botRecommendationId': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
botId (string) --
The unique identifier of the bot that contains the bot recommendation list.
botVersion (string) --
The version of the bot that contains the bot recommendation list.
localeId (string) --
The identifier of the language and locale of the bot recommendation list.
botRecommendationSummaries (list) --
Summary information for the bot recommendations that meet the filter specified in this request. The length of the list is specified in the maxResults parameter of the request. If there are more bot recommendations available, the nextToken field contains a token to get the next page of results.
(dict) --
A summary of the bot recommendation.
botRecommendationStatus (string) --
The status of the bot recommendation.
If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
botRecommendationId (string) --
The unique identifier of the bot recommendation to be updated.
creationDateTime (datetime) --
A timestamp of the date and time that the bot recommendation was created.
lastUpdatedDateTime (datetime) --
A timestamp of the date and time that the bot recommendation was last updated.
nextToken (string) --
A token that indicates whether there are more results to return in a response to the ListBotRecommendations operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotRecommendations operation request to get the next page of results.
{'botRecommendationStatus': {'Stopped', 'Stopping'}}
Use this to provide your transcript data, and to start the bot recommendation process.
See also: AWS API Documentation
Request Syntax
client.start_bot_recommendation(
botId='string',
botVersion='string',
localeId='string',
transcriptSourceSetting={
's3BucketTranscriptSource': {
's3BucketName': 'string',
'pathFormat': {
'objectPrefixes': [
'string',
]
},
'transcriptFormat': 'Lex',
'transcriptFilter': {
'lexTranscriptFilter': {
'dateRangeFilter': {
'startDateTime': datetime(2015, 1, 1),
'endDateTime': datetime(2015, 1, 1)
}
}
},
'kmsKeyArn': 'string'
}
},
encryptionSetting={
'kmsKeyArn': 'string',
'botLocaleExportPassword': 'string',
'associatedTranscriptsPassword': 'string'
}
)
string
[REQUIRED]
The unique identifier of the bot containing the bot recommendation.
string
[REQUIRED]
The version of the bot containing the bot recommendation.
string
[REQUIRED]
The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages
dict
[REQUIRED]
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
s3BucketTranscriptSource (dict) --
Indicates the setting of the Amazon S3 bucket where the transcript is stored.
s3BucketName (string) -- [REQUIRED]
The name of the bucket containing the transcript and the associated metadata.
pathFormat (dict) --
The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.
objectPrefixes (list) --
A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3 bucket. Specify this list if you only want Lex to read the files under this set of sub-folders.
(string) --
transcriptFormat (string) -- [REQUIRED]
The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.
transcriptFilter (dict) --
The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.
lexTranscriptFilter (dict) --
The object representing the filter that Amazon Lex will use to select the appropriate transcript when the transcript format is the Amazon Lex format.
dateRangeFilter (dict) --
The object that contains a date range filter that will be applied to the transcript. Specify this object if you want Amazon Lex to only read the files that are within the date range.
startDateTime (datetime) -- [REQUIRED]
A timestamp indicating the start date for the date range filter.
endDateTime (datetime) -- [REQUIRED]
A timestamp indicating the end date for the date range filter.
kmsKeyArn (string) --
The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.
dict
The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
kmsKeyArn (string) --
The KMS key ARN used to encrypt the metadata associated with the bot recommendation.
botLocaleExportPassword (string) --
The password used to encrypt the recommended bot recommendation file.
associatedTranscriptsPassword (string) --
The password used to encrypt the associated transcript file.
dict
Response Syntax
{
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'botRecommendationStatus': 'Processing'|'Deleting'|'Deleted'|'Downloading'|'Updating'|'Available'|'Failed'|'Stopping'|'Stopped',
'botRecommendationId': 'string',
'creationDateTime': datetime(2015, 1, 1),
'transcriptSourceSetting': {
's3BucketTranscriptSource': {
's3BucketName': 'string',
'pathFormat': {
'objectPrefixes': [
'string',
]
},
'transcriptFormat': 'Lex',
'transcriptFilter': {
'lexTranscriptFilter': {
'dateRangeFilter': {
'startDateTime': datetime(2015, 1, 1),
'endDateTime': datetime(2015, 1, 1)
}
}
},
'kmsKeyArn': 'string'
}
},
'encryptionSetting': {
'kmsKeyArn': 'string',
'botLocaleExportPassword': 'string',
'associatedTranscriptsPassword': 'string'
}
}
Response Structure
(dict) --
botId (string) --
The unique identifier of the bot containing the bot recommendation.
botVersion (string) --
The version of the bot containing the bot recommendation.
localeId (string) --
The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages
botRecommendationStatus (string) --
The status of the bot recommendation.
If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
botRecommendationId (string) --
The identifier of the bot recommendation that you have created.
creationDateTime (datetime) --
A timestamp of the date and time that the bot recommendation was created.
transcriptSourceSetting (dict) --
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
s3BucketTranscriptSource (dict) --
Indicates the setting of the Amazon S3 bucket where the transcript is stored.
s3BucketName (string) --
The name of the bucket containing the transcript and the associated metadata.
pathFormat (dict) --
The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.
objectPrefixes (list) --
A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3 bucket. Specify this list if you only want Lex to read the files under this set of sub-folders.
(string) --
transcriptFormat (string) --
The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.
transcriptFilter (dict) --
The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.
lexTranscriptFilter (dict) --
The object representing the filter that Amazon Lex will use to select the appropriate transcript when the transcript format is the Amazon Lex format.
dateRangeFilter (dict) --
The object that contains a date range filter that will be applied to the transcript. Specify this object if you want Amazon Lex to only read the files that are within the date range.
startDateTime (datetime) --
A timestamp indicating the start date for the date range filter.
endDateTime (datetime) --
A timestamp indicating the end date for the date range filter.
kmsKeyArn (string) --
The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.
encryptionSetting (dict) --
The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
kmsKeyArn (string) --
The KMS key ARN used to encrypt the metadata associated with the bot recommendation.
botLocaleExportPassword (string) --
The password used to encrypt the recommended bot recommendation file.
associatedTranscriptsPassword (string) --
The password used to encrypt the associated transcript file.
{'botRecommendationStatus': {'Stopped', 'Stopping'}}
Updates an existing bot recommendation request.
See also: AWS API Documentation
Request Syntax
client.update_bot_recommendation(
botId='string',
botVersion='string',
localeId='string',
botRecommendationId='string',
encryptionSetting={
'kmsKeyArn': 'string',
'botLocaleExportPassword': 'string',
'associatedTranscriptsPassword': 'string'
}
)
string
[REQUIRED]
The unique identifier of the bot containing the bot recommendation to be updated.
string
[REQUIRED]
The version of the bot containing the bot recommendation to be updated.
string
[REQUIRED]
The identifier of the language and locale of the bot recommendation to update. The string must match one of the supported locales. For more information, see Supported languages
string
[REQUIRED]
The unique identifier of the bot recommendation to be updated.
dict
[REQUIRED]
The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
kmsKeyArn (string) --
The KMS key ARN used to encrypt the metadata associated with the bot recommendation.
botLocaleExportPassword (string) --
The password used to encrypt the recommended bot recommendation file.
associatedTranscriptsPassword (string) --
The password used to encrypt the associated transcript file.
dict
Response Syntax
{
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'botRecommendationStatus': 'Processing'|'Deleting'|'Deleted'|'Downloading'|'Updating'|'Available'|'Failed'|'Stopping'|'Stopped',
'botRecommendationId': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'transcriptSourceSetting': {
's3BucketTranscriptSource': {
's3BucketName': 'string',
'pathFormat': {
'objectPrefixes': [
'string',
]
},
'transcriptFormat': 'Lex',
'transcriptFilter': {
'lexTranscriptFilter': {
'dateRangeFilter': {
'startDateTime': datetime(2015, 1, 1),
'endDateTime': datetime(2015, 1, 1)
}
}
},
'kmsKeyArn': 'string'
}
},
'encryptionSetting': {
'kmsKeyArn': 'string',
'botLocaleExportPassword': 'string',
'associatedTranscriptsPassword': 'string'
}
}
Response Structure
(dict) --
botId (string) --
The unique identifier of the bot containing the bot recommendation that has been updated.
botVersion (string) --
The version of the bot containing the bot recommendation that has been updated.
localeId (string) --
The identifier of the language and locale of the bot recommendation to update. The string must match one of the supported locales. For more information, see Supported languages
botRecommendationStatus (string) --
The status of the bot recommendation.
If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
botRecommendationId (string) --
The unique identifier of the bot recommendation to be updated.
creationDateTime (datetime) --
A timestamp of the date and time that the bot recommendation was created.
lastUpdatedDateTime (datetime) --
A timestamp of the date and time that the bot recommendation was last updated.
transcriptSourceSetting (dict) --
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
s3BucketTranscriptSource (dict) --
Indicates the setting of the Amazon S3 bucket where the transcript is stored.
s3BucketName (string) --
The name of the bucket containing the transcript and the associated metadata.
pathFormat (dict) --
The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.
objectPrefixes (list) --
A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3 bucket. Specify this list if you only want Lex to read the files under this set of sub-folders.
(string) --
transcriptFormat (string) --
The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.
transcriptFilter (dict) --
The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.
lexTranscriptFilter (dict) --
The object representing the filter that Amazon Lex will use to select the appropriate transcript when the transcript format is the Amazon Lex format.
dateRangeFilter (dict) --
The object that contains a date range filter that will be applied to the transcript. Specify this object if you want Amazon Lex to only read the files that are within the date range.
startDateTime (datetime) --
A timestamp indicating the start date for the date range filter.
endDateTime (datetime) --
A timestamp indicating the end date for the date range filter.
kmsKeyArn (string) --
The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.
encryptionSetting (dict) --
The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
kmsKeyArn (string) --
The KMS key ARN used to encrypt the metadata associated with the bot recommendation.
botLocaleExportPassword (string) --
The password used to encrypt the recommended bot recommendation file.
associatedTranscriptsPassword (string) --
The password used to encrypt the associated transcript file.