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

# LexModelsV2Client 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.

# Exceptions.exceptions usage example

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

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.PreconditionFailedException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_lexv2_models.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

can_paginate#

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

# can_paginate method definition

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

generate_presigned_url#

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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

batch_create_custom_vocabulary_item#

Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.

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

# batch_create_custom_vocabulary_item method definition

def batch_create_custom_vocabulary_item(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    customVocabularyItemList: Sequence[NewCustomVocabularyItemTypeDef],  # (1)
) -> BatchCreateCustomVocabularyItemResponseTypeDef:  # (2)
    ...
  1. See NewCustomVocabularyItemTypeDef
  2. See BatchCreateCustomVocabularyItemResponseTypeDef
# batch_create_custom_vocabulary_item method usage example with argument unpacking

kwargs: BatchCreateCustomVocabularyItemRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "customVocabularyItemList": ...,
}

parent.batch_create_custom_vocabulary_item(**kwargs)
  1. See BatchCreateCustomVocabularyItemRequestRequestTypeDef

batch_delete_custom_vocabulary_item#

Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.

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

# batch_delete_custom_vocabulary_item method definition

def batch_delete_custom_vocabulary_item(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    customVocabularyItemList: Sequence[CustomVocabularyEntryIdTypeDef],  # (1)
) -> BatchDeleteCustomVocabularyItemResponseTypeDef:  # (2)
    ...
  1. See CustomVocabularyEntryIdTypeDef
  2. See BatchDeleteCustomVocabularyItemResponseTypeDef
# batch_delete_custom_vocabulary_item method usage example with argument unpacking

kwargs: BatchDeleteCustomVocabularyItemRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "customVocabularyItemList": ...,
}

parent.batch_delete_custom_vocabulary_item(**kwargs)
  1. See BatchDeleteCustomVocabularyItemRequestRequestTypeDef

batch_update_custom_vocabulary_item#

Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.

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

# batch_update_custom_vocabulary_item method definition

def batch_update_custom_vocabulary_item(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    customVocabularyItemList: Sequence[CustomVocabularyItemTypeDef],  # (1)
) -> BatchUpdateCustomVocabularyItemResponseTypeDef:  # (2)
    ...
  1. See CustomVocabularyItemTypeDef
  2. See BatchUpdateCustomVocabularyItemResponseTypeDef
# batch_update_custom_vocabulary_item method usage example with argument unpacking

kwargs: BatchUpdateCustomVocabularyItemRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "customVocabularyItemList": ...,
}

parent.batch_update_custom_vocabulary_item(**kwargs)
  1. See BatchUpdateCustomVocabularyItemRequestRequestTypeDef

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

# build_bot_locale method definition

def build_bot_locale(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
) -> BuildBotLocaleResponseTypeDef:  # (1)
    ...
  1. See BuildBotLocaleResponseTypeDef
# build_bot_locale method usage example with argument unpacking

kwargs: BuildBotLocaleRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

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

create_bot#

Creates an Amazon Lex conversational bot.

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

# create_bot 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] = ...,
    botType: BotTypeType = ...,  # (2)
    botMembers: Sequence[BotMemberTypeDef] = ...,  # (3)
) -> CreateBotResponseTypeDef:  # (4)
    ...
  1. See DataPrivacyTypeDef
  2. See BotTypeType
  3. See BotMemberTypeDef
  4. See CreateBotResponseTypeDef
# create_bot method usage example with argument unpacking

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

# create_bot_alias 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
# create_bot_alias method usage example with argument unpacking

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

# create_bot_locale method definition

def create_bot_locale(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    nluIntentConfidenceThreshold: float,
    description: str = ...,
    voiceSettings: VoiceSettingsTypeDef = ...,  # (1)
    generativeAISettings: GenerativeAISettingsTypeDef = ...,  # (2)
) -> CreateBotLocaleResponseTypeDef:  # (3)
    ...
  1. See VoiceSettingsTypeDef
  2. See GenerativeAISettingsTypeDef
  3. See CreateBotLocaleResponseTypeDef
# create_bot_locale method usage example with argument unpacking

kwargs: CreateBotLocaleRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "nluIntentConfidenceThreshold": ...,
}

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

create_bot_replica#

Action to create a replication of the source bot in the secondary region.

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

# create_bot_replica method definition

def create_bot_replica(
    self,
    *,
    botId: str,
    replicaRegion: str,
) -> CreateBotReplicaResponseTypeDef:  # (1)
    ...
  1. See CreateBotReplicaResponseTypeDef
# create_bot_replica method usage example with argument unpacking

kwargs: CreateBotReplicaRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "replicaRegion": ...,
}

parent.create_bot_replica(**kwargs)
  1. See CreateBotReplicaRequestRequestTypeDef

create_bot_version#

Creates an immutable version of the bot.

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

# create_bot_version method definition

def create_bot_version(
    self,
    *,
    botId: str,
    botVersionLocaleSpecification: Mapping[str, BotVersionLocaleDetailsTypeDef],  # (1)
    description: str = ...,
) -> CreateBotVersionResponseTypeDef:  # (2)
    ...
  1. See BotVersionLocaleDetailsTypeDef
  2. See CreateBotVersionResponseTypeDef
# create_bot_version method usage example with argument unpacking

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

# create_export 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
# create_export method usage example with argument unpacking

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

# create_intent 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)
    qnAIntentConfiguration: QnAIntentConfigurationTypeDef = ...,  # (10)
) -> CreateIntentResponseTypeDef:  # (11)
    ...
  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 QnAIntentConfigurationTypeDef
  11. See CreateIntentResponseTypeDef
# create_intent method usage example with argument unpacking

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

# create_resource_policy method definition

def create_resource_policy(
    self,
    *,
    resourceArn: str,
    policy: str,
) -> CreateResourcePolicyResponseTypeDef:  # (1)
    ...
  1. See CreateResourcePolicyResponseTypeDef
# create_resource_policy method usage example with argument unpacking

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

# create_resource_policy_statement 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
# create_resource_policy_statement method usage example with argument unpacking

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

# create_slot 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
# create_slot method usage example with argument unpacking

kwargs: CreateSlotRequestRequestTypeDef = {  # (1)
    "slotName": ...,
    "valueElicitationSetting": ...,
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "intentId": ...,
}

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

create_slot_type#

Creates a custom slot type.

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

# create_slot_type method definition

