Skip to content

AgentsforBedrockRuntimeClient#

Index > AgentsforBedrockRuntime > AgentsforBedrockRuntimeClient

Auto-generated documentation for AgentsforBedrockRuntime type annotations stubs module mypy-boto3-bedrock-agent-runtime.

AgentsforBedrockRuntimeClient#

Type annotations and code completion for boto3.client("bedrock-agent-runtime"). boto3 documentation

# AgentsforBedrockRuntimeClient usage example

from boto3.session import Session
from mypy_boto3_bedrock_agent_runtime.client import AgentsforBedrockRuntimeClient

def get_bedrock-agent-runtime_client() -> AgentsforBedrockRuntimeClient:
    return Session().client("bedrock-agent-runtime")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("bedrock-agent-runtime")

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

from mypy_boto3_bedrock_agent_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 boto3.client("bedrock-agent-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 boto3.client("bedrock-agent-runtime").close method. boto3 documentation

# close method definition

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

generate_presigned_url#

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

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

invoke_agent#

Invokes the specified Bedrock model to run inference using the input provided in the request body.

Type annotations and code completion for boto3.client("bedrock-agent-runtime").invoke_agent method. boto3 documentation

# invoke_agent method definition

def invoke_agent(
    self,
    *,
    agentId: str,
    agentAliasId: str,
    sessionId: str,
    inputText: str,
    sessionState: SessionStateTypeDef = ...,  # (1)
    endSession: bool = ...,
    enableTrace: bool = ...,
) -> InvokeAgentResponseTypeDef:  # (2)
    ...
  1. See SessionStateTypeDef
  2. See InvokeAgentResponseTypeDef
# invoke_agent method usage example with argument unpacking

kwargs: InvokeAgentRequestRequestTypeDef = {  # (1)
    "agentId": ...,
    "agentAliasId": ...,
    "sessionId": ...,
    "inputText": ...,
}

parent.invoke_agent(**kwargs)
  1. See InvokeAgentRequestRequestTypeDef

retrieve#

Retrieve from knowledge base.

Type annotations and code completion for boto3.client("bedrock-agent-runtime").retrieve method. boto3 documentation

# retrieve method definition

def retrieve(
    self,
    *,
    knowledgeBaseId: str,
    retrievalQuery: KnowledgeBaseQueryTypeDef,  # (1)
    retrievalConfiguration: KnowledgeBaseRetrievalConfigurationTypeDef = ...,  # (2)
    nextToken: str = ...,
) -> RetrieveResponseTypeDef:  # (3)
    ...
  1. See KnowledgeBaseQueryTypeDef
  2. See KnowledgeBaseRetrievalConfigurationTypeDef
  3. See RetrieveResponseTypeDef
# retrieve method usage example with argument unpacking

kwargs: RetrieveRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "retrievalQuery": ...,
}

parent.retrieve(**kwargs)
  1. See RetrieveRequestRequestTypeDef

retrieve_and_generate#

RetrieveAndGenerate API See also: AWS API Documentation.

Type annotations and code completion for boto3.client("bedrock-agent-runtime").retrieve_and_generate method. boto3 documentation

# retrieve_and_generate method definition

def retrieve_and_generate(
    self,
    *,
    input: RetrieveAndGenerateInputTypeDef,  # (1)
    sessionId: str = ...,
    retrieveAndGenerateConfiguration: RetrieveAndGenerateConfigurationTypeDef = ...,  # (2)
    sessionConfiguration: RetrieveAndGenerateSessionConfigurationTypeDef = ...,  # (3)
) -> RetrieveAndGenerateResponseTypeDef:  # (4)
    ...
  1. See RetrieveAndGenerateInputTypeDef
  2. See RetrieveAndGenerateConfigurationTypeDef
  3. See RetrieveAndGenerateSessionConfigurationTypeDef
  4. See RetrieveAndGenerateResponseTypeDef
# retrieve_and_generate method usage example with argument unpacking

kwargs: RetrieveAndGenerateRequestRequestTypeDef = {  # (1)
    "input": ...,
}

parent.retrieve_and_generate(**kwargs)
  1. See RetrieveAndGenerateRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("bedrock-agent-runtime").get_paginator method with overloads.