LexModelsV2Client
Index > LexModelsV2 > LexModelsV2Client
Auto-generated documentation for LexModelsV2 type annotations stubs module types-aiobotocore-lexv2-models.
LexModelsV2Client
Type annotations and code completion for session.client("lexv2-models")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_lexv2_models.client import LexModelsV2Client
session = Session()
async with session.client("lexv2-models") as client:
client: LexModelsV2Client
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("lexv2-models").exceptions
structure.
async with session.client("lexv2-models") as client:
try:
do_something(client)
except (
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.PreconditionFailedException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
from types_aiobotocore_lexv2_models.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods
build_bot_locale
Builds a bot, its intents, and its slot types into a specific locale.
Type annotations and code completion for session.client("lexv2-models").build_bot_locale
method.
boto3 documentation
await def build_bot_locale(
self,
*,
botId: str,
botVersion: str,
localeId: str,
) -> BuildBotLocaleResponseTypeDef: # (1)
...
kwargs: BuildBotLocaleRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
"localeId": ...,
}
parent.build_bot_locale(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for session.client("lexv2-models").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("lexv2-models").close
method.
boto3 documentation
create_bot
Creates an Amazon Lex conversational bot.
Type annotations and code completion for session.client("lexv2-models").create_bot
method.
boto3 documentation
await def create_bot(
self,
*,
botName: str,
roleArn: str,
dataPrivacy: DataPrivacyTypeDef, # (1)
idleSessionTTLInSeconds: int,
description: str = ...,
botTags: Mapping[str, str] = ...,
testBotAliasTags: Mapping[str, str] = ...,
) -> CreateBotResponseTypeDef: # (2)
...
kwargs: CreateBotRequestRequestTypeDef = { # (1)
"botName": ...,
"roleArn": ...,
"dataPrivacy": ...,
"idleSessionTTLInSeconds": ...,
}
parent.create_bot(**kwargs)
create_bot_alias
Creates an alias for the specified version of a bot.
Type annotations and code completion for session.client("lexv2-models").create_bot_alias
method.
boto3 documentation
await def create_bot_alias(
self,
*,
botAliasName: str,
botId: str,
description: str = ...,
botVersion: str = ...,
botAliasLocaleSettings: Mapping[str, BotAliasLocaleSettingsTypeDef] = ..., # (1)
conversationLogSettings: ConversationLogSettingsTypeDef = ..., # (2)
sentimentAnalysisSettings: SentimentAnalysisSettingsTypeDef = ..., # (3)
tags: Mapping[str, str] = ...,
) -> CreateBotAliasResponseTypeDef: # (4)
...
- See BotAliasLocaleSettingsTypeDef
- See ConversationLogSettingsTypeDef
- See SentimentAnalysisSettingsTypeDef
- See CreateBotAliasResponseTypeDef
kwargs: CreateBotAliasRequestRequestTypeDef = { # (1)
"botAliasName": ...,
"botId": ...,
}
parent.create_bot_alias(**kwargs)
create_bot_locale
Creates a locale in the bot.
Type annotations and code completion for session.client("lexv2-models").create_bot_locale
method.
boto3 documentation
await def create_bot_locale(
self,
*,
botId: str,
botVersion: str,
localeId: str,
nluIntentConfidenceThreshold: float,
description: str = ...,
voiceSettings: VoiceSettingsTypeDef = ..., # (1)
) -> CreateBotLocaleResponseTypeDef: # (2)
...
kwargs: CreateBotLocaleRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
"localeId": ...,
"nluIntentConfidenceThreshold": ...,
}
parent.create_bot_locale(**kwargs)
create_bot_version
Creates a new version of the bot based on the DRAFT
version.
Type annotations and code completion for session.client("lexv2-models").create_bot_version
method.
boto3 documentation
await def create_bot_version(
self,
*,
botId: str,
botVersionLocaleSpecification: Mapping[str, BotVersionLocaleDetailsTypeDef], # (1)
description: str = ...,
) -> CreateBotVersionResponseTypeDef: # (2)
...
kwargs: CreateBotVersionRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersionLocaleSpecification": ...,
}
parent.create_bot_version(**kwargs)
create_export
Creates a zip archive containing the contents of a bot or a bot locale.
Type annotations and code completion for session.client("lexv2-models").create_export
method.
boto3 documentation
await def create_export(
self,
*,
resourceSpecification: ExportResourceSpecificationTypeDef, # (1)
fileFormat: ImportExportFileFormatType, # (2)
filePassword: str = ...,
) -> CreateExportResponseTypeDef: # (3)
...
- See ExportResourceSpecificationTypeDef
- See ImportExportFileFormatType
- See CreateExportResponseTypeDef
kwargs: CreateExportRequestRequestTypeDef = { # (1)
"resourceSpecification": ...,
"fileFormat": ...,
}
parent.create_export(**kwargs)
create_intent
Creates an intent.
Type annotations and code completion for session.client("lexv2-models").create_intent
method.
boto3 documentation
await def create_intent(
self,
*,
intentName: str,
botId: str,
botVersion: str,
localeId: str,
description: str = ...,
parentIntentSignature: str = ...,
sampleUtterances: Sequence[SampleUtteranceTypeDef] = ..., # (1)
dialogCodeHook: DialogCodeHookSettingsTypeDef = ..., # (2)
fulfillmentCodeHook: FulfillmentCodeHookSettingsTypeDef = ..., # (3)
intentConfirmationSetting: IntentConfirmationSettingTypeDef = ..., # (4)
intentClosingSetting: IntentClosingSettingTypeDef = ..., # (5)
inputContexts: Sequence[InputContextTypeDef] = ..., # (6)
outputContexts: Sequence[OutputContextTypeDef] = ..., # (7)
kendraConfiguration: KendraConfigurationTypeDef = ..., # (8)
initialResponseSetting: InitialResponseSettingTypeDef = ..., # (9)
) -> CreateIntentResponseTypeDef: # (10)
...
- See SampleUtteranceTypeDef
- See DialogCodeHookSettingsTypeDef
- See FulfillmentCodeHookSettingsTypeDef
- See IntentConfirmationSettingTypeDef
- See IntentClosingSettingTypeDef
- See InputContextTypeDef
- See OutputContextTypeDef
- See KendraConfigurationTypeDef
- See InitialResponseSettingTypeDef
- See CreateIntentResponseTypeDef
kwargs: CreateIntentRequestRequestTypeDef = { # (1)
"intentName": ...,
"botId": ...,
"botVersion": ...,
"localeId": ...,
}
parent.create_intent(**kwargs)
create_resource_policy
Creates a new resource policy with the specified policy statements.
Type annotations and code completion for session.client("lexv2-models").create_resource_policy
method.
boto3 documentation
await def create_resource_policy(
self,
*,
resourceArn: str,
policy: str,
) -> CreateResourcePolicyResponseTypeDef: # (1)
...
kwargs: CreateResourcePolicyRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"policy": ...,
}
parent.create_resource_policy(**kwargs)
create_resource_policy_statement
Adds a new resource policy statement to a bot or bot alias.
Type annotations and code completion for session.client("lexv2-models").create_resource_policy_statement
method.
boto3 documentation
await def create_resource_policy_statement(
self,
*,
resourceArn: str,
statementId: str,
effect: EffectType, # (1)
principal: Sequence[PrincipalTypeDef], # (2)
action: Sequence[str],
condition: Mapping[str, Mapping[str, str]] = ...,
expectedRevisionId: str = ...,
) -> CreateResourcePolicyStatementResponseTypeDef: # (3)
...
kwargs: CreateResourcePolicyStatementRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"statementId": ...,
"effect": ...,
"principal": ...,
"action": ...,
}
parent.create_resource_policy_statement(**kwargs)
create_slot
Creates a slot in an intent.
Type annotations and code completion for session.client("lexv2-models").create_slot
method.
boto3 documentation
await def create_slot(
self,
*,
slotName: str,
valueElicitationSetting: SlotValueElicitationSettingTypeDef, # (1)
botId: str,
botVersion: str,
localeId: str,
intentId: str,
description: str = ...,
slotTypeId: str = ...,
obfuscationSetting: ObfuscationSettingTypeDef = ..., # (2)
multipleValuesSetting: MultipleValuesSettingTypeDef = ..., # (3)
) -> CreateSlotResponseTypeDef: # (4)
...
- See SlotValueElicitationSettingTypeDef
- See ObfuscationSettingTypeDef
- See MultipleValuesSettingTypeDef
- See CreateSlotResponseTypeDef
kwargs: CreateSlotRequestRequestTypeDef = { # (1)
"slotName": ...,
"valueElicitationSetting": ...,
"botId": ...,
"botVersion": ...,
"localeId": ...,
"intentId": ...,
}
parent.create_slot(**kwargs)
create_slot_type
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.
Type annotations and code completion for session.client("lexv2-models").create_slot_type
method.
boto3 documentation
await def create_slot_type(
self,
*,
slotTypeName: str,
botId: str,
botVersion: str,
localeId: str,
description: str = ...,
slotTypeValues: Sequence[SlotTypeValueTypeDef] = ..., # (1)
valueSelectionSetting: SlotValueSelectionSettingTypeDef = ..., # (2)
parentSlotTypeSignature: str = ...,
externalSourceSetting: ExternalSourceSettingTypeDef = ..., # (3)
) -> CreateSlotTypeResponseTypeDef: # (4)
...
- See SlotTypeValueTypeDef
- See SlotValueSelectionSettingTypeDef
- See ExternalSourceSettingTypeDef
- See CreateSlotTypeResponseTypeDef
kwargs: CreateSlotTypeRequestRequestTypeDef = { # (1)
"slotTypeName": ...,
"botId": ...,
"botVersion": ...,
"localeId": ...,
}
parent.create_slot_type(**kwargs)
create_upload_url
Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.
Type annotations and code completion for session.client("lexv2-models").create_upload_url
method.
boto3 documentation
delete_bot
Deletes all versions of a bot, including the Draft
version.
Type annotations and code completion for session.client("lexv2-models").delete_bot
method.
boto3 documentation
await def delete_bot(
self,
*,
botId: str,
skipResourceInUseCheck: bool = ...,
) -> DeleteBotResponseTypeDef: # (1)
...
kwargs: DeleteBotRequestRequestTypeDef = { # (1)
"botId": ...,
}
parent.delete_bot(**kwargs)
delete_bot_alias
Deletes the specified bot alias.
Type annotations and code completion for session.client("lexv2-models").delete_bot_alias
method.
boto3 documentation
await def delete_bot_alias(
self,
*,
botAliasId: str,
botId: str,
skipResourceInUseCheck: bool = ...,
) -> DeleteBotAliasResponseTypeDef: # (1)
...
kwargs: DeleteBotAliasRequestRequestTypeDef = { # (1)
"botAliasId": ...,
"botId": ...,
}
parent.delete_bot_alias(**kwargs)
delete_bot_locale
Removes a locale from a bot.
Type annotations and code completion for session.client("lexv2-models").delete_bot_locale
method.
boto3 documentation
await def delete_bot_locale(
self,
*,
botId: str,
botVersion: str,
localeId: str,
) -> DeleteBotLocaleResponseTypeDef: # (1)
...
kwargs: DeleteBotLocaleRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
"localeId": ...,
}
parent.delete_bot_locale(**kwargs)
delete_bot_version
Deletes a specific version of a bot.
Type annotations and code completion for session.client("lexv2-models").delete_bot_version
method.
boto3 documentation
await def delete_bot_version(
self,
*,
botId: str,
botVersion: str,
skipResourceInUseCheck: bool = ...,
) -> DeleteBotVersionResponseTypeDef: # (1)
...
kwargs: DeleteBotVersionRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
}
parent.delete_bot_version(**kwargs)
delete_custom_vocabulary
Removes a custom vocabulary from the specified locale in the specified bot.
Type annotations and code completion for session.client("lexv2-models").delete_custom_vocabulary
method.
boto3 documentation
await def delete_custom_vocabulary(
self,
*,
botId: str,
botVersion: str,
localeId: str,
) -> DeleteCustomVocabularyResponseTypeDef: # (1)
...
kwargs: DeleteCustomVocabularyRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
"localeId": ...,
}
parent.delete_custom_vocabulary(**kwargs)
delete_export
Removes a previous export and the associated files stored in an S3 bucket.
Type annotations and code completion for session.client("lexv2-models").delete_export
method.
boto3 documentation
await def delete_export(
self,
*,
exportId: str,
) -> DeleteExportResponseTypeDef: # (1)
...
kwargs: DeleteExportRequestRequestTypeDef = { # (1)
"exportId": ...,
}
parent.delete_export(**kwargs)
delete_import
Removes a previous import and the associated file stored in an S3 bucket.
Type annotations and code completion for session.client("lexv2-models").delete_import
method.
boto3 documentation
await def delete_import(
self,
*,
importId: str,
) -> DeleteImportResponseTypeDef: # (1)
...
kwargs: DeleteImportRequestRequestTypeDef = { # (1)
"importId": ...,
}
parent.delete_import(**kwargs)
delete_intent
Removes the specified intent.
Type annotations and code completion for session.client("lexv2-models").delete_intent
method.
boto3 documentation
await def delete_intent(
self,
*,
intentId: str,
botId: str,
botVersion: str,
localeId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteIntentRequestRequestTypeDef = { # (1)
"intentId": ...,
"botId": ...,
"botVersion": ...,
"localeId": ...,
}
parent.delete_intent(**kwargs)
delete_resource_policy
Removes an existing policy from a bot or bot alias.
Type annotations and code completion for session.client("lexv2-models").delete_resource_policy
method.
boto3 documentation
await def delete_resource_policy(
self,
*,
resourceArn: str,
expectedRevisionId: str = ...,
) -> DeleteResourcePolicyResponseTypeDef: # (1)
...
kwargs: DeleteResourcePolicyRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.delete_resource_policy(**kwargs)
delete_resource_policy_statement
Deletes a policy statement from a resource policy.
Type annotations and code completion for session.client("lexv2-models").delete_resource_policy_statement
method.
boto3 documentation
await def delete_resource_policy_statement(
self,
*,
resourceArn: str,
statementId: str,
expectedRevisionId: str = ...,
) -> DeleteResourcePolicyStatementResponseTypeDef: # (1)
...
kwargs: DeleteResourcePolicyStatementRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"statementId": ...,
}
parent.delete_resource_policy_statement(**kwargs)
delete_slot
Deletes the specified slot from an intent.
Type annotations and code completion for session.client("lexv2-models").delete_slot
method.
boto3 documentation
await def delete_slot(
self,
*,
slotId: str,
botId: str,
botVersion: str,
localeId: str,
intentId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteSlotRequestRequestTypeDef = { # (1)
"slotId": ...,
"botId": ...,
"botVersion": ...,
"localeId": ...,
"intentId": ...,
}
parent.delete_slot(**kwargs)
delete_slot_type
Deletes a slot type from a bot locale.
Type annotations and code completion for session.client("lexv2-models").delete_slot_type
method.
boto3 documentation
await def delete_slot_type(
self,
*,
slotTypeId: str,
botId: str,
botVersion: str,
localeId: str,
skipResourceInUseCheck: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteSlotTypeRequestRequestTypeDef = { # (1)
"slotTypeId": ...,
"botId": ...,
"botVersion": ...,
"localeId": ...,
}
parent.delete_slot_type(**kwargs)
delete_utterances
Deletes stored utterances.
Type annotations and code completion for session.client("lexv2-models").delete_utterances
method.
boto3 documentation
await def delete_utterances(
self,
*,
botId: str,
localeId: str = ...,
sessionId: str = ...,
) -> Dict[str, Any]:
...
kwargs: DeleteUtterancesRequestRequestTypeDef = { # (1)
"botId": ...,
}
parent.delete_utterances(**kwargs)
describe_bot
Provides metadata information about a bot.
Type annotations and code completion for session.client("lexv2-models").describe_bot
method.
boto3 documentation
await def describe_bot(
self,
*,
botId: str,
) -> DescribeBotResponseTypeDef: # (1)
...
kwargs: DescribeBotRequestRequestTypeDef = { # (1)
"botId": ...,
}
parent.describe_bot(**kwargs)
describe_bot_alias
Get information about a specific bot alias.
Type annotations and code completion for session.client("lexv2-models").describe_bot_alias
method.
boto3 documentation
await def describe_bot_alias(
self,
*,
botAliasId: str,
botId: str,
) -> DescribeBotAliasResponseTypeDef: # (1)
...
kwargs: DescribeBotAliasRequestRequestTypeDef = { # (1)
"botAliasId": ...,
"botId": ...,
}
parent.describe_bot_alias(**kwargs)
describe_bot_locale
Describes the settings that a bot has for a specific locale.
Type annotations and code completion for session.client("lexv2-models").describe_bot_locale
method.
boto3 documentation
await def describe_bot_locale(
self,
*,
botId: str,
botVersion: str,
localeId: str,
) -> DescribeBotLocaleResponseTypeDef: # (1)
...
kwargs: DescribeBotLocaleRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
"localeId": ...,
}
parent.describe_bot_locale(**kwargs)
describe_bot_recommendation
Provides metadata information about a bot recommendation.
Type annotations and code completion for session.client("lexv2-models").describe_bot_recommendation
method.
boto3 documentation
await def describe_bot_recommendation(
self,
*,
botId: str,
botVersion: str,
localeId: str,
botRecommendationId: str,
) -> DescribeBotRecommendationResponseTypeDef: # (1)
...
kwargs: DescribeBotRecommendationRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
"localeId": ...,
"botRecommendationId": ...,
}
parent.describe_bot_recommendation(**kwargs)
describe_bot_version
Provides metadata about a version of a bot.
Type annotations and code completion for session.client("lexv2-models").describe_bot_version
method.
boto3 documentation
await def describe_bot_version(
self,
*,
botId: str,
botVersion: str,
) -> DescribeBotVersionResponseTypeDef: # (1)
...
kwargs: DescribeBotVersionRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
}
parent.describe_bot_version(**kwargs)
describe_custom_vocabulary_metadata
Provides metadata information about a custom vocabulary.
Type annotations and code completion for session.client("lexv2-models").describe_custom_vocabulary_metadata
method.
boto3 documentation
await def describe_custom_vocabulary_metadata(
self,
*,
botId: str,
botVersion: str,
localeId: str,
) -> DescribeCustomVocabularyMetadataResponseTypeDef: # (1)
...
kwargs: DescribeCustomVocabularyMetadataRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
"localeId": ...,
}
parent.describe_custom_vocabulary_metadata(**kwargs)
describe_export
Gets information about a specific export.
Type annotations and code completion for session.client("lexv2-models").describe_export
method.
boto3 documentation
await def describe_export(
self,
*,
exportId: str,
) -> DescribeExportResponseTypeDef: # (1)
...
kwargs: DescribeExportRequestRequestTypeDef = { # (1)
"exportId": ...,
}
parent.describe_export(**kwargs)
describe_import
Gets information about a specific import.
Type annotations and code completion for session.client("lexv2-models").describe_import
method.
boto3 documentation
await def describe_import(
self,
*,
importId: str,
) -> DescribeImportResponseTypeDef: # (1)
...
kwargs: DescribeImportRequestRequestTypeDef = { # (1)
"importId": ...,
}
parent.describe_import(**kwargs)
describe_intent
Returns metadata about an intent.
Type annotations and code completion for session.client("lexv2-models").describe_intent
method.
boto3 documentation
await def describe_intent(
self,
*,
intentId: str,
botId: str,
botVersion: str,
localeId: str,
) -> DescribeIntentResponseTypeDef: # (1)
...
kwargs: DescribeIntentRequestRequestTypeDef = { # (1)
"intentId": ...,
"botId": ...,
"botVersion": ...,
"localeId": ...,
}
parent.describe_intent(**kwargs)
describe_resource_policy
Gets the resource policy and policy revision for a bot or bot alias.
Type annotations and code completion for session.client("lexv2-models").describe_resource_policy
method.
boto3 documentation
await def describe_resource_policy(
self,
*,
resourceArn: str,
) -> DescribeResourcePolicyResponseTypeDef: # (1)
...
kwargs: DescribeResourcePolicyRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.describe_resource_policy(**kwargs)
describe_slot
Gets metadata information about a slot.
Type annotations and code completion for session.client("lexv2-models").describe_slot
method.
boto3 documentation
await def describe_slot(
self,
*,
slotId: str,
botId: str,
botVersion: str,
localeId: str,
intentId: str,
) -> DescribeSlotResponseTypeDef: # (1)
...
kwargs: DescribeSlotRequestRequestTypeDef = { # (1)
"slotId": ...,
"botId": ...,
"botVersion": ...,
"localeId": ...,
"intentId": ...,
}
parent.describe_slot(**kwargs)
describe_slot_type
Gets metadata information about a slot type.
Type annotations and code completion for session.client("lexv2-models").describe_slot_type
method.
boto3 documentation
await def describe_slot_type(
self,
*,
slotTypeId: str,
botId: str,
botVersion: str,
localeId: str,
) -> DescribeSlotTypeResponseTypeDef: # (1)
...
kwargs: DescribeSlotTypeRequestRequestTypeDef = { # (1)
"slotTypeId": ...,
"botId": ...,
"botVersion": ...,
"localeId": ...,
}
parent.describe_slot_type(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("lexv2-models").generate_presigned_url
method.
boto3 documentation
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
list_aggregated_utterances
Provides a list of utterances that users have sent to the bot.
Type annotations and code completion for session.client("lexv2-models").list_aggregated_utterances
method.
boto3 documentation
await def list_aggregated_utterances(
self,
*,
botId: str,
localeId: str,
aggregationDuration: UtteranceAggregationDurationTypeDef, # (1)
botAliasId: str = ...,
botVersion: str = ...,
sortBy: AggregatedUtterancesSortByTypeDef = ..., # (2)
filters: Sequence[AggregatedUtterancesFilterTypeDef] = ..., # (3)
maxResults: int = ...,
nextToken: str = ...,
) -> ListAggregatedUtterancesResponseTypeDef: # (4)
...
- See UtteranceAggregationDurationTypeDef
- See AggregatedUtterancesSortByTypeDef
- See AggregatedUtterancesFilterTypeDef
- See ListAggregatedUtterancesResponseTypeDef
kwargs: ListAggregatedUtterancesRequestRequestTypeDef = { # (1)
"botId": ...,
"localeId": ...,
"aggregationDuration": ...,
}
parent.list_aggregated_utterances(**kwargs)
list_bot_aliases
Gets a list of aliases for the specified bot.
Type annotations and code completion for session.client("lexv2-models").list_bot_aliases
method.
boto3 documentation
await def list_bot_aliases(
self,
*,
botId: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListBotAliasesResponseTypeDef: # (1)
...
kwargs: ListBotAliasesRequestRequestTypeDef = { # (1)
"botId": ...,
}
parent.list_bot_aliases(**kwargs)
list_bot_locales
Gets a list of locales for the specified bot.
Type annotations and code completion for session.client("lexv2-models").list_bot_locales
method.
boto3 documentation
await def list_bot_locales(
self,
*,
botId: str,
botVersion: str,
sortBy: BotLocaleSortByTypeDef = ..., # (1)
filters: Sequence[BotLocaleFilterTypeDef] = ..., # (2)
maxResults: int = ...,
nextToken: str = ...,
) -> ListBotLocalesResponseTypeDef: # (3)
...
kwargs: ListBotLocalesRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
}
parent.list_bot_locales(**kwargs)
list_bot_recommendations
Get a list of bot recommendations that meet the specified criteria.
Type annotations and code completion for session.client("lexv2-models").list_bot_recommendations
method.
boto3 documentation
await def list_bot_recommendations(
self,
*,
botId: str,
botVersion: str,
localeId: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListBotRecommendationsResponseTypeDef: # (1)
...
kwargs: ListBotRecommendationsRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
"localeId": ...,
}
parent.list_bot_recommendations(**kwargs)
list_bot_versions
Gets information about all of the versions of a bot.
Type annotations and code completion for session.client("lexv2-models").list_bot_versions
method.
boto3 documentation
await def list_bot_versions(
self,
*,
botId: str,
sortBy: BotVersionSortByTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListBotVersionsResponseTypeDef: # (2)
...
kwargs: ListBotVersionsRequestRequestTypeDef = { # (1)
"botId": ...,
}
parent.list_bot_versions(**kwargs)
list_bots
Gets a list of available bots.
Type annotations and code completion for session.client("lexv2-models").list_bots
method.
boto3 documentation
await def list_bots(
self,
*,
sortBy: BotSortByTypeDef = ..., # (1)
filters: Sequence[BotFilterTypeDef] = ..., # (2)
maxResults: int = ...,
nextToken: str = ...,
) -> ListBotsResponseTypeDef: # (3)
...
- See BotSortByTypeDef
- See BotFilterTypeDef
- See ListBotsResponseTypeDef
kwargs: ListBotsRequestRequestTypeDef = { # (1)
"sortBy": ...,
}
parent.list_bots(**kwargs)
list_built_in_intents
Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.
Type annotations and code completion for session.client("lexv2-models").list_built_in_intents
method.
boto3 documentation
await def list_built_in_intents(
self,
*,
localeId: str,
sortBy: BuiltInIntentSortByTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListBuiltInIntentsResponseTypeDef: # (2)
...
kwargs: ListBuiltInIntentsRequestRequestTypeDef = { # (1)
"localeId": ...,
}
parent.list_built_in_intents(**kwargs)
list_built_in_slot_types
Gets a list of built-in slot types that meet the specified criteria.
Type annotations and code completion for session.client("lexv2-models").list_built_in_slot_types
method.
boto3 documentation
await def list_built_in_slot_types(
self,
*,
localeId: str,
sortBy: BuiltInSlotTypeSortByTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListBuiltInSlotTypesResponseTypeDef: # (2)
...
kwargs: ListBuiltInSlotTypesRequestRequestTypeDef = { # (1)
"localeId": ...,
}
parent.list_built_in_slot_types(**kwargs)
list_exports
Lists the exports for a bot, bot locale, or custom vocabulary.
Type annotations and code completion for session.client("lexv2-models").list_exports
method.
boto3 documentation
await def list_exports(
self,
*,
botId: str = ...,
botVersion: str = ...,
sortBy: ExportSortByTypeDef = ..., # (1)
filters: Sequence[ExportFilterTypeDef] = ..., # (2)
maxResults: int = ...,
nextToken: str = ...,
localeId: str = ...,
) -> ListExportsResponseTypeDef: # (3)
...
kwargs: ListExportsRequestRequestTypeDef = { # (1)
"botId": ...,
}
parent.list_exports(**kwargs)
list_imports
Lists the imports for a bot, bot locale, or custom vocabulary.
Type annotations and code completion for session.client("lexv2-models").list_imports
method.
boto3 documentation
await def list_imports(
self,
*,
botId: str = ...,
botVersion: str = ...,
sortBy: ImportSortByTypeDef = ..., # (1)
filters: Sequence[ImportFilterTypeDef] = ..., # (2)
maxResults: int = ...,
nextToken: str = ...,
localeId: str = ...,
) -> ListImportsResponseTypeDef: # (3)
...
kwargs: ListImportsRequestRequestTypeDef = { # (1)
"botId": ...,
}
parent.list_imports(**kwargs)
list_intents
Get a list of intents that meet the specified criteria.
Type annotations and code completion for session.client("lexv2-models").list_intents
method.
boto3 documentation
await def list_intents(
self,
*,
botId: str,
botVersion: str,
localeId: str,
sortBy: IntentSortByTypeDef = ..., # (1)
filters: Sequence[IntentFilterTypeDef] = ..., # (2)
maxResults: int = ...,
nextToken: str = ...,
) -> ListIntentsResponseTypeDef: # (3)
...
kwargs: ListIntentsRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
"localeId": ...,
}
parent.list_intents(**kwargs)
list_recommended_intents
Gets a list of recommended intents provided by the bot recommendation that you can use in your bot.
Type annotations and code completion for session.client("lexv2-models").list_recommended_intents
method.
boto3 documentation
await def list_recommended_intents(
self,
*,
botId: str,
botVersion: str,
localeId: str,
botRecommendationId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListRecommendedIntentsResponseTypeDef: # (1)
...
kwargs: ListRecommendedIntentsRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
"localeId": ...,
"botRecommendationId": ...,
}
parent.list_recommended_intents(**kwargs)
list_slot_types
Gets a list of slot types that match the specified criteria.
Type annotations and code completion for session.client("lexv2-models").list_slot_types
method.
boto3 documentation
await def list_slot_types(
self,
*,
botId: str,
botVersion: str,
localeId: str,
sortBy: SlotTypeSortByTypeDef = ..., # (1)
filters: Sequence[SlotTypeFilterTypeDef] = ..., # (2)
maxResults: int = ...,
nextToken: str = ...,
) -> ListSlotTypesResponseTypeDef: # (3)
...
kwargs: ListSlotTypesRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
"localeId": ...,
}
parent.list_slot_types(**kwargs)
list_slots
Gets a list of slots that match the specified criteria.
Type annotations and code completion for session.client("lexv2-models").list_slots
method.
boto3 documentation
await def list_slots(
self,
*,
botId: str,
botVersion: str,
localeId: str,
intentId: str,
sortBy: SlotSortByTypeDef = ..., # (1)
filters: Sequence[SlotFilterTypeDef] = ..., # (2)
maxResults: int = ...,
nextToken: str = ...,
) -> ListSlotsResponseTypeDef: # (3)
...
kwargs: ListSlotsRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
"localeId": ...,
"intentId": ...,
}
parent.list_slots(**kwargs)
list_tags_for_resource
Gets a list of tags associated with a resource.
Type annotations and code completion for session.client("lexv2-models").list_tags_for_resource
method.
boto3 documentation
await def list_tags_for_resource(
self,
*,
resourceARN: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
search_associated_transcripts
Search for associated transcripts that meet the specified criteria.
Type annotations and code completion for session.client("lexv2-models").search_associated_transcripts
method.
boto3 documentation
await def search_associated_transcripts(
self,
*,
botId: str,
botVersion: str,
localeId: str,
botRecommendationId: str,
filters: Sequence[AssociatedTranscriptFilterTypeDef], # (1)
searchOrder: SearchOrderType = ..., # (2)
maxResults: int = ...,
nextIndex: int = ...,
) -> SearchAssociatedTranscriptsResponseTypeDef: # (3)
...
- See AssociatedTranscriptFilterTypeDef
- See SearchOrderType
- See SearchAssociatedTranscriptsResponseTypeDef
kwargs: SearchAssociatedTranscriptsRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
"localeId": ...,
"botRecommendationId": ...,
"filters": ...,
}
parent.search_associated_transcripts(**kwargs)
start_bot_recommendation
Use this to provide your transcript data, and to start the bot recommendation process.
Type annotations and code completion for session.client("lexv2-models").start_bot_recommendation
method.
boto3 documentation
await def start_bot_recommendation(
self,
*,
botId: str,
botVersion: str,
localeId: str,
transcriptSourceSetting: TranscriptSourceSettingTypeDef, # (1)
encryptionSetting: EncryptionSettingTypeDef = ..., # (2)
) -> StartBotRecommendationResponseTypeDef: # (3)
...
- See TranscriptSourceSettingTypeDef
- See EncryptionSettingTypeDef
- See StartBotRecommendationResponseTypeDef
kwargs: StartBotRecommendationRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
"localeId": ...,
"transcriptSourceSetting": ...,
}
parent.start_bot_recommendation(**kwargs)
start_import
Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.
Type annotations and code completion for session.client("lexv2-models").start_import
method.
boto3 documentation
await def start_import(
self,
*,
importId: str,
resourceSpecification: ImportResourceSpecificationTypeDef, # (1)
mergeStrategy: MergeStrategyType, # (2)
filePassword: str = ...,
) -> StartImportResponseTypeDef: # (3)
...
kwargs: StartImportRequestRequestTypeDef = { # (1)
"importId": ...,
"resourceSpecification": ...,
"mergeStrategy": ...,
}
parent.start_import(**kwargs)
stop_bot_recommendation
Stop an already running Bot Recommendation request.
Type annotations and code completion for session.client("lexv2-models").stop_bot_recommendation
method.
boto3 documentation
await def stop_bot_recommendation(
self,
*,
botId: str,
botVersion: str,
localeId: str,
botRecommendationId: str,
) -> StopBotRecommendationResponseTypeDef: # (1)
...
kwargs: StopBotRecommendationRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
"localeId": ...,
"botRecommendationId": ...,
}
parent.stop_bot_recommendation(**kwargs)
tag_resource
Adds the specified tags to the specified resource.
Type annotations and code completion for session.client("lexv2-models").tag_resource
method.
boto3 documentation
await def tag_resource(
self,
*,
resourceARN: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceARN": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes tags from a bot, bot alias, or bot channel.
Type annotations and code completion for session.client("lexv2-models").untag_resource
method.
boto3 documentation
await def untag_resource(
self,
*,
resourceARN: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceARN": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_bot
Updates the configuration of an existing bot.
Type annotations and code completion for session.client("lexv2-models").update_bot
method.
boto3 documentation
await def update_bot(
self,
*,
botId: str,
botName: str,
roleArn: str,
dataPrivacy: DataPrivacyTypeDef, # (1)
idleSessionTTLInSeconds: int,
description: str = ...,
) -> UpdateBotResponseTypeDef: # (2)
...
kwargs: UpdateBotRequestRequestTypeDef = { # (1)
"botId": ...,
"botName": ...,
"roleArn": ...,
"dataPrivacy": ...,
"idleSessionTTLInSeconds": ...,
}
parent.update_bot(**kwargs)
update_bot_alias
Updates the configuration of an existing bot alias.
Type annotations and code completion for session.client("lexv2-models").update_bot_alias
method.
boto3 documentation
await def update_bot_alias(
self,
*,
botAliasId: str,
botAliasName: str,
botId: str,
description: str = ...,
botVersion: str = ...,
botAliasLocaleSettings: Mapping[str, BotAliasLocaleSettingsTypeDef] = ..., # (1)
conversationLogSettings: ConversationLogSettingsTypeDef = ..., # (2)
sentimentAnalysisSettings: SentimentAnalysisSettingsTypeDef = ..., # (3)
) -> UpdateBotAliasResponseTypeDef: # (4)
...
- See BotAliasLocaleSettingsTypeDef
- See ConversationLogSettingsTypeDef
- See SentimentAnalysisSettingsTypeDef
- See UpdateBotAliasResponseTypeDef
kwargs: UpdateBotAliasRequestRequestTypeDef = { # (1)
"botAliasId": ...,
"botAliasName": ...,
"botId": ...,
}
parent.update_bot_alias(**kwargs)
update_bot_locale
Updates the settings that a bot has for a specific locale.
Type annotations and code completion for session.client("lexv2-models").update_bot_locale
method.
boto3 documentation
await def update_bot_locale(
self,
*,
botId: str,
botVersion: str,
localeId: str,
nluIntentConfidenceThreshold: float,
description: str = ...,
voiceSettings: VoiceSettingsTypeDef = ..., # (1)
) -> UpdateBotLocaleResponseTypeDef: # (2)
...
kwargs: UpdateBotLocaleRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
"localeId": ...,
"nluIntentConfidenceThreshold": ...,
}
parent.update_bot_locale(**kwargs)
update_bot_recommendation
Updates an existing bot recommendation request.
Type annotations and code completion for session.client("lexv2-models").update_bot_recommendation
method.
boto3 documentation
await def update_bot_recommendation(
self,
*,
botId: str,
botVersion: str,
localeId: str,
botRecommendationId: str,
encryptionSetting: EncryptionSettingTypeDef, # (1)
) -> UpdateBotRecommendationResponseTypeDef: # (2)
...
kwargs: UpdateBotRecommendationRequestRequestTypeDef = { # (1)
"botId": ...,
"botVersion": ...,
"localeId": ...,
"botRecommendationId": ...,
"encryptionSetting": ...,
}
parent.update_bot_recommendation(**kwargs)
update_export
Updates the password used to protect an export zip archive.
Type annotations and code completion for session.client("lexv2-models").update_export
method.
boto3 documentation
await def update_export(
self,
*,
exportId: str,
filePassword: str = ...,
) -> UpdateExportResponseTypeDef: # (1)
...
kwargs: UpdateExportRequestRequestTypeDef = { # (1)
"exportId": ...,
}
parent.update_export(**kwargs)
update_intent
Updates the settings for an intent.
Type annotations and code completion for session.client("lexv2-models").update_intent
method.
boto3 documentation
await def update_intent(
self,
*,
intentId: str,
intentName: str,
botId: str,
botVersion: str,
localeId: str,
description: str = ...,
parentIntentSignature: str = ...,
sampleUtterances: Sequence[SampleUtteranceTypeDef] = ..., # (1)
dialogCodeHook: DialogCodeHookSettingsTypeDef = ..., # (2)
fulfillmentCodeHook: FulfillmentCodeHookSettingsTypeDef = ..., # (3)
slotPriorities: Sequence[SlotPriorityTypeDef] = ..., # (4)
intentConfirmationSetting: IntentConfirmationSettingTypeDef = ..., # (5)
intentClosingSetting: IntentClosingSettingTypeDef = ..., # (6)
inputContexts: Sequence[InputContextTypeDef] = ..., # (7)
outputContexts: Sequence[OutputContextTypeDef] = ..., # (8)
kendraConfiguration: KendraConfigurationTypeDef = ..., # (9)
initialResponseSetting: InitialResponseSettingTypeDef = ..., # (10)
) -> UpdateIntentResponseTypeDef: # (11)
...
- See SampleUtteranceTypeDef
- See DialogCodeHookSettingsTypeDef
- See FulfillmentCodeHookSettingsTypeDef
- See SlotPriorityTypeDef
- See IntentConfirmationSettingTypeDef
- See IntentClosingSettingTypeDef
- See InputContextTypeDef
- See OutputContextTypeDef
- See KendraConfigurationTypeDef
- See InitialResponseSettingTypeDef
- See UpdateIntentResponseTypeDef
kwargs: UpdateIntentRequestRequestTypeDef = { # (1)
"intentId": ...,
"intentName": ...,
"botId": ...,
"botVersion": ...,
"localeId": ...,
}
parent.update_intent(**kwargs)
update_resource_policy
Replaces the existing resource policy for a bot or bot alias with a new one.
Type annotations and code completion for session.client("lexv2-models").update_resource_policy
method.
boto3 documentation
await def update_resource_policy(
self,
*,
resourceArn: str,
policy: str,
expectedRevisionId: str = ...,
) -> UpdateResourcePolicyResponseTypeDef: # (1)
...
kwargs: UpdateResourcePolicyRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"policy": ...,
}
parent.update_resource_policy(**kwargs)
update_slot
Updates the settings for a slot.
Type annotations and code completion for session.client("lexv2-models").update_slot
method.
boto3 documentation
await def update_slot(
self,
*,
slotId: str,
slotName: str,
valueElicitationSetting: SlotValueElicitationSettingTypeDef, # (1)
botId: str,
botVersion: str,
localeId: str,
intentId: str,
description: str = ...,
slotTypeId: str = ...,
obfuscationSetting: ObfuscationSettingTypeDef = ..., # (2)
multipleValuesSetting: MultipleValuesSettingTypeDef = ..., # (3)
) -> UpdateSlotResponseTypeDef: # (4)
...
- See SlotValueElicitationSettingTypeDef
- See ObfuscationSettingTypeDef
- See MultipleValuesSettingTypeDef
- See UpdateSlotResponseTypeDef
kwargs: UpdateSlotRequestRequestTypeDef = { # (1)
"slotId": ...,
"slotName": ...,
"valueElicitationSetting": ...,
"botId": ...,
"botVersion": ...,
"localeId": ...,
"intentId": ...,
}
parent.update_slot(**kwargs)
update_slot_type
Updates the configuration of an existing slot type.
Type annotations and code completion for session.client("lexv2-models").update_slot_type
method.
boto3 documentation
await def update_slot_type(
self,
*,
slotTypeId: str,
slotTypeName: str,
botId: str,
botVersion: str,
localeId: str,
description: str = ...,
slotTypeValues: Sequence[SlotTypeValueTypeDef] = ..., # (1)
valueSelectionSetting: SlotValueSelectionSettingTypeDef = ..., # (2)
parentSlotTypeSignature: str = ...,
externalSourceSetting: ExternalSourceSettingTypeDef = ..., # (3)
) -> UpdateSlotTypeResponseTypeDef: # (4)
...
- See SlotTypeValueTypeDef
- See SlotValueSelectionSettingTypeDef
- See ExternalSourceSettingTypeDef
- See UpdateSlotTypeResponseTypeDef
kwargs: UpdateSlotTypeRequestRequestTypeDef = { # (1)
"slotTypeId": ...,
"slotTypeName": ...,
"botId": ...,
"botVersion": ...,
"localeId": ...,
}
parent.update_slot_type(**kwargs)
__aenter__
Type annotations and code completion for session.client("lexv2-models").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("lexv2-models").__aexit__
method.
boto3 documentation
get_waiter
Type annotations and code completion for session.client("lexv2-models").get_waiter
method with overloads.
client.get_waiter("bot_alias_available")
-> BotAliasAvailableWaiterclient.get_waiter("bot_available")
-> BotAvailableWaiterclient.get_waiter("bot_export_completed")
-> BotExportCompletedWaiterclient.get_waiter("bot_import_completed")
-> BotImportCompletedWaiterclient.get_waiter("bot_locale_built")
-> BotLocaleBuiltWaiterclient.get_waiter("bot_locale_created")
-> BotLocaleCreatedWaiterclient.get_waiter("bot_locale_express_testing_available")
-> BotLocaleExpressTestingAvailableWaiterclient.get_waiter("bot_version_available")
-> BotVersionAvailableWaiter