def create_slot_type(
    self,
    *,
    slotTypeName: str,
    botId: str,
    botVersion: str,
    localeId: str,
    description: str = ...,
    slotTypeValues: Sequence[SlotTypeValueUnionTypeDef] = ...,  # (1)
    valueSelectionSetting: SlotValueSelectionSettingTypeDef = ...,  # (2)
    parentSlotTypeSignature: str = ...,
    externalSourceSetting: ExternalSourceSettingTypeDef = ...,  # (3)
    compositeSlotTypeSetting: CompositeSlotTypeSettingTypeDef = ...,  # (4)
) -> CreateSlotTypeResponseTypeDef:  # (5)
    ...
  1. See SlotTypeValueTypeDef SlotTypeValueOutputTypeDef
  2. See SlotValueSelectionSettingTypeDef
  3. See ExternalSourceSettingTypeDef
  4. See CompositeSlotTypeSettingTypeDef
  5. See CreateSlotTypeResponseTypeDef
# create_slot_type method usage example with argument unpacking

kwargs: CreateSlotTypeRequestRequestTypeDef = {  # (1)
    "slotTypeName": ...,
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

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

create_test_set_discrepancy_report#

Create a report that describes the differences between the bot and the test set.

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

# create_test_set_discrepancy_report method definition

def create_test_set_discrepancy_report(
    self,
    *,
    testSetId: str,
    target: TestSetDiscrepancyReportResourceTargetTypeDef,  # (1)
) -> CreateTestSetDiscrepancyReportResponseTypeDef:  # (2)
    ...
  1. See TestSetDiscrepancyReportResourceTargetTypeDef
  2. See CreateTestSetDiscrepancyReportResponseTypeDef
# create_test_set_discrepancy_report method usage example with argument unpacking

kwargs: CreateTestSetDiscrepancyReportRequestRequestTypeDef = {  # (1)
    "testSetId": ...,
    "target": ...,
}

parent.create_test_set_discrepancy_report(**kwargs)
  1. See CreateTestSetDiscrepancyReportRequestRequestTypeDef

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

# create_upload_url 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

# delete_bot method definition

def delete_bot(
    self,
    *,
    botId: str,
    skipResourceInUseCheck: bool = ...,
) -> DeleteBotResponseTypeDef:  # (1)
    ...
  1. See DeleteBotResponseTypeDef
# delete_bot method usage example with argument unpacking

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

# delete_bot_alias method definition

def delete_bot_alias(
    self,
    *,
    botAliasId: str,
    botId: str,
    skipResourceInUseCheck: bool = ...,
) -> DeleteBotAliasResponseTypeDef:  # (1)
    ...
  1. See DeleteBotAliasResponseTypeDef
# delete_bot_alias method usage example with argument unpacking

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

# delete_bot_locale method definition

def delete_bot_locale(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
) -> DeleteBotLocaleResponseTypeDef:  # (1)
    ...
  1. See DeleteBotLocaleResponseTypeDef
# delete_bot_locale method usage example with argument unpacking

kwargs: DeleteBotLocaleRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

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

delete_bot_replica#

The action to delete the replicated bot in the secondary region.

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

# delete_bot_replica method definition

def delete_bot_replica(
    self,
    *,
    botId: str,
    replicaRegion: str,
) -> DeleteBotReplicaResponseTypeDef:  # (1)
    ...
  1. See DeleteBotReplicaResponseTypeDef
# delete_bot_replica method usage example with argument unpacking

kwargs: DeleteBotReplicaRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "replicaRegion": ...,
}

parent.delete_bot_replica(**kwargs)
  1. See DeleteBotReplicaRequestRequestTypeDef

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

# delete_bot_version method definition

def delete_bot_version(
    self,
    *,
    botId: str,
    botVersion: str,
    skipResourceInUseCheck: bool = ...,
) -> DeleteBotVersionResponseTypeDef:  # (1)
    ...
  1. See DeleteBotVersionResponseTypeDef
# delete_bot_version method usage example with argument unpacking

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

# delete_custom_vocabulary method definition

def delete_custom_vocabulary(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
) -> DeleteCustomVocabularyResponseTypeDef:  # (1)
    ...
  1. See DeleteCustomVocabularyResponseTypeDef
# delete_custom_vocabulary method usage example with argument unpacking

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

# delete_export method definition

def delete_export(
    self,
    *,
    exportId: str,
) -> DeleteExportResponseTypeDef:  # (1)
    ...
  1. See DeleteExportResponseTypeDef
# delete_export method usage example with argument unpacking

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

# delete_import method definition

def delete_import(
    self,
    *,
    importId: str,
) -> DeleteImportResponseTypeDef:  # (1)
    ...
  1. See DeleteImportResponseTypeDef
# delete_import method usage example with argument unpacking

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

# delete_intent method definition

