Class: Aws::LexModelBuildingService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::LexModelBuildingService::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb
Overview
An API client for LexModelBuildingService. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::LexModelBuildingService::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_bot_version(params = {}) ⇒ Types::CreateBotVersionResponse
Creates a new version of the bot based on the
$LATEST
version. -
#create_intent_version(params = {}) ⇒ Types::CreateIntentVersionResponse
Creates a new version of an intent based on the
$LATEST
version of the intent. -
#create_slot_type_version(params = {}) ⇒ Types::CreateSlotTypeVersionResponse
Creates a new version of a slot type based on the
$LATEST
version of the specified slot type. -
#delete_bot(params = {}) ⇒ Struct
Deletes all versions of the bot, including the
$LATEST
version. -
#delete_bot_alias(params = {}) ⇒ Struct
Deletes an alias for the specified bot.
-
#delete_bot_channel_association(params = {}) ⇒ Struct
Deletes the association between an Amazon Lex bot and a messaging platform.
-
#delete_bot_version(params = {}) ⇒ Struct
Deletes a specific version of a bot.
-
#delete_intent(params = {}) ⇒ Struct
Deletes all versions of the intent, including the
$LATEST
version. -
#delete_intent_version(params = {}) ⇒ Struct
Deletes a specific version of an intent.
-
#delete_slot_type(params = {}) ⇒ Struct
Deletes all versions of the slot type, including the
$LATEST
version. -
#delete_slot_type_version(params = {}) ⇒ Struct
Deletes a specific version of a slot type.
-
#delete_utterances(params = {}) ⇒ Struct
Deletes stored utterances.
-
#get_bot(params = {}) ⇒ Types::GetBotResponse
Returns metadata information for a specific bot.
-
#get_bot_alias(params = {}) ⇒ Types::GetBotAliasResponse
Returns information about an Amazon Lex bot alias.
-
#get_bot_aliases(params = {}) ⇒ Types::GetBotAliasesResponse
Returns a list of aliases for a specified Amazon Lex bot.
-
#get_bot_channel_association(params = {}) ⇒ Types::GetBotChannelAssociationResponse
Returns information about the association between an Amazon Lex bot and a messaging platform.
-
#get_bot_channel_associations(params = {}) ⇒ Types::GetBotChannelAssociationsResponse
Returns a list of all of the channels associated with the specified bot.
-
#get_bot_versions(params = {}) ⇒ Types::GetBotVersionsResponse
Gets information about all of the versions of a bot.
-
#get_bots(params = {}) ⇒ Types::GetBotsResponse
Returns bot information as follows:.
-
#get_builtin_intent(params = {}) ⇒ Types::GetBuiltinIntentResponse
Returns information about a built-in intent.
-
#get_builtin_intents(params = {}) ⇒ Types::GetBuiltinIntentsResponse
Gets a list of built-in intents that meet the specified criteria.
-
#get_builtin_slot_types(params = {}) ⇒ Types::GetBuiltinSlotTypesResponse
Gets a list of built-in slot types that meet the specified criteria.
-
#get_export(params = {}) ⇒ Types::GetExportResponse
Exports the contents of a Amazon Lex resource in a specified format.
-
#get_import(params = {}) ⇒ Types::GetImportResponse
Gets information about an import job started with the
StartImport
operation. -
#get_intent(params = {}) ⇒ Types::GetIntentResponse
Returns information about an intent.
-
#get_intent_versions(params = {}) ⇒ Types::GetIntentVersionsResponse
Gets information about all of the versions of an intent.
-
#get_intents(params = {}) ⇒ Types::GetIntentsResponse
Returns intent information as follows:.
-
#get_migration(params = {}) ⇒ Types::GetMigrationResponse
Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot.
-
#get_migrations(params = {}) ⇒ Types::GetMigrationsResponse
Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.
-
#get_slot_type(params = {}) ⇒ Types::GetSlotTypeResponse
Returns information about a specific version of a slot type.
-
#get_slot_type_versions(params = {}) ⇒ Types::GetSlotTypeVersionsResponse
Gets information about all versions of a slot type.
-
#get_slot_types(params = {}) ⇒ Types::GetSlotTypesResponse
Returns slot type information as follows:.
-
#get_utterances_view(params = {}) ⇒ Types::GetUtterancesViewResponse
Use the
GetUtterancesView
operation to get information about the utterances that your users have made to your bot. -
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets a list of tags associated with the specified resource.
-
#put_bot(params = {}) ⇒ Types::PutBotResponse
Creates an Amazon Lex conversational bot or replaces an existing bot.
-
#put_bot_alias(params = {}) ⇒ Types::PutBotAliasResponse
Creates an alias for the specified version of the bot or replaces an alias for the specified bot.
-
#put_intent(params = {}) ⇒ Types::PutIntentResponse
Creates an intent or replaces an existing intent.
-
#put_slot_type(params = {}) ⇒ Types::PutSlotTypeResponse
Creates a custom slot type or replaces an existing custom slot type.
-
#start_import(params = {}) ⇒ Types::StartImportResponse
Starts a job to import a resource to Amazon Lex.
-
#start_migration(params = {}) ⇒ Types::StartMigrationResponse
Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2.
-
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a bot, bot alias or bot channel.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
446 447 448 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 446 def initialize(*args) super end |
Instance Method Details
#create_bot_version(params = {}) ⇒ Types::CreateBotVersionResponse
Creates a new version of the bot based on the $LATEST
version. If
the $LATEST
version of this resource hasn't changed since you
created the last version, Amazon Lex doesn't create a new version. It
returns the last created version.
$LATEST
version of the bot. You can't
update the numbered versions that you create with the
CreateBotVersion
operation.
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 lex:CreateBotVersion
action.
543 544 545 546 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 543 def create_bot_version(params = {}, = {}) req = build_request(:create_bot_version, params) req.send_request() end |
#create_intent_version(params = {}) ⇒ Types::CreateIntentVersionResponse
Creates a new version of an intent based on the $LATEST
version of
the intent. If the $LATEST
version of this intent hasn't changed
since you last updated it, Amazon Lex doesn't create a new version.
It returns the last version you created.
$LATEST
version of the intent. You can't
update the numbered versions that you create with the
CreateIntentVersion
operation.
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
lex:CreateIntentVersion
action.
682 683 684 685 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 682 def create_intent_version(params = {}, = {}) req = build_request(:create_intent_version, params) req.send_request() end |
#create_slot_type_version(params = {}) ⇒ Types::CreateSlotTypeVersionResponse
Creates a new version of a slot type based on the $LATEST
version of
the specified slot type. If the $LATEST
version of this resource has
not changed since the last version that you created, Amazon Lex
doesn't create a new version. It returns the last version that you
created.
$LATEST
version of a slot type. You can't
update the numbered versions that you create with the
CreateSlotTypeVersion
operation.
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
lex:CreateSlotTypeVersion
action.
759 760 761 762 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 759 def create_slot_type_version(params = {}, = {}) req = build_request(:create_slot_type_version, params) req.send_request() end |
#delete_bot(params = {}) ⇒ Struct
Deletes all versions of the bot, including the $LATEST
version. To
delete a specific version of the bot, use the DeleteBotVersion
operation. The DeleteBot
operation doesn't immediately remove the
bot schema. Instead, it is marked for deletion and removed later.
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 DeleteBot
operation returns a ResourceInUseException
exception that includes a
reference to the alias that refers to the bot. To remove the reference
to the bot, delete the alias. If you get the same exception again,
delete the referring alias until the DeleteBot
operation is
successful.
This operation requires permissions for the lex:DeleteBot
action.
798 799 800 801 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 798 def delete_bot(params = {}, = {}) req = build_request(:delete_bot, params) req.send_request() end |
#delete_bot_alias(params = {}) ⇒ Struct
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 DeleteBot
operation returns a
ResourceInUseException
exception that includes a reference to the
channel association that refers to the bot. You can remove the
reference to the alias by deleting the channel association. If you get
the same exception again, delete the referring association until the
DeleteBotAlias
operation is successful.
833 834 835 836 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 833 def delete_bot_alias(params = {}, = {}) req = build_request(:delete_bot_alias, params) req.send_request() end |
#delete_bot_channel_association(params = {}) ⇒ Struct
Deletes the association between an Amazon Lex bot and a messaging platform.
This operation requires permission for the
lex:DeleteBotChannelAssociation
action.
868 869 870 871 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 868 def delete_bot_channel_association(params = {}, = {}) req = build_request(:delete_bot_channel_association, params) req.send_request() end |
#delete_bot_version(params = {}) ⇒ Struct
Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.
This operation requires permissions for the lex:DeleteBotVersion
action.
900 901 902 903 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 900 def delete_bot_version(params = {}, = {}) req = build_request(:delete_bot_version, params) req.send_request() end |
#delete_intent(params = {}) ⇒ Struct
Deletes all versions of the intent, including the $LATEST
version.
To delete a specific version of the intent, use the
DeleteIntentVersion operation.
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.
ResourceInUseException
exception, it provides an
example reference that shows where the intent is referenced. To remove
the reference to the intent, either update the bot or delete it. If
you get the same exception when you attempt to delete the intent
again, repeat until the intent has no references and the call to
DeleteIntent
is successful.
This operation requires permission for the lex:DeleteIntent
action.
939 940 941 942 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 939 def delete_intent(params = {}, = {}) req = build_request(:delete_intent, params) req.send_request() end |
#delete_intent_version(params = {}) ⇒ Struct
Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation.
This operation requires permissions for the lex:DeleteIntentVersion
action.
971 972 973 974 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 971 def delete_intent_version(params = {}, = {}) req = build_request(:delete_intent_version, params) req.send_request() end |
#delete_slot_type(params = {}) ⇒ Struct
Deletes all versions of the slot type, including the $LATEST
version. To delete a specific version of the slot type, use the
DeleteSlotTypeVersion operation.
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.
ResourceInUseException
exception, the exception
provides an example reference that shows the intent where the slot
type is referenced. To remove the reference to the slot type, either
update the intent or delete it. If you get the same exception when you
attempt to delete the slot type again, repeat until the slot type has
no references and the DeleteSlotType
call is successful.
This operation requires permission for the lex:DeleteSlotType
action.
1011 1012 1013 1014 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1011 def delete_slot_type(params = {}, = {}) req = build_request(:delete_slot_type, params) req.send_request() end |
#delete_slot_type_version(params = {}) ⇒ Struct
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
lex:DeleteSlotTypeVersion
action.
1043 1044 1045 1046 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1043 def delete_slot_type_version(params = {}, = {}) req = build_request(:delete_slot_type_version, params) req.send_request() end |
#delete_utterances(params = {}) ⇒ Struct
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 DeleteUtterances
operation to manually delete stored
utterances for a specific user. When you use the DeleteUtterances
operation, utterances stored for improving your bot's ability to
respond to user input are deleted immediately. Utterances stored for
use with the GetUtterancesView
operation are deleted after 15 days.
This operation requires permissions for the lex:DeleteUtterances
action.
1090 1091 1092 1093 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1090 def delete_utterances(params = {}, = {}) req = build_request(:delete_utterances, params) req.send_request() end |
#get_bot(params = {}) ⇒ Types::GetBotResponse
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 lex:GetBot
action.
1225 1226 1227 1228 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1225 def get_bot(params = {}, = {}) req = build_request(:get_bot, params) req.send_request() end |
#get_bot_alias(params = {}) ⇒ Types::GetBotAliasResponse
Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases.
This operation requires permissions for the lex:GetBotAlias
action.
1280 1281 1282 1283 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1280 def get_bot_alias(params = {}, = {}) req = build_request(:get_bot_alias, params) req.send_request() end |
#get_bot_aliases(params = {}) ⇒ Types::GetBotAliasesResponse
Returns a list of aliases for a specified Amazon Lex bot.
This operation requires permissions for the lex:GetBotAliases
action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1347 1348 1349 1350 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1347 def get_bot_aliases(params = {}, = {}) req = build_request(:get_bot_aliases, params) req.send_request() end |
#get_bot_channel_association(params = {}) ⇒ Types::GetBotChannelAssociationResponse
Returns information about the association between an Amazon Lex bot and a messaging platform.
This operation requires permissions for the
lex:GetBotChannelAssociation
action.
1406 1407 1408 1409 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1406 def get_bot_channel_association(params = {}, = {}) req = build_request(:get_bot_channel_association, params) req.send_request() end |
#get_bot_channel_associations(params = {}) ⇒ Types::GetBotChannelAssociationsResponse
Returns a list of all of the channels associated with the specified bot.
The GetBotChannelAssociations
operation requires permissions for the
lex:GetBotChannelAssociations
action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1477 1478 1479 1480 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1477 def get_bot_channel_associations(params = {}, = {}) req = build_request(:get_bot_channel_associations, params) req.send_request() end |
#get_bot_versions(params = {}) ⇒ Types::GetBotVersionsResponse
Gets information about all of the versions of a bot.
The GetBotVersions
operation returns a BotMetadata
object for each
version of a bot. For example, if a bot has three numbered versions,
the GetBotVersions
operation returns four BotMetadata
objects in
the response, one for each numbered version and one for the $LATEST
version.
The GetBotVersions
operation always returns at least one version,
the $LATEST
version.
This operation requires permissions for the lex:GetBotVersions
action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1539 1540 1541 1542 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1539 def get_bot_versions(params = {}, = {}) req = build_request(:get_bot_versions, params) req.send_request() end |
#get_bots(params = {}) ⇒ Types::GetBotsResponse
Returns bot information as follows:
If you provide the
nameContains
field, the response includes information for the$LATEST
version of all bots whose name contains the specified string.If you don't specify the
nameContains
field, the operation returns information about the$LATEST
version of all of your bots.
This operation requires permission for the lex:GetBots
action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1624 1625 1626 1627 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1624 def get_bots(params = {}, = {}) req = build_request(:get_bots, params) req.send_request() end |
#get_builtin_intent(params = {}) ⇒ Types::GetBuiltinIntentResponse
Returns information about a built-in intent.
This operation requires permission for the lex:GetBuiltinIntent
action.
1667 1668 1669 1670 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1667 def get_builtin_intent(params = {}, = {}) req = build_request(:get_builtin_intent, params) req.send_request() end |
#get_builtin_intents(params = {}) ⇒ Types::GetBuiltinIntentsResponse
Gets a list of built-in intents that meet the specified criteria.
This operation requires permission for the lex:GetBuiltinIntents
action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1729 1730 1731 1732 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1729 def get_builtin_intents(params = {}, = {}) req = build_request(:get_builtin_intents, params) req.send_request() end |
#get_builtin_slot_types(params = {}) ⇒ Types::GetBuiltinSlotTypesResponse
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 lex:GetBuiltInSlotTypes
action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1792 1793 1794 1795 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1792 def get_builtin_slot_types(params = {}, = {}) req = build_request(:get_builtin_slot_types, params) req.send_request() end |
#get_export(params = {}) ⇒ Types::GetExportResponse
Exports the contents of a Amazon Lex resource in a specified format.
1844 1845 1846 1847 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1844 def get_export(params = {}, = {}) req = build_request(:get_export, params) req.send_request() end |
#get_import(params = {}) ⇒ Types::GetImportResponse
Gets information about an import job started with the StartImport
operation.
1886 1887 1888 1889 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1886 def get_import(params = {}, = {}) req = build_request(:get_import, params) req.send_request() end |
#get_intent(params = {}) ⇒ Types::GetIntentResponse
Returns information about an intent. In addition to the intent name, you must specify the intent version.
This operation requires permissions to perform the lex:GetIntent
action.
2152 2153 2154 2155 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2152 def get_intent(params = {}, = {}) req = build_request(:get_intent, params) req.send_request() end |
#get_intent_versions(params = {}) ⇒ Types::GetIntentVersionsResponse
Gets information about all of the versions of an intent.
The GetIntentVersions
operation returns an IntentMetadata
object
for each version of an intent. For example, if an intent has three
numbered versions, the GetIntentVersions
operation returns four
IntentMetadata
objects in the response, one for each numbered
version and one for the $LATEST
version.
The GetIntentVersions
operation always returns at least one version,
the $LATEST
version.
This operation requires permissions for the lex:GetIntentVersions
action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2213 2214 2215 2216 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2213 def get_intent_versions(params = {}, = {}) req = build_request(:get_intent_versions, params) req.send_request() end |
#get_intents(params = {}) ⇒ Types::GetIntentsResponse
Returns intent information as follows:
If you specify the
nameContains
field, returns the$LATEST
version of all intents that contain the specified string.If you don't specify the
nameContains
field, returns information about the$LATEST
version of all intents.
The operation requires permission for the lex:GetIntents
action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2295 2296 2297 2298 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2295 def get_intents(params = {}, = {}) req = build_request(:get_intents, params) req.send_request() end |
#get_migration(params = {}) ⇒ Types::GetMigrationResponse
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.
2350 2351 2352 2353 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2350 def get_migration(params = {}, = {}) req = build_request(:get_migration, params) req.send_request() end |
#get_migrations(params = {}) ⇒ Types::GetMigrationsResponse
Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2418 2419 2420 2421 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2418 def get_migrations(params = {}, = {}) req = build_request(:get_migrations, params) req.send_request() end |
#get_slot_type(params = {}) ⇒ Types::GetSlotTypeResponse
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 lex:GetSlotType
action.
2504 2505 2506 2507 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2504 def get_slot_type(params = {}, = {}) req = build_request(:get_slot_type, params) req.send_request() end |
#get_slot_type_versions(params = {}) ⇒ Types::GetSlotTypeVersionsResponse
Gets information about all versions of a slot type.
The GetSlotTypeVersions
operation returns a SlotTypeMetadata
object for each version of a slot type. For example, if a slot type
has three numbered versions, the GetSlotTypeVersions
operation
returns four SlotTypeMetadata
objects in the response, one for each
numbered version and one for the $LATEST
version.
The GetSlotTypeVersions
operation always returns at least one
version, the $LATEST
version.
This operation requires permissions for the lex:GetSlotTypeVersions
action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2565 2566 2567 2568 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2565 def get_slot_type_versions(params = {}, = {}) req = build_request(:get_slot_type_versions, params) req.send_request() end |
#get_slot_types(params = {}) ⇒ Types::GetSlotTypesResponse
Returns slot type information as follows:
If you specify the
nameContains
field, returns the$LATEST
version of all slot types that contain the specified string.If you don't specify the
nameContains
field, returns information about the$LATEST
version of all slot types.
The operation requires permission for the lex:GetSlotTypes
action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2661 2662 2663 2664 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2661 def get_slot_types(params = {}, = {}) req = build_request(:get_slot_types, params) req.send_request() end |
#get_utterances_view(params = {}) ⇒ Types::GetUtterancesViewResponse
Use the GetUtterancesView
operation to get information about the
utterances that your users have made to your bot. You can use this
list to tune the utterances that your bot responds to.
For example, say that you have created a bot to order flowers. After
your users have used your bot for a while, use the GetUtterancesView
operation to see the requests that they have made and whether they
have been successful. You might find that the utterance "I want
flowers" is not being recognized. You could add this utterance to the
OrderFlowers
intent so that your bot recognizes that utterance.
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 childDirected
field to true when you created your bot, if
you are using slot obfuscation with one or more slots, or if you opted
out of participating in improving Amazon Lex, utterances are not
available.
This operation requires permissions for the lex:GetUtterancesView
action.
2737 2738 2739 2740 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2737 def get_utterances_view(params = {}, = {}) req = build_request(:get_utterances_view, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them.
2769 2770 2771 2772 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2769 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_bot(params = {}) ⇒ Types::PutBotResponse
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
response FAILED. You can build the bot after you add one or more
intents. For more information about Amazon Lex bots, see how-it-works.
</p> If you specify the name of an existing bot, the fields in the
request replace the existing values in the $LATEST version of the bot.
Amazon Lex removes any fields that you don't provide values for in the
request, except for the idleTTLInSeconds and privacySettings fields,
which are set to their default values. If you don't specify values for
required fields, Amazon Lex throws an exception. This operation
requires permissions for the lex:PutBot action. For more information,
see security-iam.
3246 3247 3248 3249 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 3246 def put_bot(params = {}, = {}) req = build_request(:put_bot, params) req.send_request() end |
#put_bot_alias(params = {}) ⇒ Types::PutBotAliasResponse
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 lex:PutBotAlias
action.
3354 3355 3356 3357 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 3354 def put_bot_alias(params = {}, = {}) req = build_request(:put_bot_alias, params) req.send_request() end |
#put_intent(params = {}) ⇒ Types::PutIntentResponse
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 OrderPizza
intent.
To create an intent or replace an existing intent, you must provide the following:
Intent name. For example,
OrderPizza
.Sample utterances. For example, "Can I order a pizza, please." and "I want to order a pizza."
Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza.
How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application.
You can specify other optional information in the request, such as:
A confirmation prompt to ask the user to confirm an intent. For example, "Shall I order your pizza?"
A conclusion statement to send to the user after the intent has been fulfilled. For example, "I placed your pizza order."
A follow-up prompt that asks the user for additional activity. For example, asking "Do you want to order a drink with your pizza?"
If you specify an existing intent name to update the intent, Amazon
Lex replaces the values in the $LATEST
version of the intent with
the values in the request. Amazon Lex removes fields that you don't
provide in the request. If you don't specify the required fields,
Amazon Lex throws an exception. When you update the $LATEST
version
of an intent, the status
field of any bot that uses the $LATEST
version of the intent is set to NOT_BUILT
.
For more information, see how-it-works.
This operation requires permissions for the lex:PutIntent
action.
4059 4060 4061 4062 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 4059 def put_intent(params = {}, = {}) req = build_request(:put_intent, params) req.send_request() end |
#put_slot_type(params = {}) ⇒ Types::PutSlotTypeResponse
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 $LATEST
version of the
slot type. Amazon Lex removes the fields that you don't provide in
the request. If you don't specify required fields, Amazon Lex throws
an exception. When you update the $LATEST
version of a slot type, if
a bot uses the $LATEST
version of an intent that contains the slot
type, the bot's status
field is set to NOT_BUILT
.
This operation requires permissions for the lex:PutSlotType
action.
4253 4254 4255 4256 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 4253 def put_slot_type(params = {}, = {}) req = build_request(:put_slot_type, params) req.send_request() end |
#start_import(params = {}) ⇒ Types::StartImportResponse
Starts a job to import a resource to Amazon Lex.
4330 4331 4332 4333 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 4330 def start_import(params = {}, = {}) req = build_request(:start_import, params) req.send_request() end |
#start_migration(params = {}) ⇒ Types::StartMigrationResponse
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.
4414 4415 4416 4417 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 4414 def start_migration(params = {}, = {}) req = build_request(:start_migration, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.
4448 4449 4450 4451 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 4448 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a bot, bot alias or bot channel.
4476 4477 4478 4479 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 4476 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |