LexModelBuildingServiceClient

Index > LexModelBuildingService > LexModelBuildingServiceClient

Auto-generated documentation for LexModelBuildingService type annotations stubs module mypy-boto3-lex-models.

LexModelBuildingServiceClient

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

# LexModelBuildingServiceClient usage example

from boto3.session import Session
from mypy_boto3_lex_models.client import LexModelBuildingServiceClient

def get_lex-models_client() -> LexModelBuildingServiceClient:
    return Session().client("lex-models")

Exceptions

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

# Exceptions.exceptions usage example

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

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalFailureException,
    client.exceptions.LimitExceededException,
    client.exceptions.NotFoundException,
    client.exceptions.PreconditionFailedException,
    client.exceptions.ResourceInUseException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_lex_models.client import Exceptions

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

Methods

can_paginate

Type annotations and code completion for boto3.client("lex-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("lex-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:
    ...

create_bot_version

Creates a new version of the bot based on the $LATEST version.

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

# create_bot_version method definition

def create_bot_version(
    self,
    *,
    name: str,
    checksum: str = ...,
) -> CreateBotVersionResponseTypeDef:  # (1)
    ...

1. See CreateBotVersionResponseTypeDef

# create_bot_version method usage example with argument unpacking

kwargs: CreateBotVersionRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_bot_version(**kwargs)

1. See CreateBotVersionRequestTypeDef

create_intent_version

Creates a new version of an intent based on the $LATEST version of the intent.

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

# create_intent_version method definition

def create_intent_version(
    self,
    *,
    name: str,
    checksum: str = ...,
) -> CreateIntentVersionResponseTypeDef:  # (1)
    ...

1. See CreateIntentVersionResponseTypeDef

# create_intent_version method usage example with argument unpacking

kwargs: CreateIntentVersionRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_intent_version(**kwargs)

1. See CreateIntentVersionRequestTypeDef

create_slot_type_version

Creates a new version of a slot type based on the $LATEST version of the specified slot type.

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

# create_slot_type_version method definition

def create_slot_type_version(
    self,
    *,
    name: str,
    checksum: str = ...,
) -> CreateSlotTypeVersionResponseTypeDef:  # (1)
    ...

1. See CreateSlotTypeVersionResponseTypeDef

# create_slot_type_version method usage example with argument unpacking

kwargs: CreateSlotTypeVersionRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_slot_type_version(**kwargs)

1. See CreateSlotTypeVersionRequestTypeDef

delete_bot

Deletes all versions of the bot, including the $LATEST version.

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

# delete_bot method definition

def delete_bot(
    self,
    *,
    name: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_bot method usage example with argument unpacking

kwargs: DeleteBotRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_bot(**kwargs)

1. See DeleteBotRequestTypeDef

delete_bot_alias

Deletes an alias for the specified bot.

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

# delete_bot_alias method definition

def delete_bot_alias(
    self,
    *,
    name: str,
    botName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_bot_alias method usage example with argument unpacking

kwargs: DeleteBotAliasRequestTypeDef = {  # (1)
    "name": ...,
    "botName": ...,
}

parent.delete_bot_alias(**kwargs)

1. See DeleteBotAliasRequestTypeDef

delete_bot_channel_association

Deletes the association between an Amazon Lex bot and a messaging platform.

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

# delete_bot_channel_association method definition

def delete_bot_channel_association(
    self,
    *,
    name: str,
    botName: str,
    botAlias: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_bot_channel_association method usage example with argument unpacking

kwargs: DeleteBotChannelAssociationRequestTypeDef = {  # (1)
    "name": ...,
    "botName": ...,
    "botAlias": ...,
}

parent.delete_bot_channel_association(**kwargs)

1. See DeleteBotChannelAssociationRequestTypeDef

delete_bot_version

Deletes a specific version of a bot.

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

# delete_bot_version method definition

def delete_bot_version(
    self,
    *,
    name: str,
    version: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_bot_version method usage example with argument unpacking

kwargs: DeleteBotVersionRequestTypeDef = {  # (1)
    "name": ...,
    "version": ...,
}

parent.delete_bot_version(**kwargs)

1. See DeleteBotVersionRequestTypeDef

delete_intent

Deletes all versions of the intent, including the $LATEST version.

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

# delete_intent method definition

def delete_intent(
    self,
    *,
    name: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_intent method usage example with argument unpacking

kwargs: DeleteIntentRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_intent(**kwargs)

1. See DeleteIntentRequestTypeDef

delete_intent_version

Deletes a specific version of an intent.

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

# delete_intent_version method definition

def delete_intent_version(
    self,
    *,
    name: str,
    version: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_intent_version method usage example with argument unpacking

kwargs: DeleteIntentVersionRequestTypeDef = {  # (1)
    "name": ...,
    "version": ...,
}

parent.delete_intent_version(**kwargs)

1. See DeleteIntentVersionRequestTypeDef

delete_slot_type

Deletes all versions of the slot type, including the $LATEST version.

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

# delete_slot_type method definition

def delete_slot_type(
    self,
    *,
    name: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_slot_type method usage example with argument unpacking

kwargs: DeleteSlotTypeRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_slot_type(**kwargs)

1. See DeleteSlotTypeRequestTypeDef

delete_slot_type_version

Deletes a specific version of a slot type.

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

# delete_slot_type_version method definition

def delete_slot_type_version(
    self,
    *,
    name: str,
    version: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_slot_type_version method usage example with argument unpacking

kwargs: DeleteSlotTypeVersionRequestTypeDef = {  # (1)
    "name": ...,
    "version": ...,
}

parent.delete_slot_type_version(**kwargs)

1. See DeleteSlotTypeVersionRequestTypeDef

delete_utterances

Deletes stored utterances.

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

# delete_utterances method definition

def delete_utterances(
    self,
    *,
    botName: str,
    userId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_utterances method usage example with argument unpacking

kwargs: DeleteUtterancesRequestTypeDef = {  # (1)
    "botName": ...,
    "userId": ...,
}

parent.delete_utterances(**kwargs)

1. See DeleteUtterancesRequestTypeDef

get_bot

Returns metadata information for a specific bot.

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

# get_bot method definition

def get_bot(
    self,
    *,
    name: str,
    versionOrAlias: str,
) -> GetBotResponseTypeDef:  # (1)
    ...

1. See GetBotResponseTypeDef

# get_bot method usage example with argument unpacking

kwargs: GetBotRequestTypeDef = {  # (1)
    "name": ...,
    "versionOrAlias": ...,
}

parent.get_bot(**kwargs)

1. See GetBotRequestTypeDef

get_bot_alias

Returns information about an Amazon Lex bot alias.

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

# get_bot_alias method definition

def get_bot_alias(
    self,
    *,
    name: str,
    botName: str,
) -> GetBotAliasResponseTypeDef:  # (1)
    ...

1. See GetBotAliasResponseTypeDef

# get_bot_alias method usage example with argument unpacking

kwargs: GetBotAliasRequestTypeDef = {  # (1)
    "name": ...,
    "botName": ...,
}

parent.get_bot_alias(**kwargs)

1. See GetBotAliasRequestTypeDef

get_bot_aliases

Returns a list of aliases for a specified Amazon Lex bot.

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

# get_bot_aliases method definition

def get_bot_aliases(
    self,
    *,
    botName: str,
    nextToken: str = ...,
    maxResults: int = ...,
    nameContains: str = ...,
) -> GetBotAliasesResponseTypeDef:  # (1)
    ...

1. See GetBotAliasesResponseTypeDef

# get_bot_aliases method usage example with argument unpacking

kwargs: GetBotAliasesRequestTypeDef = {  # (1)
    "botName": ...,
}

parent.get_bot_aliases(**kwargs)

1. See GetBotAliasesRequestTypeDef

get_bot_channel_association

Returns information about the association between an Amazon Lex bot and a messaging platform.

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

# get_bot_channel_association method definition

def get_bot_channel_association(
    self,
    *,
    name: str,
    botName: str,
    botAlias: str,
) -> GetBotChannelAssociationResponseTypeDef:  # (1)
    ...

1. See GetBotChannelAssociationResponseTypeDef

# get_bot_channel_association method usage example with argument unpacking

kwargs: GetBotChannelAssociationRequestTypeDef = {  # (1)
    "name": ...,
    "botName": ...,
    "botAlias": ...,
}

parent.get_bot_channel_association(**kwargs)

1. See GetBotChannelAssociationRequestTypeDef

get_bot_channel_associations

Returns a list of all of the channels associated with the specified bot.

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

# get_bot_channel_associations method definition

def get_bot_channel_associations(
    self,
    *,
    botName: str,
    botAlias: str,
    nextToken: str = ...,
    maxResults: int = ...,
    nameContains: str = ...,
) -> GetBotChannelAssociationsResponseTypeDef:  # (1)
    ...

1. See GetBotChannelAssociationsResponseTypeDef

# get_bot_channel_associations method usage example with argument unpacking

kwargs: GetBotChannelAssociationsRequestTypeDef = {  # (1)
    "botName": ...,
    "botAlias": ...,
}

parent.get_bot_channel_associations(**kwargs)

1. See GetBotChannelAssociationsRequestTypeDef

get_bot_versions

Gets information about all of the versions of a bot.

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

# get_bot_versions method definition

def get_bot_versions(
    self,
    *,
    name: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetBotVersionsResponseTypeDef:  # (1)
    ...

1. See GetBotVersionsResponseTypeDef

# get_bot_versions method usage example with argument unpacking

kwargs: GetBotVersionsRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_bot_versions(**kwargs)

1. See GetBotVersionsRequestTypeDef

get_bots

Returns bot information as follows:.

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

# get_bots method definition

def get_bots(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    nameContains: str = ...,
) -> GetBotsResponseTypeDef:  # (1)
    ...

1. See GetBotsResponseTypeDef

# get_bots method usage example with argument unpacking

kwargs: GetBotsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.get_bots(**kwargs)

1. See GetBotsRequestTypeDef

get_builtin_intent

Returns information about a built-in intent.

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

# get_builtin_intent method definition

def get_builtin_intent(
    self,
    *,
    signature: str,
) -> GetBuiltinIntentResponseTypeDef:  # (1)
    ...

1. See GetBuiltinIntentResponseTypeDef

# get_builtin_intent method usage example with argument unpacking

kwargs: GetBuiltinIntentRequestTypeDef = {  # (1)
    "signature": ...,
}

parent.get_builtin_intent(**kwargs)

1. See GetBuiltinIntentRequestTypeDef

get_builtin_intents

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

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

# get_builtin_intents method definition

def get_builtin_intents(
    self,
    *,
    locale: LocaleType = ...,  # (1)
    signatureContains: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetBuiltinIntentsResponseTypeDef:  # (2)
    ...

1. See LocaleType
2. See GetBuiltinIntentsResponseTypeDef

# get_builtin_intents method usage example with argument unpacking

kwargs: GetBuiltinIntentsRequestTypeDef = {  # (1)
    "locale": ...,
}

parent.get_builtin_intents(**kwargs)

1. See GetBuiltinIntentsRequestTypeDef

get_builtin_slot_types

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

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

# get_builtin_slot_types method definition

def get_builtin_slot_types(
    self,
    *,
    locale: LocaleType = ...,  # (1)
    signatureContains: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetBuiltinSlotTypesResponseTypeDef:  # (2)
    ...

1. See LocaleType
2. See GetBuiltinSlotTypesResponseTypeDef

# get_builtin_slot_types method usage example with argument unpacking

kwargs: GetBuiltinSlotTypesRequestTypeDef = {  # (1)
    "locale": ...,
}

parent.get_builtin_slot_types(**kwargs)

1. See GetBuiltinSlotTypesRequestTypeDef

get_export

Exports the contents of a Amazon Lex resource in a specified format.

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

# get_export method definition

def get_export(
    self,
    *,
    name: str,
    version: str,
    resourceType: ResourceTypeType,  # (1)
    exportType: ExportTypeType,  # (2)
) -> GetExportResponseTypeDef:  # (3)
    ...

1. See ResourceTypeType
2. See ExportTypeType
3. See GetExportResponseTypeDef

# get_export method usage example with argument unpacking

kwargs: GetExportRequestTypeDef = {  # (1)
    "name": ...,
    "version": ...,
    "resourceType": ...,
    "exportType": ...,
}

parent.get_export(**kwargs)

1. See GetExportRequestTypeDef

get_import

Gets information about an import job started with the StartImport operation.

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

# get_import method definition

def get_import(
    self,
    *,
    importId: str,
) -> GetImportResponseTypeDef:  # (1)
    ...

1. See GetImportResponseTypeDef

# get_import method usage example with argument unpacking

kwargs: GetImportRequestTypeDef = {  # (1)
    "importId": ...,
}

parent.get_import(**kwargs)

1. See GetImportRequestTypeDef

get_intent

Returns information about an intent.

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

# get_intent method definition

def get_intent(
    self,
    *,
    name: str,
    version: str,
) -> GetIntentResponseTypeDef:  # (1)
    ...

1. See GetIntentResponseTypeDef

# get_intent method usage example with argument unpacking

kwargs: GetIntentRequestTypeDef = {  # (1)
    "name": ...,
    "version": ...,
}

parent.get_intent(**kwargs)

1. See GetIntentRequestTypeDef

get_intent_versions

Gets information about all of the versions of an intent.

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

# get_intent_versions method definition

def get_intent_versions(
    self,
    *,
    name: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetIntentVersionsResponseTypeDef:  # (1)
    ...

1. See GetIntentVersionsResponseTypeDef

# get_intent_versions method usage example with argument unpacking

kwargs: GetIntentVersionsRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_intent_versions(**kwargs)

1. See GetIntentVersionsRequestTypeDef

get_intents

Returns intent information as follows:.

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

# get_intents method definition

def get_intents(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    nameContains: str = ...,
) -> GetIntentsResponseTypeDef:  # (1)
    ...

1. See GetIntentsResponseTypeDef

# get_intents method usage example with argument unpacking

kwargs: GetIntentsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.get_intents(**kwargs)

1. See GetIntentsRequestTypeDef

get_migration

Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot.

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

# get_migration method definition

def get_migration(
    self,
    *,
    migrationId: str,
) -> GetMigrationResponseTypeDef:  # (1)
    ...

1. See GetMigrationResponseTypeDef

# get_migration method usage example with argument unpacking

kwargs: GetMigrationRequestTypeDef = {  # (1)
    "migrationId": ...,
}

parent.get_migration(**kwargs)

1. See GetMigrationRequestTypeDef

get_migrations

Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.

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

# get_migrations method definition

def get_migrations(
    self,
    *,
    sortByAttribute: MigrationSortAttributeType = ...,  # (1)
    sortByOrder: SortOrderType = ...,  # (2)
    v1BotNameContains: str = ...,
    migrationStatusEquals: MigrationStatusType = ...,  # (3)
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetMigrationsResponseTypeDef:  # (4)
    ...

1. See MigrationSortAttributeType
2. See SortOrderType
3. See MigrationStatusType
4. See GetMigrationsResponseTypeDef

# get_migrations method usage example with argument unpacking

kwargs: GetMigrationsRequestTypeDef = {  # (1)
    "sortByAttribute": ...,
}

parent.get_migrations(**kwargs)

1. See GetMigrationsRequestTypeDef

get_slot_type

Returns information about a specific version of a slot type.

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

# get_slot_type method definition

def get_slot_type(
    self,
    *,
    name: str,
    version: str,
) -> GetSlotTypeResponseTypeDef:  # (1)
    ...

1. See GetSlotTypeResponseTypeDef

# get_slot_type method usage example with argument unpacking

kwargs: GetSlotTypeRequestTypeDef = {  # (1)
    "name": ...,
    "version": ...,
}

parent.get_slot_type(**kwargs)

1. See GetSlotTypeRequestTypeDef

get_slot_type_versions

Gets information about all versions of a slot type.

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

# get_slot_type_versions method definition

def get_slot_type_versions(
    self,
    *,
    name: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetSlotTypeVersionsResponseTypeDef:  # (1)
    ...

1. See GetSlotTypeVersionsResponseTypeDef

# get_slot_type_versions method usage example with argument unpacking

kwargs: GetSlotTypeVersionsRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_slot_type_versions(**kwargs)

1. See GetSlotTypeVersionsRequestTypeDef

get_slot_types

Returns slot type information as follows:.

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

# get_slot_types method definition

def get_slot_types(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    nameContains: str = ...,
) -> GetSlotTypesResponseTypeDef:  # (1)
    ...

1. See GetSlotTypesResponseTypeDef

# get_slot_types method usage example with argument unpacking

kwargs: GetSlotTypesRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.get_slot_types(**kwargs)

1. See GetSlotTypesRequestTypeDef

get_utterances_view

Use the GetUtterancesView operation to get information about the utterances that your users have made to your bot.

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

# get_utterances_view method definition

def get_utterances_view(
    self,
    *,
    botName: str,
    botVersions: Sequence[str],
    statusType: StatusTypeType,  # (1)
) -> GetUtterancesViewResponseTypeDef:  # (2)
    ...

1. See StatusTypeType
2. See GetUtterancesViewResponseTypeDef

# get_utterances_view method usage example with argument unpacking

kwargs: GetUtterancesViewRequestTypeDef = {  # (1)
    "botName": ...,
    "botVersions": ...,
    "statusType": ...,
}

parent.get_utterances_view(**kwargs)

1. See GetUtterancesViewRequestTypeDef

list_tags_for_resource

Gets a list of tags associated with the specified resource.

Type annotations and code completion for boto3.client("lex-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: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

put_bot

Creates an Amazon Lex conversational bot or replaces an existing bot.

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

# put_bot method definition

def put_bot(
    self,
    *,
    name: str,
    locale: LocaleType,  # (1)
    childDirected: bool,
    description: str = ...,
    intents: Sequence[IntentTypeDef] = ...,  # (2)
    enableModelImprovements: bool = ...,
    nluIntentConfidenceThreshold: float = ...,
    clarificationPrompt: PromptUnionTypeDef = ...,  # (3)
    abortStatement: StatementUnionTypeDef = ...,  # (4)
    idleSessionTTLInSeconds: int = ...,
    voiceId: str = ...,
    checksum: str = ...,
    processBehavior: ProcessBehaviorType = ...,  # (5)
    detectSentiment: bool = ...,
    createVersion: bool = ...,
    tags: Sequence[TagTypeDef] = ...,  # (6)
) -> PutBotResponseTypeDef:  # (7)
    ...

1. See LocaleType
2. See IntentTypeDef
3. See PromptTypeDef PromptOutputTypeDef
4. See StatementTypeDef StatementOutputTypeDef
5. See ProcessBehaviorType
6. See TagTypeDef
7. See PutBotResponseTypeDef

# put_bot method usage example with argument unpacking

kwargs: PutBotRequestTypeDef = {  # (1)
    "name": ...,
    "locale": ...,
    "childDirected": ...,
}

parent.put_bot(**kwargs)

1. See PutBotRequestTypeDef

put_bot_alias

Creates an alias for the specified version of the bot or replaces an alias for the specified bot.

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

# put_bot_alias method definition

def put_bot_alias(
    self,
    *,
    name: str,
    botVersion: str,
    botName: str,
    description: str = ...,
    checksum: str = ...,
    conversationLogs: ConversationLogsRequestTypeDef = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> PutBotAliasResponseTypeDef:  # (3)
    ...

1. See ConversationLogsRequestTypeDef
2. See TagTypeDef
3. See PutBotAliasResponseTypeDef

# put_bot_alias method usage example with argument unpacking

kwargs: PutBotAliasRequestTypeDef = {  # (1)
    "name": ...,
    "botVersion": ...,
    "botName": ...,
}

parent.put_bot_alias(**kwargs)

1. See PutBotAliasRequestTypeDef

put_intent

Creates an intent or replaces an existing intent.

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

# put_intent method definition

def put_intent(
    self,
    *,
    name: str,
    description: str = ...,
    slots: Sequence[SlotUnionTypeDef] = ...,  # (1)
    sampleUtterances: Sequence[str] = ...,
    confirmationPrompt: PromptUnionTypeDef = ...,  # (2)
    rejectionStatement: StatementUnionTypeDef = ...,  # (3)
    followUpPrompt: FollowUpPromptUnionTypeDef = ...,  # (4)
    conclusionStatement: StatementUnionTypeDef = ...,  # (3)
    dialogCodeHook: CodeHookTypeDef = ...,  # (6)
    fulfillmentActivity: FulfillmentActivityTypeDef = ...,  # (7)
    parentIntentSignature: str = ...,
    checksum: str = ...,
    createVersion: bool = ...,
    kendraConfiguration: KendraConfigurationTypeDef = ...,  # (8)
    inputContexts: Sequence[InputContextTypeDef] = ...,  # (9)
    outputContexts: Sequence[OutputContextTypeDef] = ...,  # (10)
) -> PutIntentResponseTypeDef:  # (11)
    ...

1. See SlotTypeDef SlotOutputTypeDef
2. See PromptTypeDef PromptOutputTypeDef
3. See StatementTypeDef StatementOutputTypeDef
4. See FollowUpPromptTypeDef FollowUpPromptOutputTypeDef
5. See StatementTypeDef StatementOutputTypeDef
6. See CodeHookTypeDef
7. See FulfillmentActivityTypeDef
8. See KendraConfigurationTypeDef
9. See InputContextTypeDef
10. See OutputContextTypeDef
11. See PutIntentResponseTypeDef

# put_intent method usage example with argument unpacking

kwargs: PutIntentRequestTypeDef = {  # (1)
    "name": ...,
}

parent.put_intent(**kwargs)

1. See PutIntentRequestTypeDef

put_slot_type

Creates a custom slot type or replaces an existing custom slot type.

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

# put_slot_type method definition

def put_slot_type(
    self,
    *,
    name: str,
    description: str = ...,
    enumerationValues: Sequence[EnumerationValueUnionTypeDef] = ...,  # (1)
    checksum: str = ...,
    valueSelectionStrategy: SlotValueSelectionStrategyType = ...,  # (2)
    createVersion: bool = ...,
    parentSlotTypeSignature: str = ...,
    slotTypeConfigurations: Sequence[SlotTypeConfigurationTypeDef] = ...,  # (3)
) -> PutSlotTypeResponseTypeDef:  # (4)
    ...

1. See EnumerationValueTypeDef EnumerationValueOutputTypeDef
2. See SlotValueSelectionStrategyType
3. See SlotTypeConfigurationTypeDef
4. See PutSlotTypeResponseTypeDef

# put_slot_type method usage example with argument unpacking

kwargs: PutSlotTypeRequestTypeDef = {  # (1)
    "name": ...,
}

parent.put_slot_type(**kwargs)

1. See PutSlotTypeRequestTypeDef

start_import

Starts a job to import a resource to Amazon Lex.

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

# start_import method definition

def start_import(
    self,
    *,
    payload: BlobTypeDef,
    resourceType: ResourceTypeType,  # (1)
    mergeStrategy: MergeStrategyType,  # (2)
    tags: Sequence[TagTypeDef] = ...,  # (3)
) -> StartImportResponseTypeDef:  # (4)
    ...

1. See ResourceTypeType
2. See MergeStrategyType
3. See TagTypeDef
4. See StartImportResponseTypeDef

# start_import method usage example with argument unpacking

kwargs: StartImportRequestTypeDef = {  # (1)
    "payload": ...,
    "resourceType": ...,
    "mergeStrategy": ...,
}

parent.start_import(**kwargs)

1. See StartImportRequestTypeDef

start_migration

Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2.

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

# start_migration method definition

def start_migration(
    self,
    *,
    v1BotName: str,
    v1BotVersion: str,
    v2BotName: str,
    v2BotRole: str,
    migrationStrategy: MigrationStrategyType,  # (1)
) -> StartMigrationResponseTypeDef:  # (2)
    ...

1. See MigrationStrategyType
2. See StartMigrationResponseTypeDef

# start_migration method usage example with argument unpacking

kwargs: StartMigrationRequestTypeDef = {  # (1)
    "v1BotName": ...,
    "v1BotVersion": ...,
    "v2BotName": ...,
    "v2BotRole": ...,
    "migrationStrategy": ...,
}

parent.start_migration(**kwargs)

1. See StartMigrationRequestTypeDef

tag_resource

Adds the specified tags to the specified resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

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

Type annotations and code completion for boto3.client("lex-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: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

get_paginator

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

• client.get_paginator("get_bot_aliases") -> GetBotAliasesPaginator
• client.get_paginator("get_bot_channel_associations") -> GetBotChannelAssociationsPaginator
• client.get_paginator("get_bot_versions") -> GetBotVersionsPaginator
• client.get_paginator("get_bots") -> GetBotsPaginator
• client.get_paginator("get_builtin_intents") -> GetBuiltinIntentsPaginator
• client.get_paginator("get_builtin_slot_types") -> GetBuiltinSlotTypesPaginator
• client.get_paginator("get_intent_versions") -> GetIntentVersionsPaginator
• client.get_paginator("get_intents") -> GetIntentsPaginator
• client.get_paginator("get_slot_type_versions") -> GetSlotTypeVersionsPaginator
• client.get_paginator("get_slot_types") -> GetSlotTypesPaginator