NAME

Paws::LexModelsV2 - Perl Interface to AWS Amazon Lex Model Building V2

SYNOPSIS

  use Paws;
  my $obj = Paws->service('LexModelsV2');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/models-v2-lex-2020-08-07>

METHODS

BuildBotLocale

BotId => Str
BotVersion => Str
LocaleId => Str

Each argument is described in detail in: Paws::LexModelsV2::BuildBotLocale

Returns: a Paws::LexModelsV2::BuildBotLocaleResponse instance

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.

CreateBot

BotName => Str
DataPrivacy => Paws::LexModelsV2::DataPrivacy
IdleSessionTTLInSeconds => Int
RoleArn => Str
[BotTags => Paws::LexModelsV2::TagMap]
[Description => Str]
[TestBotAliasTags => Paws::LexModelsV2::TagMap]

Each argument is described in detail in: Paws::LexModelsV2::CreateBot

Returns: a Paws::LexModelsV2::CreateBotResponse instance

Creates an Amazon Lex conversational bot.

CreateBotAlias

BotAliasName => Str
BotId => Str
[BotAliasLocaleSettings => Paws::LexModelsV2::BotAliasLocaleSettingsMap]
[BotVersion => Str]
[ConversationLogSettings => Paws::LexModelsV2::ConversationLogSettings]
[Description => Str]
[SentimentAnalysisSettings => Paws::LexModelsV2::SentimentAnalysisSettings]
[Tags => Paws::LexModelsV2::TagMap]

Each argument is described in detail in: Paws::LexModelsV2::CreateBotAlias

Returns: a Paws::LexModelsV2::CreateBotAliasResponse instance

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.

CreateBotLocale

BotId => Str
BotVersion => Str
LocaleId => Str
NluIntentConfidenceThreshold => Num
[Description => Str]
[VoiceSettings => Paws::LexModelsV2::VoiceSettings]

Each argument is described in detail in: Paws::LexModelsV2::CreateBotLocale

Returns: a Paws::LexModelsV2::CreateBotLocaleResponse instance

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.

CreateBotVersion

BotId => Str
BotVersionLocaleSpecification => Paws::LexModelsV2::BotVersionLocaleSpecification
[Description => Str]

Each argument is described in detail in: Paws::LexModelsV2::CreateBotVersion

Returns: a Paws::LexModelsV2::CreateBotVersionResponse instance

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.

CreateExport

FileFormat => Str
ResourceSpecification => Paws::LexModelsV2::ExportResourceSpecification
[FilePassword => Str]

Each argument is described in detail in: Paws::LexModelsV2::CreateExport

Returns: a Paws::LexModelsV2::CreateExportResponse instance

Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot.

You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale.