def delete_intent(
    self,
    *,
    intentId: str,
    botId: str,
    botVersion: str,
    localeId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_intent method usage example with argument unpacking

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

# delete_resource_policy method definition

def delete_resource_policy(
    self,
    *,
    resourceArn: str,
    expectedRevisionId: str = ...,
) -> DeleteResourcePolicyResponseTypeDef:  # (1)
    ...
  1. See DeleteResourcePolicyResponseTypeDef
# delete_resource_policy method usage example with argument unpacking

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

# delete_resource_policy_statement method definition

def delete_resource_policy_statement(
    self,
    *,
    resourceArn: str,
    statementId: str,
    expectedRevisionId: str = ...,
) -> DeleteResourcePolicyStatementResponseTypeDef:  # (1)
    ...
  1. See DeleteResourcePolicyStatementResponseTypeDef
# delete_resource_policy_statement method usage example with argument unpacking

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

# delete_slot method definition

def delete_slot(
    self,
    *,
    slotId: str,
    botId: str,
    botVersion: str,
    localeId: str,
    intentId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_slot method usage example with argument unpacking

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

# delete_slot_type method definition

def delete_slot_type(
    self,
    *,
    slotTypeId: str,
    botId: str,
    botVersion: str,
    localeId: str,
    skipResourceInUseCheck: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_slot_type method usage example with argument unpacking

kwargs: DeleteSlotTypeRequestRequestTypeDef = {  # (1)
    "slotTypeId": ...,
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

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

delete_test_set#

The action to delete the selected test set.

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

# delete_test_set method definition

def delete_test_set(
    self,
    *,
    testSetId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_test_set method usage example with argument unpacking

kwargs: DeleteTestSetRequestRequestTypeDef = {  # (1)
    "testSetId": ...,
}

parent.delete_test_set(**kwargs)
  1. See DeleteTestSetRequestRequestTypeDef

delete_utterances#

Deletes stored utterances.

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

# delete_utterances method definition

def delete_utterances(
    self,
    *,
    botId: str,
    localeId: str = ...,
    sessionId: str = ...,
) -> dict[str, Any]:
    ...
# delete_utterances method usage example with argument unpacking

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

# describe_bot method definition

def describe_bot(
    self,
    *,
    botId: str,
) -> DescribeBotResponseTypeDef:  # (1)
    ...
  1. See DescribeBotResponseTypeDef
# describe_bot method usage example with argument unpacking

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

# describe_bot_alias method definition

def describe_bot_alias(
    self,
    *,
    botAliasId: str,
    botId: str,
) -> DescribeBotAliasResponseTypeDef:  # (1)
    ...
  1. See DescribeBotAliasResponseTypeDef
# describe_bot_alias method usage example with argument unpacking

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

# describe_bot_locale method definition

def describe_bot_locale(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
) -> DescribeBotLocaleResponseTypeDef:  # (1)
    ...
  1. See DescribeBotLocaleResponseTypeDef
# describe_bot_locale method usage example with argument unpacking

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

# describe_bot_recommendation method definition

def describe_bot_recommendation(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    botRecommendationId: str,
) -> DescribeBotRecommendationResponseTypeDef:  # (1)
    ...
  1. See DescribeBotRecommendationResponseTypeDef
# describe_bot_recommendation method usage example with argument unpacking

kwargs: DescribeBotRecommendationRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "botRecommendationId": ...,
}

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

describe_bot_replica#

Monitors the bot replication status through the UI console.

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

# describe_bot_replica method definition

def describe_bot_replica(
    self,
    *,
    botId: str,
    replicaRegion: str,
) -> DescribeBotReplicaResponseTypeDef:  # (1)
    ...
  1. See DescribeBotReplicaResponseTypeDef
# describe_bot_replica method usage example with argument unpacking

kwargs: DescribeBotReplicaRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "replicaRegion": ...,
}

parent.describe_bot_replica(**kwargs)
  1. See DescribeBotReplicaRequestRequestTypeDef

describe_bot_resource_generation#

Returns information about a request to generate a bot through natural language description, made through the StartBotResource API.

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

# describe_bot_resource_generation method definition

def describe_bot_resource_generation(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    generationId: str,
) -> DescribeBotResourceGenerationResponseTypeDef:  # (1)
    ...
  1. See DescribeBotResourceGenerationResponseTypeDef
# describe_bot_resource_generation method usage example with argument unpacking

kwargs: DescribeBotResourceGenerationRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "generationId": ...,
}

parent.describe_bot_resource_generation(**kwargs)
  1. See DescribeBotResourceGenerationRequestRequestTypeDef

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

# describe_bot_version method definition

def describe_bot_version(
    self,
    *,
    botId: str,
    botVersion: str,
) -> DescribeBotVersionResponseTypeDef:  # (1)
    ...
  1. See DescribeBotVersionResponseTypeDef
# describe_bot_version method usage example with argument unpacking

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

# describe_custom_vocabulary_metadata method definition

def describe_custom_vocabulary_metadata(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
) -> DescribeCustomVocabularyMetadataResponseTypeDef:  # (1)
    ...
  1. See DescribeCustomVocabularyMetadataResponseTypeDef
# describe_custom_vocabulary_metadata method usage example with argument unpacking

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

# describe_export method definition

def describe_export(
    self,
    *,
    exportId: str,
) -> DescribeExportResponseTypeDef:  # (1)
    ...
  1. See DescribeExportResponseTypeDef
# describe_export method usage example with argument unpacking

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

# describe_import method definition

def describe_import(
    self,
    *,
    importId: str,
) -> DescribeImportResponseTypeDef:  # (1)
    ...
  1. See DescribeImportResponseTypeDef
# describe_import method usage example with argument unpacking

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

# describe_intent method definition

def describe_intent(
    self,
    *,
    intentId: str,
    botId: str,
    botVersion: str,
    localeId: str,
) -> DescribeIntentResponseTypeDef:  # (1)
    ...
  1. See DescribeIntentResponseTypeDef
# describe_intent method usage example with argument unpacking

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

# describe_resource_policy method definition

def describe_resource_policy(
    self,
    *,
    resourceArn: str,
) -> DescribeResourcePolicyResponseTypeDef:  # (1)
    ...
  1. See DescribeResourcePolicyResponseTypeDef
# describe_resource_policy method usage example with argument unpacking

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

# describe_slot method definition

def describe_slot(
    self,
    *,
    slotId: str,
    botId: str,
    botVersion: str,
    localeId: str,
    intentId: str,
) -> DescribeSlotResponseTypeDef:  # (1)
    ...
  1. See DescribeSlotResponseTypeDef
# describe_slot method usage example with argument unpacking

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

# describe_slot_type method definition

def describe_slot_type(
    self,
    *,
    slotTypeId: str,
    botId: str,
    botVersion: str,
    localeId: str,
) -> DescribeSlotTypeResponseTypeDef:  # (1)
    ...
  1. See DescribeSlotTypeResponseTypeDef
# describe_slot_type method usage example with argument unpacking

kwargs: DescribeSlotTypeRequestRequestTypeDef = {  # (1)
    "slotTypeId": ...,
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

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

describe_test_execution#

Gets metadata information about the test execution.

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

# describe_test_execution method definition

def describe_test_execution(
    self,
    *,
    testExecutionId: str,
) -> DescribeTestExecutionResponseTypeDef:  # (1)
    ...
  1. See DescribeTestExecutionResponseTypeDef
# describe_test_execution method usage example with argument unpacking

kwargs: DescribeTestExecutionRequestRequestTypeDef = {  # (1)
    "testExecutionId": ...,
}

parent.describe_test_execution(**kwargs)
  1. See DescribeTestExecutionRequestRequestTypeDef

describe_test_set#

Gets metadata information about the test set.

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

# describe_test_set method definition

def describe_test_set(
    self,
    *,
    testSetId: str,
) -> DescribeTestSetResponseTypeDef:  # (1)
    ...
  1. See DescribeTestSetResponseTypeDef
# describe_test_set method usage example with argument unpacking

kwargs: DescribeTestSetRequestRequestTypeDef = {  # (1)
    "testSetId": ...,
}

parent.describe_test_set(**kwargs)
  1. See DescribeTestSetRequestRequestTypeDef

describe_test_set_discrepancy_report#

Gets metadata information about the test set discrepancy report.

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

# describe_test_set_discrepancy_report method definition

def describe_test_set_discrepancy_report(
    self,
    *,
    testSetDiscrepancyReportId: str,
) -> DescribeTestSetDiscrepancyReportResponseTypeDef:  # (1)
    ...
  1. See DescribeTestSetDiscrepancyReportResponseTypeDef
# describe_test_set_discrepancy_report method usage example with argument unpacking

kwargs: DescribeTestSetDiscrepancyReportRequestRequestTypeDef = {  # (1)
    "testSetDiscrepancyReportId": ...,
}

parent.describe_test_set_discrepancy_report(**kwargs)
  1. See DescribeTestSetDiscrepancyReportRequestRequestTypeDef

describe_test_set_generation#

Gets metadata information about the test set generation.

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

# describe_test_set_generation method definition

def describe_test_set_generation(
    self,
    *,
    testSetGenerationId: str,
) -> DescribeTestSetGenerationResponseTypeDef:  # (1)
    ...
  1. See DescribeTestSetGenerationResponseTypeDef
# describe_test_set_generation method usage example with argument unpacking

kwargs: DescribeTestSetGenerationRequestRequestTypeDef = {  # (1)
    "testSetGenerationId": ...,
}

parent.describe_test_set_generation(**kwargs)
  1. See DescribeTestSetGenerationRequestRequestTypeDef

generate_bot_element#

Generates sample utterances for an intent.

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

# generate_bot_element method definition

def generate_bot_element(
    self,
    *,
    intentId: str,
    botId: str,
    botVersion: str,
    localeId: str,
) -> GenerateBotElementResponseTypeDef:  # (1)
    ...
  1. See GenerateBotElementResponseTypeDef
# generate_bot_element method usage example with argument unpacking

kwargs: GenerateBotElementRequestRequestTypeDef = {  # (1)
    "intentId": ...,
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.generate_bot_element(**kwargs)
  1. See GenerateBotElementRequestRequestTypeDef

get_test_execution_artifacts_url#

The pre-signed Amazon S3 URL to download the test execution result artifacts.

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

# get_test_execution_artifacts_url method definition

def get_test_execution_artifacts_url(
    self,
    *,
    testExecutionId: str,
) -> GetTestExecutionArtifactsUrlResponseTypeDef:  # (1)
    ...
  1. See GetTestExecutionArtifactsUrlResponseTypeDef
# get_test_execution_artifacts_url method usage example with argument unpacking

kwargs: GetTestExecutionArtifactsUrlRequestRequestTypeDef = {  # (1)
    "testExecutionId": ...,
}

parent.get_test_execution_artifacts_url(**kwargs)
  1. See GetTestExecutionArtifactsUrlRequestRequestTypeDef

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

# list_aggregated_utterances 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
# list_aggregated_utterances method usage example with argument unpacking

kwargs: ListAggregatedUtterancesRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "localeId": ...,
    "aggregationDuration": ...,
}

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

list_bot_alias_replicas#

The action to list the replicated bots created from the source bot alias.

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

# list_bot_alias_replicas method definition

def list_bot_alias_replicas(
    self,
    *,
    botId: str,
    replicaRegion: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListBotAliasReplicasResponseTypeDef:  # (1)
    ...
  1. See ListBotAliasReplicasResponseTypeDef
# list_bot_alias_replicas method usage example with argument unpacking

kwargs: ListBotAliasReplicasRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "replicaRegion": ...,
}

parent.list_bot_alias_replicas(**kwargs)
  1. See ListBotAliasReplicasRequestRequestTypeDef

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

# list_bot_aliases method definition

def list_bot_aliases(
    self,
    *,
    botId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListBotAliasesResponseTypeDef:  # (1)
    ...
  1. See ListBotAliasesResponseTypeDef
# list_bot_aliases method usage example with argument unpacking

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

# list_bot_locales 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
# list_bot_locales method usage example with argument unpacking

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

# list_bot_recommendations method definition

def list_bot_recommendations(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListBotRecommendationsResponseTypeDef:  # (1)
    ...
  1. See ListBotRecommendationsResponseTypeDef
# list_bot_recommendations method usage example with argument unpacking

kwargs: ListBotRecommendationsRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

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

list_bot_replicas#

The action to list the replicated bots.

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

# list_bot_replicas method definition

def list_bot_replicas(
    self,
    *,
    botId: str,
) -> ListBotReplicasResponseTypeDef:  # (1)
    ...
  1. See ListBotReplicasResponseTypeDef
# list_bot_replicas method usage example with argument unpacking

kwargs: ListBotReplicasRequestRequestTypeDef = {  # (1)
    "botId": ...,
}

parent.list_bot_replicas(**kwargs)
  1. See ListBotReplicasRequestRequestTypeDef

list_bot_resource_generations#

Lists the generation requests made for a bot locale.

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

# list_bot_resource_generations method definition

def list_bot_resource_generations(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    sortBy: GenerationSortByTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListBotResourceGenerationsResponseTypeDef:  # (2)
    ...
  1. See GenerationSortByTypeDef
  2. See ListBotResourceGenerationsResponseTypeDef
# list_bot_resource_generations method usage example with argument unpacking

kwargs: ListBotResourceGenerationsRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.list_bot_resource_generations(**kwargs)
  1. See ListBotResourceGenerationsRequestRequestTypeDef

list_bot_version_replicas#

Contains information about all the versions replication statuses applicable for Global Resiliency.

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

# list_bot_version_replicas method definition

def list_bot_version_replicas(
    self,
    *,
    botId: str,
    replicaRegion: str,
    maxResults: int = ...,
    nextToken: str = ...,
    sortBy: BotVersionReplicaSortByTypeDef = ...,  # (1)
) -> ListBotVersionReplicasResponseTypeDef:  # (2)
    ...
  1. See BotVersionReplicaSortByTypeDef
  2. See ListBotVersionReplicasResponseTypeDef
# list_bot_version_replicas method usage example with argument unpacking

kwargs: ListBotVersionReplicasRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "replicaRegion": ...,
}

parent.list_bot_version_replicas(**kwargs)
  1. See ListBotVersionReplicasRequestRequestTypeDef

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

# list_bot_versions method definition

def list_bot_versions(
    self,
    *,
    botId: str,
    sortBy: BotVersionSortByTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListBotVersionsResponseTypeDef:  # (2)
    ...
  1. See BotVersionSortByTypeDef
  2. See ListBotVersionsResponseTypeDef
# list_bot_versions method usage example with argument unpacking

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

# list_bots 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
# list_bots method usage example with argument unpacking

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

# list_built_in_intents 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
# list_built_in_intents method usage example with argument unpacking

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

# list_built_in_slot_types 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
# list_built_in_slot_types method usage example with argument unpacking

kwargs: ListBuiltInSlotTypesRequestRequestTypeDef = {  # (1)
    "localeId": ...,
}

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

list_custom_vocabulary_items#

Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.

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

# list_custom_vocabulary_items method definition

def list_custom_vocabulary_items(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListCustomVocabularyItemsResponseTypeDef:  # (1)
    ...
  1. See ListCustomVocabularyItemsResponseTypeDef
# list_custom_vocabulary_items method usage example with argument unpacking

kwargs: ListCustomVocabularyItemsRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.list_custom_vocabulary_items(**kwargs)
  1. See ListCustomVocabularyItemsRequestRequestTypeDef

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

# list_exports 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
# list_exports method usage example with argument unpacking

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

# list_imports 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)
    ...
  1. See ImportSortByTypeDef
  2. See ImportFilterTypeDef
  3. See ListImportsResponseTypeDef
# list_imports method usage example with argument unpacking

kwargs: ListImportsRequestRequestTypeDef = {  # (1)
    "botId": ...,
}

parent.list_imports(**kwargs)
  1. See ListImportsRequestRequestTypeDef

list_intent_metrics#

Retrieves summary metrics for the intents in your bot.

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

# list_intent_metrics method definition

def list_intent_metrics(
    self,
    *,
    botId: str,
    startDateTime: TimestampTypeDef,
    endDateTime: TimestampTypeDef,
    metrics: Sequence[AnalyticsIntentMetricTypeDef],  # (1)
    binBy: Sequence[AnalyticsBinBySpecificationTypeDef] = ...,  # (2)
    groupBy: Sequence[AnalyticsIntentGroupBySpecificationTypeDef] = ...,  # (3)
    filters: Sequence[AnalyticsIntentFilterTypeDef] = ...,  # (4)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListIntentMetricsResponseTypeDef:  # (5)
    ...
  1. See AnalyticsIntentMetricTypeDef
  2. See AnalyticsBinBySpecificationTypeDef
  3. See AnalyticsIntentGroupBySpecificationTypeDef
  4. See AnalyticsIntentFilterTypeDef
  5. See ListIntentMetricsResponseTypeDef
# list_intent_metrics method usage example with argument unpacking

kwargs: ListIntentMetricsRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "startDateTime": ...,
    "endDateTime": ...,
    "metrics": ...,
}

parent.list_intent_metrics(**kwargs)
  1. See ListIntentMetricsRequestRequestTypeDef

list_intent_paths#

Retrieves summary statistics for a path of intents that users take over sessions with your bot.

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

# list_intent_paths method definition

def list_intent_paths(
    self,
    *,
    botId: str,
    startDateTime: TimestampTypeDef,
    endDateTime: TimestampTypeDef,
    intentPath: str,
    filters: Sequence[AnalyticsPathFilterTypeDef] = ...,  # (1)
) -> ListIntentPathsResponseTypeDef:  # (2)
    ...
  1. See AnalyticsPathFilterTypeDef
  2. See ListIntentPathsResponseTypeDef
# list_intent_paths method usage example with argument unpacking

kwargs: ListIntentPathsRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "startDateTime": ...,
    "endDateTime": ...,
    "intentPath": ...,
}

parent.list_intent_paths(**kwargs)
  1. See ListIntentPathsRequestRequestTypeDef

list_intent_stage_metrics#

Retrieves summary metrics for the stages within intents in your bot.

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

# list_intent_stage_metrics method definition

def list_intent_stage_metrics(
    self,
    *,
    botId: str,
    startDateTime: TimestampTypeDef,
    endDateTime: TimestampTypeDef,
    metrics: Sequence[AnalyticsIntentStageMetricTypeDef],  # (1)
    binBy: Sequence[AnalyticsBinBySpecificationTypeDef] = ...,  # (2)
    groupBy: Sequence[AnalyticsIntentStageGroupBySpecificationTypeDef] = ...,  # (3)
    filters: Sequence[AnalyticsIntentStageFilterTypeDef] = ...,  # (4)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListIntentStageMetricsResponseTypeDef:  # (5)
    ...
  1. See AnalyticsIntentStageMetricTypeDef
  2. See AnalyticsBinBySpecificationTypeDef
  3. See AnalyticsIntentStageGroupBySpecificationTypeDef
  4. See AnalyticsIntentStageFilterTypeDef
  5. See ListIntentStageMetricsResponseTypeDef
# list_intent_stage_metrics method usage example with argument unpacking

kwargs: ListIntentStageMetricsRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "startDateTime": ...,
    "endDateTime": ...,
    "metrics": ...,
}

parent.list_intent_stage_metrics(**kwargs)
  1. See ListIntentStageMetricsRequestRequestTypeDef

list_intents#

Get a list of intents that meet the specified criteria.

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

# list_intents method definition

def list_intents(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    sortBy: IntentSortByTypeDef = ...,  # (1)
    filters: Sequence[IntentFilterTypeDef] = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListIntentsResponseTypeDef:  # (3)
    ...
  1. See IntentSortByTypeDef
  2. See IntentFilterTypeDef
  3. See ListIntentsResponseTypeDef
# list_intents method usage example with argument unpacking

kwargs: ListIntentsRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.list_intents(**kwargs)
  1. See ListIntentsRequestRequestTypeDef

Gets a list of recommended intents provided by the bot recommendation that you can use in your bot.

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

# list_recommended_intents method definition

def list_recommended_intents(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    botRecommendationId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListRecommendedIntentsResponseTypeDef:  # (1)
    ...
  1. See ListRecommendedIntentsResponseTypeDef
# list_recommended_intents method usage example with argument unpacking

kwargs: ListRecommendedIntentsRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "botRecommendationId": ...,
}

parent.list_recommended_intents(**kwargs)
  1. See ListRecommendedIntentsRequestRequestTypeDef

list_session_analytics_data#

Retrieves a list of metadata for individual user sessions with your bot.

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

# list_session_analytics_data method definition

def list_session_analytics_data(
    self,
    *,
    botId: str,
    startDateTime: TimestampTypeDef,
    endDateTime: TimestampTypeDef,
    sortBy: SessionDataSortByTypeDef = ...,  # (1)
    filters: Sequence[AnalyticsSessionFilterTypeDef] = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSessionAnalyticsDataResponseTypeDef:  # (3)
    ...
  1. See SessionDataSortByTypeDef
  2. See AnalyticsSessionFilterTypeDef
  3. See ListSessionAnalyticsDataResponseTypeDef
# list_session_analytics_data method usage example with argument unpacking

kwargs: ListSessionAnalyticsDataRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "startDateTime": ...,
    "endDateTime": ...,
}

parent.list_session_analytics_data(**kwargs)
  1. See ListSessionAnalyticsDataRequestRequestTypeDef

list_session_metrics#

Retrieves summary metrics for the user sessions with your bot.

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

# list_session_metrics method definition

def list_session_metrics(
    self,
    *,
    botId: str,
    startDateTime: TimestampTypeDef,
    endDateTime: TimestampTypeDef,
    metrics: Sequence[AnalyticsSessionMetricTypeDef],  # (1)
    binBy: Sequence[AnalyticsBinBySpecificationTypeDef] = ...,  # (2)
    groupBy: Sequence[AnalyticsSessionGroupBySpecificationTypeDef] = ...,  # (3)
    filters: Sequence[AnalyticsSessionFilterTypeDef] = ...,  # (4)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSessionMetricsResponseTypeDef:  # (5)
    ...
  1. See AnalyticsSessionMetricTypeDef
  2. See AnalyticsBinBySpecificationTypeDef
  3. See AnalyticsSessionGroupBySpecificationTypeDef
  4. See AnalyticsSessionFilterTypeDef
  5. See ListSessionMetricsResponseTypeDef
# list_session_metrics method usage example with argument unpacking

kwargs: ListSessionMetricsRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "startDateTime": ...,
    "endDateTime": ...,
    "metrics": ...,
}

parent.list_session_metrics(**kwargs)
  1. See ListSessionMetricsRequestRequestTypeDef

list_slot_types#

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

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

# list_slot_types method definition

def list_slot_types(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    sortBy: SlotTypeSortByTypeDef = ...,  # (1)
    filters: Sequence[SlotTypeFilterTypeDef] = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSlotTypesResponseTypeDef:  # (3)
    ...
  1. See SlotTypeSortByTypeDef
  2. See SlotTypeFilterTypeDef
  3. See ListSlotTypesResponseTypeDef
# list_slot_types method usage example with argument unpacking

kwargs: ListSlotTypesRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.list_slot_types(**kwargs)
  1. See ListSlotTypesRequestRequestTypeDef

list_slots#

Gets a list of slots that match the specified criteria.

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

# list_slots method definition

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)
    ...
  1. See SlotSortByTypeDef
  2. See SlotFilterTypeDef
  3. See ListSlotsResponseTypeDef
# list_slots method usage example with argument unpacking

kwargs: ListSlotsRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "intentId": ...,
}

parent.list_slots(**kwargs)
  1. See ListSlotsRequestRequestTypeDef

list_tags_for_resource#

Gets a list of tags associated with a resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

list_test_execution_result_items#

Gets a list of test execution result items.

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

# list_test_execution_result_items method definition

def list_test_execution_result_items(
    self,
    *,
    testExecutionId: str,
    resultFilterBy: TestExecutionResultFilterByTypeDef,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTestExecutionResultItemsResponseTypeDef:  # (2)
    ...
  1. See TestExecutionResultFilterByTypeDef
  2. See ListTestExecutionResultItemsResponseTypeDef
# list_test_execution_result_items method usage example with argument unpacking

kwargs: ListTestExecutionResultItemsRequestRequestTypeDef = {  # (1)
    "testExecutionId": ...,
    "resultFilterBy": ...,
}

parent.list_test_execution_result_items(**kwargs)
  1. See ListTestExecutionResultItemsRequestRequestTypeDef

list_test_executions#

The list of test set executions.

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

# list_test_executions method definition

def list_test_executions(
    self,
    *,
    sortBy: TestExecutionSortByTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTestExecutionsResponseTypeDef:  # (2)
    ...
  1. See TestExecutionSortByTypeDef
  2. See ListTestExecutionsResponseTypeDef
# list_test_executions method usage example with argument unpacking

kwargs: ListTestExecutionsRequestRequestTypeDef = {  # (1)
    "sortBy": ...,
}

parent.list_test_executions(**kwargs)
  1. See ListTestExecutionsRequestRequestTypeDef

list_test_set_records#

The list of test set records.

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

# list_test_set_records method definition

def list_test_set_records(
    self,
    *,
    testSetId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTestSetRecordsResponseTypeDef:  # (1)
    ...
  1. See ListTestSetRecordsResponseTypeDef
# list_test_set_records method usage example with argument unpacking

kwargs: ListTestSetRecordsRequestRequestTypeDef = {  # (1)
    "testSetId": ...,
}

parent.list_test_set_records(**kwargs)
  1. See ListTestSetRecordsRequestRequestTypeDef

list_test_sets#

The list of the test sets.

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

# list_test_sets method definition

def list_test_sets(
    self,
    *,
    sortBy: TestSetSortByTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTestSetsResponseTypeDef:  # (2)
    ...
  1. See TestSetSortByTypeDef
  2. See ListTestSetsResponseTypeDef
# list_test_sets method usage example with argument unpacking

kwargs: ListTestSetsRequestRequestTypeDef = {  # (1)
    "sortBy": ...,
}

parent.list_test_sets(**kwargs)
  1. See ListTestSetsRequestRequestTypeDef

list_utterance_analytics_data#

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics.

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

# list_utterance_analytics_data method definition

def list_utterance_analytics_data(
    self,
    *,
    botId: str,
    startDateTime: TimestampTypeDef,
    endDateTime: TimestampTypeDef,
    sortBy: UtteranceDataSortByTypeDef = ...,  # (1)
    filters: Sequence[AnalyticsUtteranceFilterTypeDef] = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListUtteranceAnalyticsDataResponseTypeDef:  # (3)
    ...
  1. See UtteranceDataSortByTypeDef
  2. See AnalyticsUtteranceFilterTypeDef
  3. See ListUtteranceAnalyticsDataResponseTypeDef
# list_utterance_analytics_data method usage example with argument unpacking

kwargs: ListUtteranceAnalyticsDataRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "startDateTime": ...,
    "endDateTime": ...,
}

parent.list_utterance_analytics_data(**kwargs)
  1. See ListUtteranceAnalyticsDataRequestRequestTypeDef

list_utterance_metrics#

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics.

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

# list_utterance_metrics method definition

def list_utterance_metrics(
    self,
    *,
    botId: str,
    startDateTime: TimestampTypeDef,
    endDateTime: TimestampTypeDef,
    metrics: Sequence[AnalyticsUtteranceMetricTypeDef],  # (1)
    binBy: Sequence[AnalyticsBinBySpecificationTypeDef] = ...,  # (2)
    groupBy: Sequence[AnalyticsUtteranceGroupBySpecificationTypeDef] = ...,  # (3)
    attributes: Sequence[AnalyticsUtteranceAttributeTypeDef] = ...,  # (4)
    filters: Sequence[AnalyticsUtteranceFilterTypeDef] = ...,  # (5)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListUtteranceMetricsResponseTypeDef:  # (6)
    ...
  1. See AnalyticsUtteranceMetricTypeDef
  2. See AnalyticsBinBySpecificationTypeDef
  3. See AnalyticsUtteranceGroupBySpecificationTypeDef
  4. See AnalyticsUtteranceAttributeTypeDef
  5. See AnalyticsUtteranceFilterTypeDef
  6. See ListUtteranceMetricsResponseTypeDef
# list_utterance_metrics method usage example with argument unpacking

kwargs: ListUtteranceMetricsRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "startDateTime": ...,
    "endDateTime": ...,
    "metrics": ...,
}

parent.list_utterance_metrics(**kwargs)
  1. See ListUtteranceMetricsRequestRequestTypeDef

search_associated_transcripts#

Search for associated transcripts that meet the specified criteria.

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

# search_associated_transcripts method definition

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)
    ...
  1. See AssociatedTranscriptFilterTypeDef
  2. See SearchOrderType
  3. See SearchAssociatedTranscriptsResponseTypeDef
# search_associated_transcripts method usage example with argument unpacking

kwargs: SearchAssociatedTranscriptsRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "botRecommendationId": ...,
    "filters": ...,
}

parent.search_associated_transcripts(**kwargs)
  1. See SearchAssociatedTranscriptsRequestRequestTypeDef

start_bot_recommendation#

Use this to provide your transcript data, and to start the bot recommendation process.

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

# start_bot_recommendation method definition

def start_bot_recommendation(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    transcriptSourceSetting: TranscriptSourceSettingTypeDef,  # (1)
    encryptionSetting: EncryptionSettingTypeDef = ...,  # (2)
) -> StartBotRecommendationResponseTypeDef:  # (3)
    ...
  1. See TranscriptSourceSettingTypeDef
  2. See EncryptionSettingTypeDef
  3. See StartBotRecommendationResponseTypeDef
# start_bot_recommendation method usage example with argument unpacking

kwargs: StartBotRecommendationRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "transcriptSourceSetting": ...,
}

parent.start_bot_recommendation(**kwargs)
  1. See StartBotRecommendationRequestRequestTypeDef

start_bot_resource_generation#

Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it.

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

# start_bot_resource_generation method definition

def start_bot_resource_generation(
    self,
    *,
    generationInputPrompt: str,
    botId: str,
    botVersion: str,
    localeId: str,
) -> StartBotResourceGenerationResponseTypeDef:  # (1)
    ...
  1. See StartBotResourceGenerationResponseTypeDef
# start_bot_resource_generation method usage example with argument unpacking

kwargs: StartBotResourceGenerationRequestRequestTypeDef = {  # (1)
    "generationInputPrompt": ...,
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.start_bot_resource_generation(**kwargs)
  1. See StartBotResourceGenerationRequestRequestTypeDef

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

# start_import method definition

def start_import(
    self,
    *,
    importId: str,
    resourceSpecification: ImportResourceSpecificationTypeDef,  # (1)
    mergeStrategy: MergeStrategyType,  # (2)
    filePassword: str = ...,
) -> StartImportResponseTypeDef:  # (3)
    ...
  1. See ImportResourceSpecificationTypeDef
  2. See MergeStrategyType
  3. See StartImportResponseTypeDef
# start_import method usage example with argument unpacking

kwargs: StartImportRequestRequestTypeDef = {  # (1)
    "importId": ...,
    "resourceSpecification": ...,
    "mergeStrategy": ...,
}

parent.start_import(**kwargs)
  1. See StartImportRequestRequestTypeDef

start_test_execution#

The action to start test set execution.

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

# start_test_execution method definition

def start_test_execution(
    self,
    *,
    testSetId: str,
    target: TestExecutionTargetTypeDef,  # (1)
    apiMode: TestExecutionApiModeType,  # (2)
    testExecutionModality: TestExecutionModalityType = ...,  # (3)
) -> StartTestExecutionResponseTypeDef:  # (4)
    ...
  1. See TestExecutionTargetTypeDef
  2. See TestExecutionApiModeType
  3. See TestExecutionModalityType
  4. See StartTestExecutionResponseTypeDef
# start_test_execution method usage example with argument unpacking

kwargs: StartTestExecutionRequestRequestTypeDef = {  # (1)
    "testSetId": ...,
    "target": ...,
    "apiMode": ...,
}

parent.start_test_execution(**kwargs)
  1. See StartTestExecutionRequestRequestTypeDef

start_test_set_generation#

The action to start the generation of test set.

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

# start_test_set_generation method definition

def start_test_set_generation(
    self,
    *,
    testSetName: str,
    storageLocation: TestSetStorageLocationTypeDef,  # (1)
    generationDataSource: TestSetGenerationDataSourceTypeDef,  # (2)
    roleArn: str,
    description: str = ...,
    testSetTags: Mapping[str, str] = ...,
) -> StartTestSetGenerationResponseTypeDef:  # (3)
    ...
  1. See TestSetStorageLocationTypeDef
  2. See TestSetGenerationDataSourceTypeDef
  3. See StartTestSetGenerationResponseTypeDef
# start_test_set_generation method usage example with argument unpacking

kwargs: StartTestSetGenerationRequestRequestTypeDef = {  # (1)
    "testSetName": ...,
    "storageLocation": ...,
    "generationDataSource": ...,
    "roleArn": ...,
}

parent.start_test_set_generation(**kwargs)
  1. See StartTestSetGenerationRequestRequestTypeDef

stop_bot_recommendation#

Stop an already running Bot Recommendation request.

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

# stop_bot_recommendation method definition

def stop_bot_recommendation(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    botRecommendationId: str,
) -> StopBotRecommendationResponseTypeDef:  # (1)
    ...
  1. See StopBotRecommendationResponseTypeDef
# stop_bot_recommendation method usage example with argument unpacking

kwargs: StopBotRecommendationRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "botRecommendationId": ...,
}

parent.stop_bot_recommendation(**kwargs)
  1. See StopBotRecommendationRequestRequestTypeDef

tag_resource#

Adds the specified tags to the specified resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceARN: str,
    tags: Mapping[str, str],
) -> dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceARN": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

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

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceARN: str,
    tagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceARN": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_bot#

Updates the configuration of an existing bot.

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

# update_bot method definition

def update_bot(
    self,
    *,
    botId: str,
    botName: str,
    roleArn: str,
    dataPrivacy: DataPrivacyTypeDef,  # (1)
    idleSessionTTLInSeconds: int,
    description: str = ...,
    botType: BotTypeType = ...,  # (2)
    botMembers: Sequence[BotMemberTypeDef] = ...,  # (3)
) -> UpdateBotResponseTypeDef:  # (4)
    ...
  1. See DataPrivacyTypeDef
  2. See BotTypeType
  3. See BotMemberTypeDef
  4. See UpdateBotResponseTypeDef
# update_bot method usage example with argument unpacking

kwargs: UpdateBotRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botName": ...,
    "roleArn": ...,
    "dataPrivacy": ...,
    "idleSessionTTLInSeconds": ...,
}

parent.update_bot(**kwargs)
  1. See UpdateBotRequestRequestTypeDef

update_bot_alias#

Updates the configuration of an existing bot alias.

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

# update_bot_alias method definition

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)
    ...
  1. See BotAliasLocaleSettingsTypeDef
  2. See ConversationLogSettingsTypeDef
  3. See SentimentAnalysisSettingsTypeDef
  4. See UpdateBotAliasResponseTypeDef
# update_bot_alias method usage example with argument unpacking

kwargs: UpdateBotAliasRequestRequestTypeDef = {  # (1)
    "botAliasId": ...,
    "botAliasName": ...,
    "botId": ...,
}

parent.update_bot_alias(**kwargs)
  1. See UpdateBotAliasRequestRequestTypeDef

update_bot_locale#

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

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

# update_bot_locale method definition

def update_bot_locale(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    nluIntentConfidenceThreshold: float,
    description: str = ...,
    voiceSettings: VoiceSettingsTypeDef = ...,  # (1)
    generativeAISettings: GenerativeAISettingsTypeDef = ...,  # (2)
) -> UpdateBotLocaleResponseTypeDef:  # (3)
    ...
  1. See VoiceSettingsTypeDef
  2. See GenerativeAISettingsTypeDef
  3. See UpdateBotLocaleResponseTypeDef
# update_bot_locale method usage example with argument unpacking

kwargs: UpdateBotLocaleRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "nluIntentConfidenceThreshold": ...,
}

parent.update_bot_locale(**kwargs)
  1. See UpdateBotLocaleRequestRequestTypeDef

update_bot_recommendation#

Updates an existing bot recommendation request.

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

# update_bot_recommendation method definition

def update_bot_recommendation(
    self,
    *,
    botId: str,
    botVersion: str,
    localeId: str,
    botRecommendationId: str,
    encryptionSetting: EncryptionSettingTypeDef,  # (1)
) -> UpdateBotRecommendationResponseTypeDef:  # (2)
    ...
  1. See EncryptionSettingTypeDef
  2. See UpdateBotRecommendationResponseTypeDef
# update_bot_recommendation method usage example with argument unpacking

kwargs: UpdateBotRecommendationRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "botRecommendationId": ...,
    "encryptionSetting": ...,
}

parent.update_bot_recommendation(**kwargs)
  1. See UpdateBotRecommendationRequestRequestTypeDef

update_export#

Updates the password used to protect an export zip archive.

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

# update_export method definition

def update_export(
    self,
    *,
    exportId: str,
    filePassword: str = ...,
) -> UpdateExportResponseTypeDef:  # (1)
    ...
  1. See UpdateExportResponseTypeDef
# update_export method usage example with argument unpacking

kwargs: UpdateExportRequestRequestTypeDef = {  # (1)
    "exportId": ...,
}

parent.update_export(**kwargs)
  1. See UpdateExportRequestRequestTypeDef

update_intent#

Updates the settings for an intent.

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

# update_intent method definition

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)
    qnAIntentConfiguration: QnAIntentConfigurationTypeDef = ...,  # (11)
) -> UpdateIntentResponseTypeDef:  # (12)
    ...
  1. See SampleUtteranceTypeDef
  2. See DialogCodeHookSettingsTypeDef
  3. See FulfillmentCodeHookSettingsTypeDef
  4. See SlotPriorityTypeDef
  5. See IntentConfirmationSettingTypeDef
  6. See IntentClosingSettingTypeDef
  7. See InputContextTypeDef
  8. See OutputContextTypeDef
  9. See KendraConfigurationTypeDef
  10. See InitialResponseSettingTypeDef
  11. See QnAIntentConfigurationTypeDef
  12. See UpdateIntentResponseTypeDef
