Skip to content

LexModelsV2Client

Index > LexModelsV2 > LexModelsV2Client

Auto-generated documentation for LexModelsV2 type annotations stubs module mypy-boto3-lexv2-models.

LexModelsV2Client

Type annotations and code completion for boto3.client("lexv2-models"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_lexv2_models.client import LexModelsV2Client

def get_lexv2-models_client() -> LexModelsV2Client:
    return Session().client("lexv2-models")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("lexv2-models").exceptions structure.

Usage example
client = boto3.client("lexv2-models")

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)
Type checking example
from mypy_boto3_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 boto3.client("lexv2-models").build_bot_locale method. boto3 documentation

Method definition
def build_bot_locale(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
) -> BuildBotLocaleResponseTypeDef:  # (1)
    ...
  1. See BuildBotLocaleResponseTypeDef
Usage example with kwargs
kwargs: BuildBotLocaleRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.build_bot_locale(**kwargs)
  1. See BuildBotLocaleRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("lexv2-models").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("lexv2-models").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

create_bot

Creates an Amazon Lex conversational bot.

Type annotations and code completion for boto3.client("lexv2-models").create_bot method. boto3 documentation

Method definition
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)
    ...
  1. See DataPrivacyTypeDef
  2. See CreateBotResponseTypeDef
Usage example with kwargs
kwargs: CreateBotRequestRequestTypeDef = {  # (1)
    "botName": ...,
    "roleArn": ...,
    "dataPrivacy": ...,
    "idleSessionTTLInSeconds": ...,
}

parent.create_bot(**kwargs)
  1. See CreateBotRequestRequestTypeDef

create_bot_alias

Creates an alias for the specified version of a bot.

Type annotations and code completion for boto3.client("lexv2-models").create_bot_alias method. boto3 documentation

Method definition
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)
    ...
  1. See BotAliasLocaleSettingsTypeDef
  2. See ConversationLogSettingsTypeDef
  3. See SentimentAnalysisSettingsTypeDef
  4. See CreateBotAliasResponseTypeDef
Usage example with kwargs
kwargs: CreateBotAliasRequestRequestTypeDef = {  # (1)
    "botAliasName": ...,
    "botId": ...,
}

parent.create_bot_alias(**kwargs)
  1. See CreateBotAliasRequestRequestTypeDef

create_bot_locale

Creates a locale in the bot.

Type annotations and code completion for boto3.client("lexv2-models").create_bot_locale method. boto3 documentation

Method definition
def create_bot_locale(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    nluIntentConfidenceThreshold: float,
    description: str = ...,
    voiceSettings: VoiceSettingsTypeDef = ...,  # (1)
) -> CreateBotLocaleResponseTypeDef:  # (2)
    ...
  1. See VoiceSettingsTypeDef
  2. See CreateBotLocaleResponseTypeDef
Usage example with kwargs
kwargs: CreateBotLocaleRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "nluIntentConfidenceThreshold": ...,
}

parent.create_bot_locale(**kwargs)
  1. See CreateBotLocaleRequestRequestTypeDef

create_bot_version

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

Type annotations and code completion for boto3.client("lexv2-models").create_bot_version method. boto3 documentation

Method definition
def create_bot_version(
    self,
    *,
    botId: str,
    botVersionLocaleSpecification: Mapping[str, BotVersionLocaleDetailsTypeDef],  # (1)
    description: str = ...,
) -> CreateBotVersionResponseTypeDef:  # (2)
    ...
  1. See BotVersionLocaleDetailsTypeDef
  2. See CreateBotVersionResponseTypeDef
Usage example with kwargs
kwargs: CreateBotVersionRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersionLocaleSpecification": ...,
}

parent.create_bot_version(**kwargs)
  1. See CreateBotVersionRequestRequestTypeDef

create_export

Creates a zip archive containing the contents of a bot or a bot locale.

Type annotations and code completion for boto3.client("lexv2-models").create_export method. boto3 documentation

Method definition
def create_export(
    self,
    *,
    resourceSpecification: ExportResourceSpecificationTypeDef,  # (1)
    fileFormat: ImportExportFileFormatType,  # (2)
    filePassword: str = ...,
) -> CreateExportResponseTypeDef:  # (3)
    ...
  1. See ExportResourceSpecificationTypeDef
  2. See ImportExportFileFormatType
  3. See CreateExportResponseTypeDef
