LexRuntimeV2Client

Index > LexRuntimeV2 > LexRuntimeV2Client

Auto-generated documentation for LexRuntimeV2 type annotations stubs module types-aiobotocore-lexv2-runtime.

LexRuntimeV2Client

Type annotations and code completion for session.create_client("lexv2-runtime") boto3 documentation

LexRuntimeV2Client usage example

from aiobotocore.session import get_session
from types_aiobotocore_lexv2_runtime.client import LexRuntimeV2Client

session = get_session()
async with session.create_client("lexv2-runtime") as client:
    client: LexRuntimeV2Client

Exceptions

aiobotocore client exceptions are generated in runtime. This class provides code completion for session.create_client("lexv2-runtime").exceptions structure.

LexRuntimeV2Client.exceptions usage example

async with session.create_client("lexv2-runtime") as client:
    try:
        do_something(client)
    except (
            client.AccessDeniedException,
        client.BadGatewayException,
        client.ClientError,
        client.ConflictException,
        client.DependencyFailedException,
        client.InternalServerException,
        client.ResourceNotFoundException,
        client.ThrottlingException,
        client.ValidationException,
    ) as e:
        print(e)

LexRuntimeV2Client usage type checking example

from types_aiobotocore_lexv2_runtime.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for session.create_client("lexv2-runtime").can_paginate method. boto3 documentation

# can_paginate method definition

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

close

Closes underlying endpoint connections.

Type annotations and code completion for session.create_client("lexv2-runtime").close method. boto3 documentation

# close method definition

await def close(
    self,
) -> None:
    ...

delete_session

Removes session information for a specified bot, alias, and user ID.

Type annotations and code completion for session.create_client("lexv2-runtime").delete_session method. boto3 documentation

# delete_session method definition

await def delete_session(
    self,
    *,
    botId: str,
    botAliasId: str,
    localeId: str,
    sessionId: str,
) -> DeleteSessionResponseTypeDef:  # (1)
    ...

1. See DeleteSessionResponseTypeDef

# delete_session method usage example with argument unpacking

kwargs: DeleteSessionRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botAliasId": ...,
    "localeId": ...,
    "sessionId": ...,
}

parent.delete_session(**kwargs)

1. See DeleteSessionRequestRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for session.create_client("lexv2-runtime").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

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

get_session

Returns session information for a specified bot, alias, and user.

Type annotations and code completion for session.create_client("lexv2-runtime").get_session method. boto3 documentation

# get_session method definition

await def get_session(
    self,
    *,
    botId: str,
    botAliasId: str,
    localeId: str,
    sessionId: str,
) -> GetSessionResponseTypeDef:  # (1)
    ...

1. See GetSessionResponseTypeDef

# get_session method usage example with argument unpacking

kwargs: GetSessionRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botAliasId": ...,
    "localeId": ...,
    "sessionId": ...,
}

parent.get_session(**kwargs)

1. See GetSessionRequestRequestTypeDef

put_session

Creates a new session or modifies an existing session with an Amazon Lex V2 bot.

Type annotations and code completion for session.create_client("lexv2-runtime").put_session method. boto3 documentation

# put_session method definition

await def put_session(
    self,
    *,
    botId: str,
    botAliasId: str,
    localeId: str,
    sessionId: str,
    sessionState: SessionStateTypeDef,  # (1)
    messages: Sequence[MessageTypeDef] = ...,  # (2)
    requestAttributes: Mapping[str, str] = ...,
    responseContentType: str = ...,
) -> PutSessionResponseTypeDef:  # (3)
    ...

1. See SessionStateTypeDef
2. See MessageTypeDef
3. See PutSessionResponseTypeDef

# put_session method usage example with argument unpacking

kwargs: PutSessionRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botAliasId": ...,
    "localeId": ...,
    "sessionId": ...,
    "sessionState": ...,
}

parent.put_session(**kwargs)

1. See PutSessionRequestRequestTypeDef

recognize_text

Sends user input to Amazon Lex V2.

Type annotations and code completion for session.create_client("lexv2-runtime").recognize_text method. boto3 documentation

# recognize_text method definition

await def recognize_text(
    self,
    *,
    botId: str,
    botAliasId: str,
    localeId: str,
    sessionId: str,
    text: str,
    sessionState: SessionStateTypeDef = ...,  # (1)
    requestAttributes: Mapping[str, str] = ...,
) -> RecognizeTextResponseTypeDef:  # (2)
    ...

1. See SessionStateTypeDef
2. See RecognizeTextResponseTypeDef

# recognize_text method usage example with argument unpacking

kwargs: RecognizeTextRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botAliasId": ...,
    "localeId": ...,
    "sessionId": ...,
    "text": ...,
}

parent.recognize_text(**kwargs)

1. See RecognizeTextRequestRequestTypeDef

recognize_utterance

Sends user input to Amazon Lex V2.

Type annotations and code completion for session.create_client("lexv2-runtime").recognize_utterance method. boto3 documentation

# recognize_utterance method definition

await def recognize_utterance(
    self,
    *,
    botId: str,
    botAliasId: str,
    localeId: str,
    sessionId: str,
    requestContentType: str,
    sessionState: str = ...,
    requestAttributes: str = ...,
    responseContentType: str = ...,
    inputStream: Union[str, bytes, IO[Any], StreamingBody] = ...,
) -> RecognizeUtteranceResponseTypeDef:  # (1)
    ...

1. See RecognizeUtteranceResponseTypeDef

# recognize_utterance method usage example with argument unpacking

kwargs: RecognizeUtteranceRequestRequestTypeDef = {  # (1)
    "botId": ...,
    "botAliasId": ...,
    "localeId": ...,
    "sessionId": ...,
    "requestContentType": ...,
}

parent.recognize_utterance(**kwargs)

1. See RecognizeUtteranceRequestRequestTypeDef

__aenter__

Type annotations and code completion for session.create_client("lexv2-runtime").__aenter__ method. boto3 documentation

# __aenter__ method definition

await def __aenter__(
    self,
) -> LexRuntimeV2Client:
    ...

__aexit__

Type annotations and code completion for session.create_client("lexv2-runtime").__aexit__ method. boto3 documentation

# __aexit__ method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...