# update_intent method usage example with argument unpacking

kwargs: UpdateIntentRequestRequestTypeDef = {  # (1)
    "intentId": ...,
    "intentName": ...,
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.update_intent(**kwargs)
  1. See UpdateIntentRequestRequestTypeDef

update_resource_policy#

Replaces the existing resource policy for a bot or bot alias with a new one.

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

# update_resource_policy method definition

def update_resource_policy(
    self,
    *,
    resourceArn: str,
    policy: str,
    expectedRevisionId: str = ...,
) -> UpdateResourcePolicyResponseTypeDef:  # (1)
    ...
  1. See UpdateResourcePolicyResponseTypeDef
# update_resource_policy method usage example with argument unpacking

kwargs: UpdateResourcePolicyRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "policy": ...,
}

parent.update_resource_policy(**kwargs)
  1. See UpdateResourcePolicyRequestRequestTypeDef

update_slot#

Updates the settings for a slot.

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

# update_slot method definition

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)
    subSlotSetting: SubSlotSettingTypeDef = ...,  # (4)
) -> UpdateSlotResponseTypeDef:  # (5)
    ...
  1. See SlotValueElicitationSettingTypeDef
  2. See ObfuscationSettingTypeDef
  3. See MultipleValuesSettingTypeDef
  4. See SubSlotSettingTypeDef
  5. See UpdateSlotResponseTypeDef