Usage example with kwargs
kwargs: CreateExportRequestRequestTypeDef = {  # (1)
    "resourceSpecification": ...,
    "fileFormat": ...,
}

parent.create_export(**kwargs)
  1. See CreateExportRequestRequestTypeDef

create_intent

Creates an intent.

Type annotations and code completion for boto3.client("lexv2-models").create_intent method. boto3 documentation

Method definition
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)
    ...
  1. See SampleUtteranceTypeDef
  2. See DialogCodeHookSettingsTypeDef
  3. See FulfillmentCodeHookSettingsTypeDef
  4. See IntentConfirmationSettingTypeDef
  5. See IntentClosingSettingTypeDef
  6. See InputContextTypeDef
  7. See OutputContextTypeDef
  8. See KendraConfigurationTypeDef
  9. See InitialResponseSettingTypeDef
  10. See CreateIntentResponseTypeDef
Usage example with kwargs
kwargs: CreateIntentRequestRequestTypeDef = {  # (1)
    "intentName": ...,
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.create_intent(**kwargs)
  1. See CreateIntentRequestRequestTypeDef

create_resource_policy

Creates a new resource policy with the specified policy statements.

Type annotations and code completion for boto3.client("lexv2-models").create_resource_policy method. boto3 documentation

Method definition
def create_resource_policy(
    self,
    *,
    resourceArn: str,
    policy: str,
) -> CreateResourcePolicyResponseTypeDef:  # (1)
    ...
  1. See CreateResourcePolicyResponseTypeDef
Usage example with kwargs
kwargs: CreateResourcePolicyRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "policy": ...,
}

parent.create_resource_policy(**kwargs)
  1. See CreateResourcePolicyRequestRequestTypeDef

create_resource_policy_statement

Adds a new resource policy statement to a bot or bot alias.

Type annotations and code completion for boto3.client("lexv2-models").create_resource_policy_statement method. boto3 documentation

Method definition
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)
    ...
  1. See EffectType
  2. See PrincipalTypeDef
  3. See CreateResourcePolicyStatementResponseTypeDef
Usage example with kwargs
kwargs: CreateResourcePolicyStatementRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "statementId": ...,
    "effect": ...,
    "principal": ...,
    "action": ...,
}

parent.create_resource_policy_statement(**kwargs)
  1. See CreateResourcePolicyStatementRequestRequestTypeDef

create_slot

Creates a slot in an intent.

Type annotations and code completion for boto3.client("lexv2-models").create_slot method. boto3 documentation

Method definition
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)
    subSlotSetting: SubSlotSettingTypeDef = ...,  # (4)
) -> CreateSlotResponseTypeDef:  # (5)
    ...
  1. See SlotValueElicitationSettingTypeDef
  2. See ObfuscationSettingTypeDef
  3. See MultipleValuesSettingTypeDef
  4. See SubSlotSettingTypeDef
  5. See CreateSlotResponseTypeDef
Usage example with kwargs
kwargs: CreateSlotRequestRequestTypeDef = {  # (1)
    "slotName": ...,
    "valueElicitationSetting": ...,
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "intentId": ...,
}

parent.create_slot(**kwargs)
  1. See CreateSlotRequestRequestTypeDef

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 boto3.client("lexv2-models").create_slot_type method. boto3 documentation

Method definition
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)
    compositeSlotTypeSetting: CompositeSlotTypeSettingTypeDef = ...,  # (4)
) -> CreateSlotTypeResponseTypeDef:  # (5)
    ...
  1. See SlotTypeValueTypeDef
  2. See SlotValueSelectionSettingTypeDef
  3. See ExternalSourceSettingTypeDef
  4. See CompositeSlotTypeSettingTypeDef
  5. See CreateSlotTypeResponseTypeDef
