View Source aws_lex_models_v2 (aws v0.3.1)

Link to this section Summary

Functions

Builds a bot, its intents, and its slot types into a specific locale.

Creates an Amazon Lex conversational bot.

Creates an alias for the specified version of a bot.

Creates a new version of the bot based on the DRAFT version.

Deletes all versions of a bot, including the Draft version.

Deletes the specified bot alias.

Deletes a specific version of a bot.

Provides metadata information about a bot.
Get information about a specific bot alias.
Describes the settings that a bot has for a specific locale.
Provides metadata about a version of a bot.
Gets metadata information about a slot type.
Gets a list of aliases for the specified bot.
Gets a list of locales for the specified bot.

Gets information about all of the versions of a bot.

Gets a list of available bots.

Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.

Gets a list of built-in slot types that meet the specified criteria.
Get a list of intents that meet the specified criteria.
Gets a list of slot types that match the specified criteria.
Gets a list of slots that match the specified criteria.

Gets a list of tags associated with a resource.

Adds the specified tags to the specified resource.

Removes tags from a bot, bot alias, or bot channel.
Updates the configuration of an existing bot.
Updates the configuration of an existing bot alias.
Updates the settings that a bot has for a specific locale.
Updates the configuration of an existing slot type.

Link to this section Functions

Link to this function

build_bot_locale(Client, BotId, BotVersion, LocaleId, Input)

View Source

Builds a bot, its intents, and its slot types into a specific locale.

A bot can be built into multiple locales. At runtime the locale is used to choose a specific build of the bot.
Link to this function