# update_slot method usage example with argument unpacking

kwargs: UpdateSlotRequestRequestTypeDef = {  # (1)
    "slotId": ...,
    "slotName": ...,
    "valueElicitationSetting": ...,
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
    "intentId": ...,
}

parent.update_slot(**kwargs)
  1. See UpdateSlotRequestRequestTypeDef

update_slot_type#

Updates the configuration of an existing slot type.

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

# update_slot_type method definition

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)
    compositeSlotTypeSetting: CompositeSlotTypeSettingTypeDef = ...,  # (4)
) -> UpdateSlotTypeResponseTypeDef:  # (5)
    ...
  1. See SlotTypeValueTypeDef
  2. See SlotValueSelectionSettingTypeDef
  3. See ExternalSourceSettingTypeDef
  4. See CompositeSlotTypeSettingTypeDef
  5. See UpdateSlotTypeResponseTypeDef
# update_slot_type method usage example with argument unpacking

kwargs: UpdateSlotTypeRequestRequestTypeDef = {  # (1)
    "slotTypeId": ...,
    "slotTypeName": ...,
    "botId": ...,
    "botVersion": ...,
    "localeId": ...,
}

parent.update_slot_type(**kwargs)
  1. See UpdateSlotTypeRequestRequestTypeDef

update_test_set#

The action to update the test set.

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

# update_test_set method definition

def update_test_set(
    self,
    *,
    testSetId: str,
    testSetName: str,
    description: str = ...,
) -> UpdateTestSetResponseTypeDef:  # (1)
    ...
  1. See UpdateTestSetResponseTypeDef
# update_test_set method usage example with argument unpacking

kwargs: UpdateTestSetRequestRequestTypeDef = {  # (1)
    "testSetId": ...,
    "testSetName": ...,
}

parent.update_test_set(**kwargs)
  1. See UpdateTestSetRequestRequestTypeDef

get_waiter#

Type annotations and code completion for boto3.client("lexv2-models").get_waiter method with overloads.