Usage example with kwargs
kwargs: CreateSlotTypeRequestRequestTypeDef = {  # (1)
    "slotTypeName": ...,
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.create_slot_type(**kwargs)
  1. See CreateSlotTypeRequestRequestTypeDef

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 boto3.client("lexv2-models").create_upload_url method. boto3 documentation

Method definition
def create_upload_url(
    self,
) -> CreateUploadUrlResponseTypeDef:  # (1)
    ...
  1. See CreateUploadUrlResponseTypeDef

delete_bot

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

Type annotations and code completion for boto3.client("lexv2-models").delete_bot method. boto3 documentation

Method definition
def delete_bot(
    self,
    *,
    botId: str,
    skipResourceInUseCheck: bool = ...,
) -> DeleteBotResponseTypeDef:  # (1)
    ...
  1. See DeleteBotResponseTypeDef
Usage example with kwargs
kwargs: DeleteBotRequestRequestTypeDef = {  # (1)
    "botId": ...,
}

parent.delete_bot(**kwargs)
  1. See DeleteBotRequestRequestTypeDef

delete_bot_alias

Deletes the specified bot alias.

Type annotations and code completion for boto3.client("lexv2-models").delete_bot_alias method. boto3 documentation

Method definition
def delete_bot_alias(
    self,
    *,
    botAliasId: str,
    botId: str,
    skipResourceInUseCheck: bool = ...,
) -> DeleteBotAliasResponseTypeDef:  # (1)
    ...
  1. See DeleteBotAliasResponseTypeDef
Usage example with kwargs
kwargs: DeleteBotAliasRequestRequestTypeDef = {  # (1)
    "botAliasId": ...,
    "botId": ...,
}

parent.delete_bot_alias(**kwargs)
  1. See DeleteBotAliasRequestRequestTypeDef

delete_bot_locale

Removes a locale from a bot.

Type annotations and code completion for boto3.client("lexv2-models").delete_bot_locale method. boto3 documentation

Method definition
def delete_bot_locale(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
) -> DeleteBotLocaleResponseTypeDef:  # (1)
    ...
  1. See DeleteBotLocaleResponseTypeDef
Usage example with kwargs
kwargs: DeleteBotLocaleRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.delete_bot_locale(**kwargs)
  1. See DeleteBotLocaleRequestRequestTypeDef

delete_bot_version

Deletes a specific version of a bot.

Type annotations and code completion for boto3.client("lexv2-models").delete_bot_version method. boto3 documentation

Method definition
def delete_bot_version(
    self,
    *,
    botId: str,
    botVersion: str,
    skipResourceInUseCheck: bool = ...,
) -> DeleteBotVersionResponseTypeDef:  # (1)
    ...
  1. See DeleteBotVersionResponseTypeDef
Usage example with kwargs
kwargs: DeleteBotVersionRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
}

parent.delete_bot_version(**kwargs)
  1. See DeleteBotVersionRequestRequestTypeDef

delete_custom_vocabulary

Removes a custom vocabulary from the specified locale in the specified bot.

Type annotations and code completion for boto3.client("lexv2-models").delete_custom_vocabulary method. boto3 documentation

Method definition
def delete_custom_vocabulary(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
) -> DeleteCustomVocabularyResponseTypeDef:  # (1)
    ...
  1. See DeleteCustomVocabularyResponseTypeDef
Usage example with kwargs
kwargs: DeleteCustomVocabularyRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.delete_custom_vocabulary(**kwargs)
  1. See DeleteCustomVocabularyRequestRequestTypeDef

delete_export

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

Type annotations and code completion for boto3.client("lexv2-models").delete_export method. boto3 documentation

Method definition
def delete_export(
    self,
    *,
    exportId: str,
) -> DeleteExportResponseTypeDef:  # (1)
    ...
  1. See DeleteExportResponseTypeDef
Usage example with kwargs
kwargs: DeleteExportRequestRequestTypeDef = {  # (1)
    "exportId": ...,
}

parent.delete_export(**kwargs)
  1. See DeleteExportRequestRequestTypeDef

delete_import

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

Type annotations and code completion for boto3.client("lexv2-models").delete_import method. boto3 documentation

Method definition
def delete_import(
    self,
    *,
    importId: str,
) -> DeleteImportResponseTypeDef:  # (1)
    ...
  1. See DeleteImportResponseTypeDef
Usage example with kwargs
kwargs: DeleteImportRequestRequestTypeDef = {  # (1)
    "importId": ...,
}

parent.delete_import(**kwargs)
  1. See DeleteImportRequestRequestTypeDef

delete_intent

Removes the specified intent.

Type annotations and code completion for boto3.client("lexv2-models").delete_intent method. boto3 documentation

