AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Implementation for accessing LexModelBuildingService
Amazon Lex Build-Time ActionsAmazon 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.
Namespace: Amazon.LexModelBuildingService
Assembly: AWSSDK.LexModelBuildingService.dll
Version: 3.x.y.z
public class AmazonLexModelBuildingServiceClient : AmazonServiceClient IAmazonLexModelBuildingService, IAmazonService, IDisposable
The AmazonLexModelBuildingServiceClient type exposes the following members
Name | Description | |
---|---|---|
AmazonLexModelBuildingServiceClient() |
Constructs AmazonLexModelBuildingServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonLexModelBuildingServiceClient(RegionEndpoint) |
Constructs AmazonLexModelBuildingServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonLexModelBuildingServiceClient(AmazonLexModelBuildingServiceConfig) |
Constructs AmazonLexModelBuildingServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonLexModelBuildingServiceClient(AWSCredentials) |
Constructs AmazonLexModelBuildingServiceClient with AWS Credentials |
|
AmazonLexModelBuildingServiceClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonLexModelBuildingServiceClient with AWS Credentials |
|
AmazonLexModelBuildingServiceClient(AWSCredentials, AmazonLexModelBuildingServiceConfig) |
Constructs AmazonLexModelBuildingServiceClient with AWS Credentials and an AmazonLexModelBuildingServiceClient Configuration object. |
|
AmazonLexModelBuildingServiceClient(string, string) |
Constructs AmazonLexModelBuildingServiceClient with AWS Access Key ID and AWS Secret Key |
|
AmazonLexModelBuildingServiceClient(string, string, RegionEndpoint) |
Constructs AmazonLexModelBuildingServiceClient with AWS Access Key ID and AWS Secret Key |
|
AmazonLexModelBuildingServiceClient(string, string, AmazonLexModelBuildingServiceConfig) |
Constructs AmazonLexModelBuildingServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonLexModelBuildingServiceClient Configuration object. |
|
AmazonLexModelBuildingServiceClient(string, string, string) |
Constructs AmazonLexModelBuildingServiceClient with AWS Access Key ID and AWS Secret Key |
|
AmazonLexModelBuildingServiceClient(string, string, string, RegionEndpoint) |
Constructs AmazonLexModelBuildingServiceClient with AWS Access Key ID and AWS Secret Key |
|
AmazonLexModelBuildingServiceClient(string, string, string, AmazonLexModelBuildingServiceConfig) |
Constructs AmazonLexModelBuildingServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonLexModelBuildingServiceClient Configuration object. |
Name | Type | Description | |
---|---|---|---|
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. | |
Paginators | Amazon.LexModelBuildingService.Model.ILexModelBuildingServicePaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
CreateBotVersion(CreateBotVersionRequest) |
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 |
|
CreateBotVersionAsync(CreateBotVersionRequest, CancellationToken) |
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 |
|
CreateIntentVersion(CreateIntentVersionRequest) |
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 |
|
CreateIntentVersionAsync(CreateIntentVersionRequest, CancellationToken) |
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 |
|
CreateSlotTypeVersion(CreateSlotTypeVersionRequest) |
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 |
|
CreateSlotTypeVersionAsync(CreateSlotTypeVersionRequest, CancellationToken) |
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 |
|
DeleteBot(DeleteBotRequest) |
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 |
|
DeleteBotAlias(DeleteBotAliasRequest) |
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 |
|
DeleteBotAliasAsync(DeleteBotAliasRequest, CancellationToken) |
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 |
|
DeleteBotAsync(DeleteBotRequest, CancellationToken) |
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 |
|
DeleteBotChannelAssociation(DeleteBotChannelAssociationRequest) |
Deletes the association between an Amazon Lex bot and a messaging platform.
This operation requires permission for the |
|
DeleteBotChannelAssociationAsync(DeleteBotChannelAssociationRequest, CancellationToken) |
Deletes the association between an Amazon Lex bot and a messaging platform.
This operation requires permission for the |
|
DeleteBotVersion(DeleteBotVersionRequest) |
Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.
This operation requires permissions for the |
|
DeleteBotVersionAsync(DeleteBotVersionRequest, CancellationToken) |
Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.
This operation requires permissions for the |
|
DeleteIntent(DeleteIntentRequest) |
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 |
|
DeleteIntentAsync(DeleteIntentRequest, CancellationToken) |
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 |
|
DeleteIntentVersion(DeleteIntentVersionRequest) |
Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation.
This operation requires permissions for the |
|
DeleteIntentVersionAsync(DeleteIntentVersionRequest, CancellationToken) |
Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation.
This operation requires permissions for the |
|
DeleteSlotType(DeleteSlotTypeRequest) |
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 |
|
DeleteSlotTypeAsync(DeleteSlotTypeRequest, CancellationToken) |
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 |
|
DeleteSlotTypeVersion(DeleteSlotTypeVersionRequest) |
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 |
|
DeleteSlotTypeVersionAsync(DeleteSlotTypeVersionRequest, CancellationToken) |
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 |
|
DeleteUtterances(DeleteUtterancesRequest) |
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 |
|
DeleteUtterancesAsync(DeleteUtterancesRequest, CancellationToken) |
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 |
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. | |
GetBot(GetBotRequest) |
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 |
|
GetBotAlias(GetBotAliasRequest) |
Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases.
This operation requires permissions for the |
|
GetBotAliasAsync(GetBotAliasRequest, CancellationToken) |
Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases.
This operation requires permissions for the |
|
GetBotAliases(GetBotAliasesRequest) |
Returns a list of aliases for a specified Amazon Lex bot.
This operation requires permissions for the |
|
GetBotAliasesAsync(GetBotAliasesRequest, CancellationToken) |
Returns a list of aliases for a specified Amazon Lex bot.
This operation requires permissions for the |
|
GetBotAsync(GetBotRequest, CancellationToken) |
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 |
|
GetBotChannelAssociation(GetBotChannelAssociationRequest) |
Returns information about the association between an Amazon Lex bot and a messaging platform.
This operation requires permissions for the |
|
GetBotChannelAssociationAsync(GetBotChannelAssociationRequest, CancellationToken) |
Returns information about the association between an Amazon Lex bot and a messaging platform.
This operation requires permissions for the |
|
GetBotChannelAssociations(GetBotChannelAssociationsRequest) |
Returns a list of all of the channels associated with the specified bot.
The |
|
GetBotChannelAssociationsAsync(GetBotChannelAssociationsRequest, CancellationToken) |
Returns a list of all of the channels associated with the specified bot.
The |
|
GetBots(GetBotsRequest) |
Returns bot information as follows:
This operation requires permission for the |
|
GetBotsAsync(GetBotsRequest, CancellationToken) |
Returns bot information as follows:
This operation requires permission for the |
|
GetBotVersions(GetBotVersionsRequest) |
Gets information about all of the versions of a bot.
The
The
This operation requires permissions for the |
|
GetBotVersionsAsync(GetBotVersionsRequest, CancellationToken) |
Gets information about all of the versions of a bot.
The
The
This operation requires permissions for the |
|
GetBuiltinIntent(GetBuiltinIntentRequest) |
Returns information about a built-in intent.
This operation requires permission for the |
|
GetBuiltinIntentAsync(GetBuiltinIntentRequest, CancellationToken) |
Returns information about a built-in intent.
This operation requires permission for the |
|
GetBuiltinIntents(GetBuiltinIntentsRequest) |
Gets a list of built-in intents that meet the specified criteria.
This operation requires permission for the |
|
GetBuiltinIntentsAsync(GetBuiltinIntentsRequest, CancellationToken) |
Gets a list of built-in intents that meet the specified criteria.
This operation requires permission for the |
|
GetBuiltinSlotTypes(GetBuiltinSlotTypesRequest) |
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 |
|
GetBuiltinSlotTypesAsync(GetBuiltinSlotTypesRequest, CancellationToken) |
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 |
|
GetExport(GetExportRequest) |
Exports the contents of a Amazon Lex resource in a specified format. |
|
GetExportAsync(GetExportRequest, CancellationToken) |
Exports the contents of a Amazon Lex resource in a specified format. |
|
GetImport(GetImportRequest) |
Gets information about an import job started with the |
|
GetImportAsync(GetImportRequest, CancellationToken) |
Gets information about an import job started with the |
|
GetIntent(GetIntentRequest) |
Returns information about an intent. In addition to the intent name, you must specify the intent version.
This operation requires permissions to perform the |
|
GetIntentAsync(GetIntentRequest, CancellationToken) |
Returns information about an intent. In addition to the intent name, you must specify the intent version.
This operation requires permissions to perform the |
|
GetIntents(GetIntentsRequest) |
Returns intent information as follows:
The operation requires permission for the |
|
GetIntentsAsync(GetIntentsRequest, CancellationToken) |
Returns intent information as follows:
The operation requires permission for the |
|
GetIntentVersions(GetIntentVersionsRequest) |
Gets information about all of the versions of an intent.
The
The
This operation requires permissions for the |
|
GetIntentVersionsAsync(GetIntentVersionsRequest, CancellationToken) |
Gets information about all of the versions of an intent.
The
The
This operation requires permissions for the |
|
GetMigration(GetMigrationRequest) |
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. |
|
GetMigrationAsync(GetMigrationRequest, CancellationToken) |
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. |
|
GetMigrations(GetMigrationsRequest) |
Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2. |
|
GetMigrationsAsync(GetMigrationsRequest, CancellationToken) |
Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2. |
|
GetSlotType(GetSlotTypeRequest) |
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 |
|
GetSlotTypeAsync(GetSlotTypeRequest, CancellationToken) |
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 |
|
GetSlotTypes(GetSlotTypesRequest) |
Returns slot type information as follows:
The operation requires permission for the |
|
GetSlotTypesAsync(GetSlotTypesRequest, CancellationToken) |
Returns slot type information as follows:
The operation requires permission for the |
|
GetSlotTypeVersions(GetSlotTypeVersionsRequest) |
Gets information about all versions of a slot type.
The
The
This operation requires permissions for the |
|
GetSlotTypeVersionsAsync(GetSlotTypeVersionsRequest, CancellationToken) |
Gets information about all versions of a slot type.
The
The
This operation requires permissions for the |
|
GetUtterancesView(GetUtterancesViewRequest) |
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 |
|
GetUtterancesViewAsync(GetUtterancesViewRequest, CancellationToken) |
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 |
|
ListTagsForResource(ListTagsForResourceRequest) |
Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them. |
|
ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken) |
Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them. |
|
PutBot(PutBotRequest) |
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 |
|
PutBotAlias(PutBotAliasRequest) |
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 |
|
PutBotAliasAsync(PutBotAliasRequest, CancellationToken) |
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 |
|
PutBotAsync(PutBotRequest, CancellationToken) |
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 |
|
PutIntent(PutIntentRequest) |
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 |
|
PutIntentAsync(PutIntentRequest, CancellationToken) |
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 |
|
PutSlotType(PutSlotTypeRequest) |
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 |
|
PutSlotTypeAsync(PutSlotTypeRequest, CancellationToken) |
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 |
|
StartImport(StartImportRequest) |
Starts a job to import a resource to Amazon Lex. |
|
StartImportAsync(StartImportRequest, CancellationToken) |
Starts a job to import a resource to Amazon Lex. |
|
StartMigration(StartMigrationRequest) |
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. |
|
StartMigrationAsync(StartMigrationRequest, CancellationToken) |
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. |
|
TagResource(TagResourceRequest) |
Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value. |
|
TagResourceAsync(TagResourceRequest, CancellationToken) |
Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value. |
|
UntagResource(UntagResourceRequest) |
Removes tags from a bot, bot alias or bot channel. |
|
UntagResourceAsync(UntagResourceRequest, CancellationToken) |
Removes tags from a bot, bot alias or bot channel. |
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5