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:
    ...

delete_agent_memory#

Deletes memory from the specified memory identifier.

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

# delete_agent_memory method definition

def delete_agent_memory(
    self,
    *,
    agentAliasId: str,
    agentId: str,
    memoryId: str = ...,
) -> Dict[str, Any]:
    ...
# delete_agent_memory method usage example with argument unpacking

kwargs: DeleteAgentMemoryRequestRequestTypeDef = {  # (1)
    "agentAliasId": ...,
    "agentId": ...,
}

parent.delete_agent_memory(**kwargs)
  1. See DeleteAgentMemoryRequestRequestTypeDef

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:
    ...

get_agent_memory#

Gets the sessions stored in the memory of the agent.

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

# get_agent_memory method definition

def get_agent_memory(
    self,
    *,
    agentAliasId: str,
    agentId: str,
    memoryId: str,
    memoryType: MemoryTypeType,  # (1)
    maxItems: int = ...,
    nextToken: str = ...,
) -> GetAgentMemoryResponseTypeDef:  # (2)
    ...
  1. See MemoryTypeType
  2. See GetAgentMemoryResponseTypeDef 
# get_agent_memory method usage example with argument unpacking

kwargs: GetAgentMemoryRequestRequestTypeDef = {  # (1)
    "agentAliasId": ...,
    "agentId": ...,
    "memoryId": ...,
    "memoryType": ...,
}

parent.get_agent_memory(**kwargs)
  1. See GetAgentMemoryRequestRequestTypeDef

invoke_agent#

.

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

# invoke_agent method definition

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

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

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

invoke_flow#

Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream.

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

# invoke_flow method definition

def invoke_flow(
    self,
    *,
    flowAliasIdentifier: str,
    flowIdentifier: str,
    inputs: Sequence[FlowInputTypeDef],  # (1)
    enableTrace: bool = ...,
) -> InvokeFlowResponseTypeDef:  # (2)
    ...
  1. See FlowInputTypeDef
  2. See InvokeFlowResponseTypeDef 
# invoke_flow method usage example with argument unpacking

kwargs: InvokeFlowRequestRequestTypeDef = {  # (1)
    "flowAliasIdentifier": ...,
    "flowIdentifier": ...,
    "inputs": ...,
}

parent.invoke_flow(**kwargs)
  1. See InvokeFlowRequestRequestTypeDef

optimize_prompt#

Optimizes a prompt for the task that you specify.

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

# optimize_prompt method definition

def optimize_prompt(
    self,
    *,
    input: InputPromptTypeDef,  # (1)
    targetModelId: str,
) -> OptimizePromptResponseTypeDef:  # (2)
    ...
  1. See InputPromptTypeDef
  2. See OptimizePromptResponseTypeDef 
# optimize_prompt method usage example with argument unpacking

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

parent.optimize_prompt(**kwargs)
  1. See OptimizePromptRequestRequestTypeDef

retrieve#

Queries a knowledge base and retrieves information from it.

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)
    nextToken: str = ...,
    retrievalConfiguration: KnowledgeBaseRetrievalConfigurationTypeDef = ...,  # (2)
) -> 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#

Queries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or inference profile.

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)
    retrieveAndGenerateConfiguration: RetrieveAndGenerateConfigurationTypeDef = ...,  # (2)
    sessionConfiguration: RetrieveAndGenerateSessionConfigurationTypeDef = ...,  # (3)
    sessionId: str = ...,
) -> 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.