build_bot_locale(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

create_bot(Client, Input)

View Source
Creates an Amazon Lex conversational bot.
Link to this function

create_bot(Client, Input0, Options0)

View Source
Link to this function

create_bot_alias(Client, BotId, Input)

View Source

Creates an alias for the specified version of a bot.

Use an alias to enable you to change the version of a bot without updating applications that use the bot.

For example, you can create an alias called "PROD" that your applications use to call the Amazon Lex bot.
Link to this function

create_bot_alias(Client, BotId, Input0, Options0)

View Source
Link to this function

create_bot_locale(Client, BotId, BotVersion, Input)

View Source

Creates a locale in the bot.

The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.
Link to this function

create_bot_locale(Client, BotId, BotVersion, Input0, Options0)

View Source
Link to this function

create_bot_version(Client, BotId, Input)

View Source

Creates a new version of the bot based on the DRAFT version.

If the DRAFT 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.

When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1.
Link to this function

create_bot_version(Client, BotId, Input0, Options0)

View Source
Link to this function

create_intent(Client, BotId, BotVersion, LocaleId, Input)

View Source

Creates an intent.

To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an OrderPizza intent.

When you create an intent, you must provide a name. You can optionally provide the following:

  • Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents.

  • Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application.

  • How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available.

  • A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?"

  • A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza."

  • A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?"

Link to this function

create_intent(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

create_slot(Client, BotId, BotVersion, IntentId, LocaleId, Input)

View Source

Creates a slot in an intent.

A slot is a variable needed to fulfill an intent. For example, an OrderPizza intent might need slots for size, crust, and number of pizzas. For each slot, you define one or more utterances that Amazon Lex uses to elicit a response from the user.
Link to this function

create_slot(Client, BotId, BotVersion, IntentId, LocaleId, Input0, Options0)

View Source
Link to this function

create_slot_type(Client, BotId, BotVersion, LocaleId, Input)

View Source

Creates a custom slot type

To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.
Link to this function

create_slot_type(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

delete_bot(Client, BotId, Input)

View Source

Deletes all versions of a bot, including the Draft version.

To delete a specific version, use the DeleteBotVersion operation.

When you delete a bot, all of the resources contained in the bot are also deleted. Deleting a bot removes all locales, intents, slot, and slot types defined for the bot.

If a bot has an alias, the DeleteBot operation returns a ResourceInUseException exception. If you want to delete the bot and the alias, set the skipResourceInUseCheck parameter to true.
Link to this function

delete_bot(Client, BotId, Input0, Options0)

View Source
Link to this function

delete_bot_alias(Client, BotAliasId, BotId, Input)

View Source
Deletes the specified bot alias.
Link to this function

delete_bot_alias(Client, BotAliasId, BotId, Input0, Options0)

View Source
Link to this function

delete_bot_locale(Client, BotId, BotVersion, LocaleId, Input)

View Source

Removes a locale from a bot.

When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.
Link to this function

delete_bot_locale(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

delete_bot_version(Client, BotId, BotVersion, Input)

View Source

Deletes a specific version of a bot.

To delete all version of a bot, use the DeleteBot operation.
Link to this function

delete_bot_version(Client, BotId, BotVersion, Input0, Options0)

View Source
Link to this function

delete_intent(Client, BotId, BotVersion, IntentId, LocaleId, Input)

View Source

Removes the specified intent.

Deleting an intent also deletes the slots associated with the intent.
Link to this function

delete_intent(Client, BotId, BotVersion, IntentId, LocaleId, Input0, Options0)

View Source
Link to this function

delete_slot(Client, BotId, BotVersion, IntentId, LocaleId, SlotId, Input)

View Source
Deletes the specified slot from an intent.
Link to this function

delete_slot(Client, BotId, BotVersion, IntentId, LocaleId, SlotId, Input0, Options0)

View Source
Link to this function

delete_slot_type(Client, BotId, BotVersion, LocaleId, SlotTypeId, Input)

View Source

Deletes a slot type from a bot locale.

If a slot is using the slot type, Amazon Lex throws a ResourceInUseException exception. To avoid the exception, set the skipResourceInUseCheck parameter to true.
Link to this function

delete_slot_type(Client, BotId, BotVersion, LocaleId, SlotTypeId, Input0, Options0)

View Source
Link to this function

describe_bot(Client, BotId)

View Source
Provides metadata information about a bot.
Link to this function

describe_bot(Client, BotId, QueryMap, HeadersMap)

View Source
Link to this function

describe_bot(Client, BotId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_bot_alias(Client, BotAliasId, BotId)

View Source
Get information about a specific bot alias.
Link to this function

describe_bot_alias(Client, BotAliasId, BotId, QueryMap, HeadersMap)

View Source
Link to this function

describe_bot_alias(Client, BotAliasId, BotId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_bot_locale(Client, BotId, BotVersion, LocaleId)

View Source
Describes the settings that a bot has for a specific locale.
Link to this function

describe_bot_locale(Client, BotId, BotVersion, LocaleId, QueryMap, HeadersMap)

View Source
Link to this function

describe_bot_locale(Client, BotId, BotVersion, LocaleId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_bot_version(Client, BotId, BotVersion)

View Source
Provides metadata about a version of a bot.
Link to this function

describe_bot_version(Client, BotId, BotVersion, QueryMap, HeadersMap)

View Source
Link to this function

describe_bot_version(Client, BotId, BotVersion, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_intent(Client, BotId, BotVersion, IntentId, LocaleId)

View Source
Returns metadata about an intent.
Link to this function

describe_intent(Client, BotId, BotVersion, IntentId, LocaleId, QueryMap, HeadersMap)

View Source
Link to this function

describe_intent(Client, BotId, BotVersion, IntentId, LocaleId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_slot(Client, BotId, BotVersion, IntentId, LocaleId, SlotId)

View Source
Gets metadata information about a slot.
Link to this function

describe_slot(Client, BotId, BotVersion, IntentId, LocaleId, SlotId, QueryMap, HeadersMap)

View Source
Link to this function

describe_slot(Client, BotId, BotVersion, IntentId, LocaleId, SlotId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_slot_type(Client, BotId, BotVersion, LocaleId, SlotTypeId)

View Source
Gets metadata information about a slot type.
Link to this function

describe_slot_type(Client, BotId, BotVersion, LocaleId, SlotTypeId, QueryMap, HeadersMap)

View Source
Link to this function

describe_slot_type(Client, BotId, BotVersion, LocaleId, SlotTypeId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_bot_aliases(Client, BotId, Input)

View Source
Gets a list of aliases for the specified bot.
Link to this function

list_bot_aliases(Client, BotId, Input0, Options0)

View Source
Link to this function

list_bot_locales(Client, BotId, BotVersion, Input)

View Source
Gets a list of locales for the specified bot.
Link to this function

list_bot_locales(Client, BotId, BotVersion, Input0, Options0)

View Source
Link to this function

list_bot_versions(Client, BotId, Input)

View Source

Gets information about all of the versions of a bot.

The ListBotVersions operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the ListBotVersions operation returns for summaries, one for each numbered version and one for the DRAFT version.

The ListBotVersions operation always returns at least one version, the DRAFT version.
Link to this function

list_bot_versions(Client, BotId, Input0, Options0)

View Source
Link to this function

list_bots(Client, Input)

View Source
Gets a list of available bots.
Link to this function

list_bots(Client, Input0, Options0)

View Source
Link to this function

list_built_in_intents(Client, LocaleId, Input)

View Source

Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.

To use a built-in intent as a the base for your own intent, include the built-in intent signature in the parentIntentSignature parameter when you call the CreateIntent operation. For more information, see CreateIntent.
Link to this function

list_built_in_intents(Client, LocaleId, Input0, Options0)

View Source
Link to this function

list_built_in_slot_types(Client, LocaleId, Input)

View Source
Gets a list of built-in slot types that meet the specified criteria.
Link to this function

list_built_in_slot_types(Client, LocaleId, Input0, Options0)

View Source
Link to this function

list_intents(Client, BotId, BotVersion, LocaleId, Input)

View Source
Get a list of intents that meet the specified criteria.
Link to this function

list_intents(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

list_slot_types(Client, BotId, BotVersion, LocaleId, Input)

View Source
Gets a list of slot types that match the specified criteria.
Link to this function

list_slot_types(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

list_slots(Client, BotId, BotVersion, IntentId, LocaleId, Input)

View Source
Gets a list of slots that match the specified criteria.
Link to this function

list_slots(Client, BotId, BotVersion, IntentId, LocaleId, Input0, Options0)

View Source
Link to this function

list_tags_for_resource(Client, ResourceARN)

View Source

Gets a list of tags associated with a resource.

Only bots, bot aliases, and bot channels can have tags associated with them.
Link to this function

list_tags_for_resource(Client, ResourceARN, QueryMap, HeadersMap)

View Source
Link to this function

list_tags_for_resource(Client, ResourceARN, QueryMap, HeadersMap, Options0)

View Source
Link to this function

tag_resource(Client, ResourceARN, Input)

View Source

Adds the specified tags to the specified resource.

If a tag key already exists, the existing value is replaced with the new value.
Link to this function

tag_resource(Client, ResourceARN, Input0, Options0)

View Source
Link to this function

untag_resource(Client, ResourceARN, Input)

View Source
Removes tags from a bot, bot alias, or bot channel.
Link to this function

untag_resource(Client, ResourceARN, Input0, Options0)

View Source
Link to this function

update_bot(Client, BotId, Input)

View Source
Updates the configuration of an existing bot.
Link to this function

update_bot(Client, BotId, Input0, Options0)

View Source
Link to this function

update_bot_alias(Client, BotAliasId, BotId, Input)

View Source
Updates the configuration of an existing bot alias.
Link to this function

update_bot_alias(Client, BotAliasId, BotId, Input0, Options0)

View Source
Link to this function

update_bot_locale(Client, BotId, BotVersion, LocaleId, Input)

View Source
Updates the settings that a bot has for a specific locale.
Link to this function

update_bot_locale(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

update_intent(Client, BotId, BotVersion, IntentId, LocaleId, Input)

View Source
Updates the settings for an intent.
Link to this function

update_intent(Client, BotId, BotVersion, IntentId, LocaleId, Input0, Options0)

View Source
Link to this function

update_slot(Client, BotId, BotVersion, IntentId, LocaleId, SlotId, Input)

View Source
Updates the settings for a slot.
Link to this function

update_slot(Client, BotId, BotVersion, IntentId, LocaleId, SlotId, Input0, Options0)

View Source
Link to this function

update_slot_type(Client, BotId, BotVersion, LocaleId, SlotTypeId, Input)

View Source
Updates the configuration of an existing slot type.
Link to this function

update_slot_type(Client, BotId, BotVersion, LocaleId, SlotTypeId, Input0, Options0)

View Source