For more information about exporting bots, and about the structure of the export archive, see Importing and exporting bots (https://docs.aws.amazon.com/lexv2/latest/dg/importing-exporting.html)

CreateIntent

BotId => Str
BotVersion => Str
IntentName => Str
LocaleId => Str
[Description => Str]
[DialogCodeHook => Paws::LexModelsV2::DialogCodeHookSettings]
[FulfillmentCodeHook => Paws::LexModelsV2::FulfillmentCodeHookSettings]
[InputContexts => ArrayRef[Paws::LexModelsV2::InputContext]]
[IntentClosingSetting => Paws::LexModelsV2::IntentClosingSetting]
[IntentConfirmationSetting => Paws::LexModelsV2::IntentConfirmationSetting]
[KendraConfiguration => Paws::LexModelsV2::KendraConfiguration]
[OutputContexts => ArrayRef[Paws::LexModelsV2::OutputContext]]
[ParentIntentSignature => Str]
[SampleUtterances => ArrayRef[Paws::LexModelsV2::SampleUtterance]]

Each argument is described in detail in: Paws::LexModelsV2::CreateIntent

Returns: a Paws::LexModelsV2::CreateIntentResponse instance

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?"

Each argument is described in detail in: Paws::LexModelsV2::CreateResourcePolicy

Returns: a Paws::LexModelsV2::CreateResourcePolicyResponse instance

Creates a new resource policy with the specified policy statements.

CreateResourcePolicyStatement

Action => ArrayRef[Str|Undef]
Effect => Str
Principal => ArrayRef[Paws::LexModelsV2::Principal]
ResourceArn => Str
StatementId => Str
[Condition => Paws::LexModelsV2::ConditionMap]
[ExpectedRevisionId => Str]

Each argument is described in detail in: Paws::LexModelsV2::CreateResourcePolicyStatement

Returns: a Paws::LexModelsV2::CreateResourcePolicyStatementResponse instance

Adds a new resource policy statement to a bot or bot alias. If a resource policy exists, the statement is added to the current resource policy. If a policy doesn't exist, a new policy is created.

You can't create a resource policy statement that allows cross-account access.

CreateSlot

BotId => Str
BotVersion => Str
IntentId => Str
LocaleId => Str
SlotName => Str
SlotTypeId => Str
ValueElicitationSetting => Paws::LexModelsV2::SlotValueElicitationSetting
[Description => Str]
[MultipleValuesSetting => Paws::LexModelsV2::MultipleValuesSetting]
[ObfuscationSetting => Paws::LexModelsV2::ObfuscationSetting]

Each argument is described in detail in: Paws::LexModelsV2::CreateSlot

Returns: a Paws::LexModelsV2::CreateSlotResponse instance

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.

CreateSlotType

BotId => Str
BotVersion => Str
LocaleId => Str
SlotTypeName => Str
ValueSelectionSetting => Paws::LexModelsV2::SlotValueSelectionSetting
[Description => Str]
[ParentSlotTypeSignature => Str]
[SlotTypeValues => ArrayRef[Paws::LexModelsV2::SlotTypeValue]]

Each argument is described in detail in: Paws::LexModelsV2::CreateSlotType

Returns: a Paws::LexModelsV2::CreateSlotTypeResponse instance

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.

CreateUploadUrl

Each argument is described in detail in: Paws::LexModelsV2::CreateUploadUrl

Returns: a Paws::LexModelsV2::CreateUploadUrlResponse instance

Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.

DeleteBot

BotId => Str
[SkipResourceInUseCheck => Bool]

Each argument is described in detail in: Paws::LexModelsV2::DeleteBot

Returns: a Paws::LexModelsV2::DeleteBotResponse instance

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".

DeleteBotAlias

BotAliasId => Str
BotId => Str
[SkipResourceInUseCheck => Bool]

Each argument is described in detail in: Paws::LexModelsV2::DeleteBotAlias

Returns: a Paws::LexModelsV2::DeleteBotAliasResponse instance

Deletes the specified bot alias.

DeleteBotLocale

BotId => Str
BotVersion => Str
LocaleId => Str

Each argument is described in detail in: Paws::LexModelsV2::DeleteBotLocale

Returns: a Paws::LexModelsV2::DeleteBotLocaleResponse instance

Removes a locale from a bot.

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

DeleteBotVersion

BotId => Str
BotVersion => Str
[SkipResourceInUseCheck => Bool]

Each argument is described in detail in: Paws::LexModelsV2::DeleteBotVersion

Returns: a Paws::LexModelsV2::DeleteBotVersionResponse instance

Deletes a specific version of a bot. To delete all version of a bot, use the DeleteBot operation.

DeleteExport

ExportId => Str

Each argument is described in detail in: Paws::LexModelsV2::DeleteExport

Returns: a Paws::LexModelsV2::DeleteExportResponse instance

Removes a previous export and the associated files stored in an S3 bucket.

DeleteImport

ImportId => Str

Each argument is described in detail in: Paws::LexModelsV2::DeleteImport

Returns: a Paws::LexModelsV2::DeleteImportResponse instance

Removes a previous import and the associated file stored in an S3 bucket.

DeleteIntent

BotId => Str
BotVersion => Str
IntentId => Str
LocaleId => Str

Each argument is described in detail in: Paws::LexModelsV2::DeleteIntent

Returns: nothing

Removes the specified intent.

Deleting an intent also deletes the slots associated with the intent.

DeleteResourcePolicy

ResourceArn => Str
[ExpectedRevisionId => Str]

Each argument is described in detail in: Paws::LexModelsV2::DeleteResourcePolicy

Returns: a Paws::LexModelsV2::DeleteResourcePolicyResponse instance

Removes an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception.

DeleteResourcePolicyStatement

ResourceArn => Str
StatementId => Str
[ExpectedRevisionId => Str]

Each argument is described in detail in: Paws::LexModelsV2::DeleteResourcePolicyStatement

Returns: a Paws::LexModelsV2::DeleteResourcePolicyStatementResponse instance

Deletes a policy statement from a resource policy. If you delete the last statement from a policy, the policy is deleted. If you specify a statement ID that doesn't exist in the policy, or if the bot or bot alias doesn't have a policy attached, Amazon Lex returns an exception.

DeleteSlot

BotId => Str
BotVersion => Str
IntentId => Str
LocaleId => Str
SlotId => Str

Each argument is described in detail in: Paws::LexModelsV2::DeleteSlot

Returns: nothing

Deletes the specified slot from an intent.

DeleteSlotType

BotId => Str
BotVersion => Str
LocaleId => Str
SlotTypeId => Str
[SkipResourceInUseCheck => Bool]

Each argument is described in detail in: Paws::LexModelsV2::DeleteSlotType

Returns: nothing

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".

DescribeBot

BotId => Str

Each argument is described in detail in: Paws::LexModelsV2::DescribeBot

Returns: a Paws::LexModelsV2::DescribeBotResponse instance

Provides metadata information about a bot.

DescribeBotAlias

BotAliasId => Str
BotId => Str

Each argument is described in detail in: Paws::LexModelsV2::DescribeBotAlias

Returns: a Paws::LexModelsV2::DescribeBotAliasResponse instance

Get information about a specific bot alias.

DescribeBotLocale

BotId => Str
BotVersion => Str
LocaleId => Str

Each argument is described in detail in: Paws::LexModelsV2::DescribeBotLocale

Returns: a Paws::LexModelsV2::DescribeBotLocaleResponse instance

Describes the settings that a bot has for a specific locale.

DescribeBotVersion

BotId => Str
BotVersion => Str

Each argument is described in detail in: Paws::LexModelsV2::DescribeBotVersion

Returns: a Paws::LexModelsV2::DescribeBotVersionResponse instance

Provides metadata about a version of a bot.

DescribeExport

ExportId => Str

Each argument is described in detail in: Paws::LexModelsV2::DescribeExport

Returns: a Paws::LexModelsV2::DescribeExportResponse instance

Gets information about a specific export.

DescribeImport

ImportId => Str

Each argument is described in detail in: Paws::LexModelsV2::DescribeImport

Returns: a Paws::LexModelsV2::DescribeImportResponse instance

Gets information about a specific import.

DescribeIntent

BotId => Str
BotVersion => Str
IntentId => Str
LocaleId => Str

Each argument is described in detail in: Paws::LexModelsV2::DescribeIntent

Returns: a Paws::LexModelsV2::DescribeIntentResponse instance

Returns metadata about an intent.

DescribeResourcePolicy

ResourceArn => Str

Each argument is described in detail in: Paws::LexModelsV2::DescribeResourcePolicy

Returns: a Paws::LexModelsV2::DescribeResourcePolicyResponse instance

Gets the resource policy and policy revision for a bot or bot alias.

DescribeSlot

BotId => Str
BotVersion => Str
IntentId => Str
LocaleId => Str
SlotId => Str

Each argument is described in detail in: Paws::LexModelsV2::DescribeSlot

Returns: a Paws::LexModelsV2::DescribeSlotResponse instance

Gets metadata information about a slot.

DescribeSlotType

BotId => Str
BotVersion => Str
LocaleId => Str
SlotTypeId => Str

Each argument is described in detail in: Paws::LexModelsV2::DescribeSlotType

Returns: a Paws::LexModelsV2::DescribeSlotTypeResponse instance

Gets metadata information about a slot type.

ListBotAliases

BotId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LexModelsV2::ListBotAliases

Returns: a Paws::LexModelsV2::ListBotAliasesResponse instance

Gets a list of aliases for the specified bot.

ListBotLocales

BotId => Str
BotVersion => Str
[Filters => ArrayRef[Paws::LexModelsV2::BotLocaleFilter]]
[MaxResults => Int]
[NextToken => Str]
[SortBy => Paws::LexModelsV2::BotLocaleSortBy]

Each argument is described in detail in: Paws::LexModelsV2::ListBotLocales

Returns: a Paws::LexModelsV2::ListBotLocalesResponse instance

Gets a list of locales for the specified bot.

ListBots

[Filters => ArrayRef[Paws::LexModelsV2::BotFilter]]
[MaxResults => Int]
[NextToken => Str]
[SortBy => Paws::LexModelsV2::BotSortBy]

Each argument is described in detail in: Paws::LexModelsV2::ListBots

Returns: a Paws::LexModelsV2::ListBotsResponse instance

Gets a list of available bots.

ListBotVersions

BotId => Str
[MaxResults => Int]
[NextToken => Str]
[SortBy => Paws::LexModelsV2::BotVersionSortBy]

Each argument is described in detail in: Paws::LexModelsV2::ListBotVersions

Returns: a Paws::LexModelsV2::ListBotVersionsResponse instance

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.

ListBuiltInIntents

LocaleId => Str
[MaxResults => Int]
[NextToken => Str]
[SortBy => Paws::LexModelsV2::BuiltInIntentSortBy]

Each argument is described in detail in: Paws::LexModelsV2::ListBuiltInIntents

Returns: a Paws::LexModelsV2::ListBuiltInIntentsResponse instance

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.

ListBuiltInSlotTypes

LocaleId => Str
[MaxResults => Int]
[NextToken => Str]
[SortBy => Paws::LexModelsV2::BuiltInSlotTypeSortBy]

Each argument is described in detail in: Paws::LexModelsV2::ListBuiltInSlotTypes

Returns: a Paws::LexModelsV2::ListBuiltInSlotTypesResponse instance

Gets a list of built-in slot types that meet the specified criteria.

ListExports

[BotId => Str]
[BotVersion => Str]
[Filters => ArrayRef[Paws::LexModelsV2::ExportFilter]]
[MaxResults => Int]
[NextToken => Str]
[SortBy => Paws::LexModelsV2::ExportSortBy]

Each argument is described in detail in: Paws::LexModelsV2::ListExports

Returns: a Paws::LexModelsV2::ListExportsResponse instance

Lists the exports for a bot or bot locale. Exports are kept in the list for 7 days.

ListImports

[BotId => Str]
[BotVersion => Str]
[Filters => ArrayRef[Paws::LexModelsV2::ImportFilter]]
[MaxResults => Int]
[NextToken => Str]
[SortBy => Paws::LexModelsV2::ImportSortBy]

Each argument is described in detail in: Paws::LexModelsV2::ListImports

Returns: a Paws::LexModelsV2::ListImportsResponse instance

Lists the imports for a bot or bot locale. Imports are kept in the list for 7 days.

ListIntents

BotId => Str
BotVersion => Str
LocaleId => Str
[Filters => ArrayRef[Paws::LexModelsV2::IntentFilter]]
[MaxResults => Int]
[NextToken => Str]
[SortBy => Paws::LexModelsV2::IntentSortBy]

Each argument is described in detail in: Paws::LexModelsV2::ListIntents

Returns: a Paws::LexModelsV2::ListIntentsResponse instance

Get a list of intents that meet the specified criteria.

ListSlots

BotId => Str
BotVersion => Str
IntentId => Str
LocaleId => Str
[Filters => ArrayRef[Paws::LexModelsV2::SlotFilter]]
[MaxResults => Int]
[NextToken => Str]
[SortBy => Paws::LexModelsV2::SlotSortBy]

Each argument is described in detail in: Paws::LexModelsV2::ListSlots

Returns: a Paws::LexModelsV2::ListSlotsResponse instance

Gets a list of slots that match the specified criteria.

ListSlotTypes

BotId => Str
BotVersion => Str
LocaleId => Str
[Filters => ArrayRef[Paws::LexModelsV2::SlotTypeFilter]]
[MaxResults => Int]
[NextToken => Str]
[SortBy => Paws::LexModelsV2::SlotTypeSortBy]

Each argument is described in detail in: Paws::LexModelsV2::ListSlotTypes

Returns: a Paws::LexModelsV2::ListSlotTypesResponse instance

Gets a list of slot types that match the specified criteria.

ListTagsForResource

ResourceARN => Str

Each argument is described in detail in: Paws::LexModelsV2::ListTagsForResource

Returns: a Paws::LexModelsV2::ListTagsForResourceResponse instance

Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.

StartImport

ImportId => Str
MergeStrategy => Str
ResourceSpecification => Paws::LexModelsV2::ImportResourceSpecification
[FilePassword => Str]

Each argument is described in detail in: Paws::LexModelsV2::StartImport

Returns: a Paws::LexModelsV2::StartImportResponse instance

Starts importing a bot or bot locale from a zip archive that you uploaded to an S3 bucket.

TagResource

ResourceARN => Str
Tags => Paws::LexModelsV2::TagMap

Each argument is described in detail in: Paws::LexModelsV2::TagResource

Returns: a Paws::LexModelsV2::TagResourceResponse instance

Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.

UntagResource

ResourceARN => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::LexModelsV2::UntagResource

Returns: a Paws::LexModelsV2::UntagResourceResponse instance

Removes tags from a bot, bot alias, or bot channel.

UpdateBot

BotId => Str
BotName => Str
DataPrivacy => Paws::LexModelsV2::DataPrivacy
IdleSessionTTLInSeconds => Int
RoleArn => Str
[Description => Str]

Each argument is described in detail in: Paws::LexModelsV2::UpdateBot

Returns: a Paws::LexModelsV2::UpdateBotResponse instance

Updates the configuration of an existing bot.

UpdateBotAlias

BotAliasId => Str
BotAliasName => Str
BotId => Str
[BotAliasLocaleSettings => Paws::LexModelsV2::BotAliasLocaleSettingsMap]
[BotVersion => Str]
[ConversationLogSettings => Paws::LexModelsV2::ConversationLogSettings]
[Description => Str]
[SentimentAnalysisSettings => Paws::LexModelsV2::SentimentAnalysisSettings]

Each argument is described in detail in: Paws::LexModelsV2::UpdateBotAlias

Returns: a Paws::LexModelsV2::UpdateBotAliasResponse instance

Updates the configuration of an existing bot alias.

UpdateBotLocale

BotId => Str
BotVersion => Str
LocaleId => Str
NluIntentConfidenceThreshold => Num
[Description => Str]
[VoiceSettings => Paws::LexModelsV2::VoiceSettings]

Each argument is described in detail in: Paws::LexModelsV2::UpdateBotLocale

Returns: a Paws::LexModelsV2::UpdateBotLocaleResponse instance

Updates the settings that a bot has for a specific locale.

UpdateExport

ExportId => Str
[FilePassword => Str]

Each argument is described in detail in: Paws::LexModelsV2::UpdateExport

Returns: a Paws::LexModelsV2::UpdateExportResponse instance

Updates the password used to protect an export zip archive.

The password is not required. If you don't supply a password, Amazon Lex generates a zip file that is not protected by a password. This is the archive that is available at the pre-signed S3 URL provided by the operation.