Method definition
def delete_intent(
    self,
    *,
    intentId: str,
    botId: str,
    botVersion: str,
    localeId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteIntentRequestRequestTypeDef = {  # (1)
    "intentId": ...,
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.delete_intent(**kwargs)
  1. See DeleteIntentRequestRequestTypeDef

delete_resource_policy

Removes an existing policy from a bot or bot alias.

Type annotations and code completion for boto3.client("lexv2-models").delete_resource_policy method. boto3 documentation

Method definition
def delete_resource_policy(
    self,
    *,
    resourceArn: str,
    expectedRevisionId: str = ...,
) -> DeleteResourcePolicyResponseTypeDef:  # (1)
    ...
  1. See DeleteResourcePolicyResponseTypeDef
Usage example with kwargs
kwargs: DeleteResourcePolicyRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.delete_resource_policy(**kwargs)
  1. See DeleteResourcePolicyRequestRequestTypeDef

delete_resource_policy_statement

Deletes a policy statement from a resource policy.

Type annotations and code completion for boto3.client("lexv2-models").delete_resource_policy_statement method. boto3 documentation

Method definition
def delete_resource_policy_statement(
    self,
    *,
    resourceArn: str,
    statementId: str,
    expectedRevisionId: str = ...,
) -> DeleteResourcePolicyStatementResponseTypeDef:  # (1)
    ...
  1. See DeleteResourcePolicyStatementResponseTypeDef
Usage example with kwargs
kwargs: DeleteResourcePolicyStatementRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "statementId": ...,
}

parent.delete_resource_policy_statement(**kwargs)
  1. See DeleteResourcePolicyStatementRequestRequestTypeDef

delete_slot

Deletes the specified slot from an intent.

Type annotations and code completion for boto3.client("lexv2-models").delete_slot method. boto3 documentation

Method definition
def delete_slot(
    self,
    *,
    slotId: str,
    botId: str,
    botVersion: str,
    localeId: str,
    intentId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteSlotRequestRequestTypeDef = {  # (1)
    "slotId": ...,
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "intentId": ...,
}

parent.delete_slot(**kwargs)
  1. See DeleteSlotRequestRequestTypeDef

delete_slot_type

Deletes a slot type from a bot locale.

Type annotations and code completion for boto3.client("lexv2-models").delete_slot_type method. boto3 documentation

Method definition
def delete_slot_type(
    self,
    *,
    slotTypeId: str,
    botId: str,
    botVersion: str,
    localeId: str,
    skipResourceInUseCheck: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteSlotTypeRequestRequestTypeDef = {  # (1)
    "slotTypeId": ...,
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.delete_slot_type(**kwargs)
  1. See DeleteSlotTypeRequestRequestTypeDef

delete_utterances

Deletes stored utterances.

Type annotations and code completion for boto3.client("lexv2-models").delete_utterances method. boto3 documentation

Method definition
def delete_utterances(
    self,
    *,
    botId: str,
    localeId: str = ...,
    sessionId: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteUtterancesRequestRequestTypeDef = {  # (1)
    "botId": ...,
}

parent.delete_utterances(**kwargs)
  1. See DeleteUtterancesRequestRequestTypeDef

describe_bot

Provides metadata information about a bot.

Type annotations and code completion for boto3.client("lexv2-models").describe_bot method. boto3 documentation

Method definition
def describe_bot(
    self,
    *,
    botId: str,
) -> DescribeBotResponseTypeDef:  # (1)
    ...
  1. See DescribeBotResponseTypeDef
Usage example with kwargs
kwargs: DescribeBotRequestRequestTypeDef = {  # (1)
    "botId": ...,
}

parent.describe_bot(**kwargs)
  1. See DescribeBotRequestRequestTypeDef

describe_bot_alias

Get information about a specific bot alias.

Type annotations and code completion for boto3.client("lexv2-models").describe_bot_alias method. boto3 documentation

Method definition
def describe_bot_alias(
    self,
    *,
    botAliasId: str,
    botId: str,
) -> DescribeBotAliasResponseTypeDef:  # (1)
    ...
  1. See DescribeBotAliasResponseTypeDef
Usage example with kwargs
kwargs: DescribeBotAliasRequestRequestTypeDef = {  # (1)
    "botAliasId": ...,
    "botId": ...,
}

parent.describe_bot_alias(**kwargs)
  1. See DescribeBotAliasRequestRequestTypeDef

describe_bot_locale

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

Type annotations and code completion for boto3.client("lexv2-models").describe_bot_locale method. boto3 documentation

Method definition
def describe_bot_locale(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
) -> DescribeBotLocaleResponseTypeDef:  # (1)
    ...
  1. See DescribeBotLocaleResponseTypeDef
Usage example with kwargs
kwargs: DescribeBotLocaleRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.describe_bot_locale(**kwargs)
  1. See DescribeBotLocaleRequestRequestTypeDef

describe_bot_recommendation

Provides metadata information about a bot recommendation.

Type annotations and code completion for boto3.client("lexv2-models").describe_bot_recommendation method. boto3 documentation

Method definition
def describe_bot_recommendation(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    botRecommendationId: str,
) -> DescribeBotRecommendationResponseTypeDef:  # (1)
    ...
  1. See DescribeBotRecommendationResponseTypeDef
Usage example with kwargs
kwargs: DescribeBotRecommendationRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "botRecommendationId": ...,
}

parent.describe_bot_recommendation(**kwargs)
  1. See DescribeBotRecommendationRequestRequestTypeDef

describe_bot_version

Provides metadata about a version of a bot.

Type annotations and code completion for boto3.client("lexv2-models").describe_bot_version method. boto3 documentation

Method definition
def describe_bot_version(
    self,
    *,
    botId: str,
    botVersion: str,
) -> DescribeBotVersionResponseTypeDef:  # (1)
    ...
  1. See DescribeBotVersionResponseTypeDef
Usage example with kwargs
kwargs: DescribeBotVersionRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
}

parent.describe_bot_version(**kwargs)
  1. See DescribeBotVersionRequestRequestTypeDef

describe_custom_vocabulary_metadata

Provides metadata information about a custom vocabulary.

Type annotations and code completion for boto3.client("lexv2-models").describe_custom_vocabulary_metadata method. boto3 documentation

Method definition
def describe_custom_vocabulary_metadata(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
) -> DescribeCustomVocabularyMetadataResponseTypeDef:  # (1)
    ...
  1. See DescribeCustomVocabularyMetadataResponseTypeDef
Usage example with kwargs
kwargs: DescribeCustomVocabularyMetadataRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.describe_custom_vocabulary_metadata(**kwargs)
  1. See DescribeCustomVocabularyMetadataRequestRequestTypeDef

describe_export

Gets information about a specific export.

Type annotations and code completion for boto3.client("lexv2-models").describe_export method. boto3 documentation

Method definition
def describe_export(
    self,
    *,
    exportId: str,
) -> DescribeExportResponseTypeDef:  # (1)
    ...
  1. See DescribeExportResponseTypeDef
Usage example with kwargs
kwargs: DescribeExportRequestRequestTypeDef = {  # (1)
    "exportId": ...,
}

parent.describe_export(**kwargs)
  1. See DescribeExportRequestRequestTypeDef

describe_import

Gets information about a specific import.

Type annotations and code completion for boto3.client("lexv2-models").describe_import method. boto3 documentation

Method definition
def describe_import(
    self,
    *,
    importId: str,
) -> DescribeImportResponseTypeDef:  # (1)
    ...
  1. See DescribeImportResponseTypeDef
Usage example with kwargs
kwargs: DescribeImportRequestRequestTypeDef = {  # (1)
    "importId": ...,
}

parent.describe_import(**kwargs)
  1. See DescribeImportRequestRequestTypeDef

describe_intent

Returns metadata about an intent.

Type annotations and code completion for boto3.client("lexv2-models").describe_intent method. boto3 documentation

Method definition
def describe_intent(
    self,
    *,
    intentId: str,
    botId: str,
    botVersion: str,
    localeId: str,
) -> DescribeIntentResponseTypeDef:  # (1)
    ...
  1. See DescribeIntentResponseTypeDef
Usage example with kwargs
kwargs: DescribeIntentRequestRequestTypeDef = {  # (1)
    "intentId": ...,
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.describe_intent(**kwargs)
  1. See DescribeIntentRequestRequestTypeDef

describe_resource_policy

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

Type annotations and code completion for boto3.client("lexv2-models").describe_resource_policy method. boto3 documentation

Method definition
def describe_resource_policy(
    self,
    *,
    resourceArn: str,
) -> DescribeResourcePolicyResponseTypeDef:  # (1)
    ...
  1. See DescribeResourcePolicyResponseTypeDef
Usage example with kwargs
kwargs: DescribeResourcePolicyRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.describe_resource_policy(**kwargs)
  1. See DescribeResourcePolicyRequestRequestTypeDef

describe_slot

Gets metadata information about a slot.

Type annotations and code completion for boto3.client("lexv2-models").describe_slot method. boto3 documentation

Method definition
def describe_slot(
    self,
    *,
    slotId: str,
    botId: str,
    botVersion: str,
    localeId: str,
    intentId: str,
) -> DescribeSlotResponseTypeDef:  # (1)
    ...
  1. See DescribeSlotResponseTypeDef
Usage example with kwargs
kwargs: DescribeSlotRequestRequestTypeDef = {  # (1)
    "slotId": ...,
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "intentId": ...,
}

parent.describe_slot(**kwargs)
  1. See DescribeSlotRequestRequestTypeDef

describe_slot_type

Gets metadata information about a slot type.

Type annotations and code completion for boto3.client("lexv2-models").describe_slot_type method. boto3 documentation

Method definition
def describe_slot_type(
    self,
    *,
    slotTypeId: str,
    botId: str,
    botVersion: str,
    localeId: str,
) -> DescribeSlotTypeResponseTypeDef:  # (1)
    ...
  1. See DescribeSlotTypeResponseTypeDef
Usage example with kwargs
kwargs: DescribeSlotTypeRequestRequestTypeDef = {  # (1)
    "slotTypeId": ...,
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.describe_slot_type(**kwargs)
  1. See DescribeSlotTypeRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("lexv2-models").generate_presigned_url method. boto3 documentation

Method definition
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 boto3.client("lexv2-models").list_aggregated_utterances method. boto3 documentation

Method definition
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)
    ...
  1. See UtteranceAggregationDurationTypeDef
  2. See AggregatedUtterancesSortByTypeDef
  3. See AggregatedUtterancesFilterTypeDef
  4. See ListAggregatedUtterancesResponseTypeDef
Usage example with kwargs
kwargs: ListAggregatedUtterancesRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "localeId": ...,
    "aggregationDuration": ...,
}

parent.list_aggregated_utterances(**kwargs)
  1. See ListAggregatedUtterancesRequestRequestTypeDef

list_bot_aliases

Gets a list of aliases for the specified bot.

Type annotations and code completion for boto3.client("lexv2-models").list_bot_aliases method. boto3 documentation

Method definition
def list_bot_aliases(
    self,
    *,
    botId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListBotAliasesResponseTypeDef:  # (1)
    ...
  1. See ListBotAliasesResponseTypeDef
Usage example with kwargs
kwargs: ListBotAliasesRequestRequestTypeDef = {  # (1)
    "botId": ...,
}

parent.list_bot_aliases(**kwargs)
  1. See ListBotAliasesRequestRequestTypeDef

list_bot_locales

Gets a list of locales for the specified bot.

Type annotations and code completion for boto3.client("lexv2-models").list_bot_locales method. boto3 documentation

Method definition
def list_bot_locales(
    self,
    *,
    botId: str,
    botVersion: str,
    sortBy: BotLocaleSortByTypeDef = ...,  # (1)
    filters: Sequence[BotLocaleFilterTypeDef] = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListBotLocalesResponseTypeDef:  # (3)
    ...
  1. See BotLocaleSortByTypeDef
  2. See BotLocaleFilterTypeDef
  3. See ListBotLocalesResponseTypeDef
Usage example with kwargs
kwargs: ListBotLocalesRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
}

parent.list_bot_locales(**kwargs)
  1. See ListBotLocalesRequestRequestTypeDef

list_bot_recommendations

Get a list of bot recommendations that meet the specified criteria.

Type annotations and code completion for boto3.client("lexv2-models").list_bot_recommendations method. boto3 documentation

Method definition
def list_bot_recommendations(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListBotRecommendationsResponseTypeDef:  # (1)
    ...
  1. See ListBotRecommendationsResponseTypeDef
Usage example with kwargs
kwargs: ListBotRecommendationsRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.list_bot_recommendations(**kwargs)
  1. See ListBotRecommendationsRequestRequestTypeDef

list_bot_versions

Gets information about all of the versions of a bot.

Type annotations and code completion for boto3.client("lexv2-models").list_bot_versions method. boto3 documentation

Method definition
def list_bot_versions(
    self,
    *,
    botId: str,
    sortBy: BotVersionSortByTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListBotVersionsResponseTypeDef:  # (2)
    ...
  1. See BotVersionSortByTypeDef
  2. See ListBotVersionsResponseTypeDef
Usage example with kwargs
kwargs: ListBotVersionsRequestRequestTypeDef = {  # (1)
    "botId": ...,
}

parent.list_bot_versions(**kwargs)
  1. See ListBotVersionsRequestRequestTypeDef

list_bots

Gets a list of available bots.

Type annotations and code completion for boto3.client("lexv2-models").list_bots method. boto3 documentation

Method definition
def list_bots(
    self,
    *,
    sortBy: BotSortByTypeDef = ...,  # (1)
    filters: Sequence[BotFilterTypeDef] = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListBotsResponseTypeDef:  # (3)
    ...
  1. See BotSortByTypeDef
  2. See BotFilterTypeDef
  3. See ListBotsResponseTypeDef
Usage example with kwargs
kwargs: ListBotsRequestRequestTypeDef = {  # (1)
    "sortBy": ...,
}

parent.list_bots(**kwargs)
  1. See ListBotsRequestRequestTypeDef

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 boto3.client("lexv2-models").list_built_in_intents method. boto3 documentation

Method definition
def list_built_in_intents(
    self,
    *,
    localeId: str,
    sortBy: BuiltInIntentSortByTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListBuiltInIntentsResponseTypeDef:  # (2)
    ...
  1. See BuiltInIntentSortByTypeDef
  2. See ListBuiltInIntentsResponseTypeDef
Usage example with kwargs
kwargs: ListBuiltInIntentsRequestRequestTypeDef = {  # (1)
    "localeId": ...,
}

parent.list_built_in_intents(**kwargs)
  1. See ListBuiltInIntentsRequestRequestTypeDef

list_built_in_slot_types

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

Type annotations and code completion for boto3.client("lexv2-models").list_built_in_slot_types method. boto3 documentation

Method definition
def list_built_in_slot_types(
    self,
    *,
    localeId: str,
    sortBy: BuiltInSlotTypeSortByTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListBuiltInSlotTypesResponseTypeDef:  # (2)
    ...
  1. See BuiltInSlotTypeSortByTypeDef
  2. See ListBuiltInSlotTypesResponseTypeDef
Usage example with kwargs
kwargs: ListBuiltInSlotTypesRequestRequestTypeDef = {  # (1)
    "localeId": ...,
}

parent.list_built_in_slot_types(**kwargs)
  1. See ListBuiltInSlotTypesRequestRequestTypeDef

list_exports

Lists the exports for a bot, bot locale, or custom vocabulary.

Type annotations and code completion for boto3.client("lexv2-models").list_exports method. boto3 documentation

Method definition
def list_exports(
    self,
    *,
    botId: str = ...,
    botVersion: str = ...,
    sortBy: ExportSortByTypeDef = ...,  # (1)
    filters: Sequence[ExportFilterTypeDef] = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
    localeId: str = ...,
) -> ListExportsResponseTypeDef:  # (3)
    ...
  1. See ExportSortByTypeDef
  2. See ExportFilterTypeDef
  3. See ListExportsResponseTypeDef
Usage example with kwargs
kwargs: ListExportsRequestRequestTypeDef = {  # (1)
    "botId": ...,
}

parent.list_exports(**kwargs)
  1. See ListExportsRequestRequestTypeDef

list_imports

Lists the imports for a bot, bot locale, or custom vocabulary.

Type annotations and code completion for boto3.client("lexv2-models").list_imports method. boto3 documentation

Method definition
def list_imports(
    self,
    *,
    botId: str = ...,
    botVersion: str = ...,
    sortBy: ImportSortByTypeDef = ...,  # (1)
    filters: Sequence[ImportFilterTypeDef] = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
    localeId: str = ...,
) -> ListImportsResponseTypeDef:  # (3)
    ...
</