- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
LexModelBuildingServiceClient
Amazon Lex is an AWS service for building conversational voice and text interfaces. Use these actions to create, update, and delete conversational bots for new and existing client applications.
Installation
npm install @aws-sdk/client-lex-model-building-service
yarn add @aws-sdk/client-lex-model-building-service
pnpm add @aws-sdk/client-lex-model-building-service
LexModelBuildingServiceClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CreateBotVersionCommand | Creates a new version of the bot based on the You can update only the When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permission for the |
CreateIntentVersionCommand | Creates a new version of an intent based on the You can update only the When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permissions to perform the |
CreateSlotTypeVersionCommand | Creates a new version of a slot type based on the You can update only the When you create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permissions for the |
DeleteBotAliasCommand | Deletes an alias for the specified bot. You can't delete an alias that is used in the association between a bot and a messaging channel. If an alias is used in a channel association, the |
DeleteBotChannelAssociationCommand | Deletes the association between an Amazon Lex bot and a messaging platform. This operation requires permission for the |
DeleteBotCommand | Deletes all versions of the bot, including the Amazon Lex stores utterances indefinitely for improving the ability of your bot to respond to user inputs. These utterances are not removed when the bot is deleted. To remove the utterances, use the DeleteUtterances operation. If a bot has an alias, you can't delete it. Instead, the This operation requires permissions for the |
DeleteBotVersionCommand | Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation. This operation requires permissions for the |
DeleteIntentCommand | Deletes all versions of the intent, including the You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see how-it-works), you must remove those references first. If you get the This operation requires permission for the |
DeleteIntentVersionCommand | Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation. This operation requires permissions for the |
DeleteSlotTypeCommand | Deletes all versions of the slot type, including the You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first. If you get the This operation requires permission for the |
DeleteSlotTypeVersionCommand | Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation. This operation requires permissions for the |
DeleteUtterancesCommand | Deletes stored utterances. Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input. Use the This operation requires permissions for the |
GetBotAliasCommand | Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases. This operation requires permissions for the |
GetBotAliasesCommand | Returns a list of aliases for a specified Amazon Lex bot. This operation requires permissions for the |
GetBotChannelAssociationCommand | Returns information about the association between an Amazon Lex bot and a messaging platform. This operation requires permissions for the |
GetBotChannelAssociationsCommand | Returns a list of all of the channels associated with the specified bot. The |
GetBotCommand | Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias. This operation requires permissions for the |
GetBotVersionsCommand | Gets information about all of the versions of a bot. The The This operation requires permissions for the |
GetBotsCommand | Returns bot information as follows:
This operation requires permission for the |
GetBuiltinIntentCommand | Returns information about a built-in intent. This operation requires permission for the |
GetBuiltinIntentsCommand | Gets a list of built-in intents that meet the specified criteria. This operation requires permission for the |
GetBuiltinSlotTypesCommand | Gets a list of built-in slot types that meet the specified criteria. For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit. This operation requires permission for the |
GetExportCommand | Exports the contents of a Amazon Lex resource in a specified format. |
GetImportCommand | Gets information about an import job started with the |
GetIntentCommand | Returns information about an intent. In addition to the intent name, you must specify the intent version. This operation requires permissions to perform the |
GetIntentVersionsCommand | Gets information about all of the versions of an intent. The The This operation requires permissions for the |
GetIntentsCommand | Returns intent information as follows:
The operation requires permission for the |
GetMigrationCommand | Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot. Use this operation to view the migration alerts and warnings related to the migration. |
GetMigrationsCommand | Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2. |
GetSlotTypeCommand | Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version. This operation requires permissions for the |
GetSlotTypeVersionsCommand | Gets information about all versions of a slot type. The The This operation requires permissions for the |
GetSlotTypesCommand | Returns slot type information as follows:
The operation requires permission for the |
GetUtterancesViewCommand | Use the For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions. Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions of your bot in each request. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. The response contains information about a maximum of 100 utterances for each version. If you set This operation requires permissions for the |
ListTagsForResourceCommand | Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them. |
PutBotAliasCommand | Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see versioning-aliases. This operation requires permissions for the |
PutBotCommand | Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the If you specify the name of an existing bot, the fields in the request replace the existing values in the This operation requires permissions for the |
PutIntentCommand | Creates an intent or replaces an existing intent. To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot, for example, you would create an To create an intent or replace an existing intent, you must provide the following:
You can specify other optional information in the request, such as:
If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the For more information, see how-it-works. This operation requires permissions for the |
PutSlotTypeCommand | Creates a custom slot type or replaces an existing custom slot type. To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see how-it-works. If you specify the name of an existing slot type, the fields in the request replace the existing values in the This operation requires permissions for the |
StartImportCommand | Starts a job to import a resource to Amazon Lex. |
StartMigrationCommand | Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your bot when you want to take advantage of the new features of Amazon Lex V2. For more information, see Migrating a bot in the Amazon Lex developer guide. |
TagResourceCommand | Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value. |
UntagResourceCommand | Removes tags from a bot, bot alias or bot channel. |
LexModelBuildingServiceClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: LexModelBuildingServiceClientConfig