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.ModelNotReadyException,
    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

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

generate_presigned_url

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

create_invocation

Creates a new invocation within a session.

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

# create_invocation method definition

def create_invocation(
    self,
    *,
    sessionIdentifier: str,
    description: str = ...,
    invocationId: str = ...,
) -> CreateInvocationResponseTypeDef:  # (1)
    ...

1. See CreateInvocationResponseTypeDef

# create_invocation method usage example with argument unpacking

kwargs: CreateInvocationRequestTypeDef = {  # (1)
    "sessionIdentifier": ...,
}

parent.create_invocation(**kwargs)

1. See CreateInvocationRequestTypeDef

create_session

Creates a session to temporarily store conversations for generative AI (GenAI) applications built with open-source frameworks such as LangGraph and LlamaIndex.

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

# create_session method definition

def create_session(
    self,
    *,
    encryptionKeyArn: str = ...,
    sessionMetadata: Mapping[str, str] = ...,
    tags: Mapping[str, str] = ...,
) -> CreateSessionResponseTypeDef:  # (1)
    ...

1. See CreateSessionResponseTypeDef

# create_session method usage example with argument unpacking

kwargs: CreateSessionRequestTypeDef = {  # (1)
    "encryptionKeyArn": ...,
}

parent.create_session(**kwargs)

1. See CreateSessionRequestTypeDef

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 = ...,
    sessionId: str = ...,
) -> Dict[str, Any]:
    ...

# delete_agent_memory method usage example with argument unpacking

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

parent.delete_agent_memory(**kwargs)

1. See DeleteAgentMemoryRequestTypeDef

delete_session

Deletes a session that you ended.

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

# delete_session method definition

def delete_session(
    self,
    *,
    sessionIdentifier: str,
) -> Dict[str, Any]:
    ...

# delete_session method usage example with argument unpacking

kwargs: DeleteSessionRequestTypeDef = {  # (1)
    "sessionIdentifier": ...,
}

parent.delete_session(**kwargs)

1. See DeleteSessionRequestTypeDef

end_session

Ends the session.

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

# end_session method definition

def end_session(
    self,
    *,
    sessionIdentifier: str,
) -> EndSessionResponseTypeDef:  # (1)
    ...

1. See EndSessionResponseTypeDef

# end_session method usage example with argument unpacking

kwargs: EndSessionRequestTypeDef = {  # (1)
    "sessionIdentifier": ...,
}

parent.end_session(**kwargs)

1. See EndSessionRequestTypeDef

generate_query

Generates an SQL query from a natural language query.

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

# generate_query method definition

def generate_query(
    self,
    *,
    queryGenerationInput: QueryGenerationInputTypeDef,  # (1)
    transformationConfiguration: TransformationConfigurationTypeDef,  # (2)
) -> GenerateQueryResponseTypeDef:  # (3)
    ...

1. See QueryGenerationInputTypeDef
2. See TransformationConfigurationTypeDef
3. See GenerateQueryResponseTypeDef

# generate_query method usage example with argument unpacking

kwargs: GenerateQueryRequestTypeDef = {  # (1)
    "queryGenerationInput": ...,
    "transformationConfiguration": ...,
}

parent.generate_query(**kwargs)

1. See GenerateQueryRequestTypeDef

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: GetAgentMemoryRequestTypeDef = {  # (1)
    "agentAliasId": ...,
    "agentId": ...,
    "memoryId": ...,
    "memoryType": ...,
}

parent.get_agent_memory(**kwargs)

1. See GetAgentMemoryRequestTypeDef

get_invocation_step

Retrieves the details of a specific invocation step within an invocation in a session.

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

# get_invocation_step method definition

def get_invocation_step(
    self,
    *,
    invocationIdentifier: str,
    invocationStepId: str,
    sessionIdentifier: str,
) -> GetInvocationStepResponseTypeDef:  # (1)
    ...

1. See GetInvocationStepResponseTypeDef

# get_invocation_step method usage example with argument unpacking

kwargs: GetInvocationStepRequestTypeDef = {  # (1)
    "invocationIdentifier": ...,
    "invocationStepId": ...,
    "sessionIdentifier": ...,
}

parent.get_invocation_step(**kwargs)

1. See GetInvocationStepRequestTypeDef

get_session

Retrieves details about a specific session.

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

# get_session method definition

def get_session(
    self,
    *,
    sessionIdentifier: str,
) -> GetSessionResponseTypeDef:  # (1)
    ...

1. See GetSessionResponseTypeDef

# get_session method usage example with argument unpacking

kwargs: GetSessionRequestTypeDef = {  # (1)
    "sessionIdentifier": ...,
}

parent.get_session(**kwargs)

1. See GetSessionRequestTypeDef

invoke_agent

Sends a prompt for the agent to process and respond to.

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,
    bedrockModelConfigurations: BedrockModelConfigurationsTypeDef = ...,  # (1)
    enableTrace: bool = ...,
    endSession: bool = ...,
    inputText: str = ...,
    memoryId: str = ...,
    sessionState: SessionStateTypeDef = ...,  # (2)
    sourceArn: str = ...,
    streamingConfigurations: StreamingConfigurationsTypeDef = ...,  # (3)
) -> InvokeAgentResponseTypeDef:  # (4)
    ...

1. See BedrockModelConfigurationsTypeDef
2. See SessionStateTypeDef
3. See StreamingConfigurationsTypeDef
4. See InvokeAgentResponseTypeDef

# invoke_agent method usage example with argument unpacking

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

parent.invoke_agent(**kwargs)

1. See InvokeAgentRequestTypeDef

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 = ...,
    executionId: str = ...,
    modelPerformanceConfiguration: ModelPerformanceConfigurationTypeDef = ...,  # (2)
) -> InvokeFlowResponseTypeDef:  # (3)
    ...

1. See Sequence[FlowInputTypeDef]
2. See ModelPerformanceConfigurationTypeDef
3. See InvokeFlowResponseTypeDef

# invoke_flow method usage example with argument unpacking

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

parent.invoke_flow(**kwargs)

1. See InvokeFlowRequestTypeDef

invoke_inline_agent

Invokes an inline Amazon Bedrock agent using the configurations you provide with the request.

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

# invoke_inline_agent method definition

def invoke_inline_agent(
    self,
    *,
    foundationModel: str,
    instruction: str,
    sessionId: str,
    actionGroups: Sequence[AgentActionGroupTypeDef] = ...,  # (1)
    agentCollaboration: AgentCollaborationType = ...,  # (2)
    bedrockModelConfigurations: InlineBedrockModelConfigurationsTypeDef = ...,  # (3)
    collaboratorConfigurations: Sequence[CollaboratorConfigurationTypeDef] = ...,  # (4)
    collaborators: Sequence[CollaboratorTypeDef] = ...,  # (5)
    customerEncryptionKeyArn: str = ...,
    enableTrace: bool = ...,
    endSession: bool = ...,
    guardrailConfiguration: GuardrailConfigurationWithArnTypeDef = ...,  # (6)
    idleSessionTTLInSeconds: int = ...,
    inlineSessionState: InlineSessionStateTypeDef = ...,  # (7)
    inputText: str = ...,
    knowledgeBases: Sequence[KnowledgeBaseTypeDef] = ...,  # (8)
    promptOverrideConfiguration: PromptOverrideConfigurationTypeDef = ...,  # (9)
    streamingConfigurations: StreamingConfigurationsTypeDef = ...,  # (10)
) -> InvokeInlineAgentResponseTypeDef:  # (11)
    ...

1. See Sequence[AgentActionGroupTypeDef]
2. See AgentCollaborationType
3. See InlineBedrockModelConfigurationsTypeDef
4. See Sequence[CollaboratorConfigurationTypeDef]
5. See Sequence[CollaboratorTypeDef]
6. See GuardrailConfigurationWithArnTypeDef
7. See InlineSessionStateTypeDef
8. See Sequence[KnowledgeBaseTypeDef]
9. See PromptOverrideConfigurationTypeDef
10. See StreamingConfigurationsTypeDef
11. See InvokeInlineAgentResponseTypeDef

# invoke_inline_agent method usage example with argument unpacking

kwargs: InvokeInlineAgentRequestTypeDef = {  # (1)
    "foundationModel": ...,
    "instruction": ...,
    "sessionId": ...,
}

parent.invoke_inline_agent(**kwargs)

1. See InvokeInlineAgentRequestTypeDef

list_invocation_steps

Lists all invocation steps associated with a session and optionally, an invocation within the session.

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

# list_invocation_steps method definition

def list_invocation_steps(
    self,
    *,
    sessionIdentifier: str,
    invocationIdentifier: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListInvocationStepsResponseTypeDef:  # (1)
    ...

1. See ListInvocationStepsResponseTypeDef

# list_invocation_steps method usage example with argument unpacking

kwargs: ListInvocationStepsRequestTypeDef = {  # (1)
    "sessionIdentifier": ...,
}

parent.list_invocation_steps(**kwargs)

1. See ListInvocationStepsRequestTypeDef

list_invocations

Lists all invocations associated with a specific session.

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

# list_invocations method definition

def list_invocations(
    self,
    *,
    sessionIdentifier: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListInvocationsResponseTypeDef:  # (1)
    ...

1. See ListInvocationsResponseTypeDef

# list_invocations method usage example with argument unpacking

kwargs: ListInvocationsRequestTypeDef = {  # (1)
    "sessionIdentifier": ...,
}

parent.list_invocations(**kwargs)

1. See ListInvocationsRequestTypeDef

list_sessions

Lists all sessions in your Amazon Web Services account.

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

# list_sessions method definition

def list_sessions(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSessionsResponseTypeDef:  # (1)
    ...

1. See ListSessionsResponseTypeDef

# list_sessions method usage example with argument unpacking

kwargs: ListSessionsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_sessions(**kwargs)

1. See ListSessionsRequestTypeDef

list_tags_for_resource

List all the tags for the resource you specify.

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

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: OptimizePromptRequestTypeDef = {  # (1)
    "input": ...,
    "targetModelId": ...,
}

parent.optimize_prompt(**kwargs)

1. See OptimizePromptRequestTypeDef

put_invocation_step

Add an invocation step to an invocation in a session.

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

# put_invocation_step method definition

def put_invocation_step(
    self,
    *,
    invocationIdentifier: str,
    invocationStepTime: TimestampTypeDef,
    payload: InvocationStepPayloadUnionTypeDef,  # (1)
    sessionIdentifier: str,
    invocationStepId: str = ...,
) -> PutInvocationStepResponseTypeDef:  # (2)
    ...

1. See InvocationStepPayloadUnionTypeDef
2. See PutInvocationStepResponseTypeDef

# put_invocation_step method usage example with argument unpacking

kwargs: PutInvocationStepRequestTypeDef = {  # (1)
    "invocationIdentifier": ...,
    "invocationStepTime": ...,
    "payload": ...,
    "sessionIdentifier": ...,
}

parent.put_invocation_step(**kwargs)

1. See PutInvocationStepRequestTypeDef

rerank

Reranks the relevance of sources based on queries.

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

# rerank method definition

def rerank(
    self,
    *,
    queries: Sequence[RerankQueryTypeDef],  # (1)
    rerankingConfiguration: RerankingConfigurationTypeDef,  # (2)
    sources: Sequence[RerankSourceTypeDef],  # (3)
    nextToken: str = ...,
) -> RerankResponseTypeDef:  # (4)
    ...

1. See Sequence[RerankQueryTypeDef]
2. See RerankingConfigurationTypeDef
3. See Sequence[RerankSourceTypeDef]
4. See RerankResponseTypeDef

# rerank method usage example with argument unpacking

kwargs: RerankRequestTypeDef = {  # (1)
    "queries": ...,
    "rerankingConfiguration": ...,
    "sources": ...,
}

parent.rerank(**kwargs)

1. See RerankRequestTypeDef

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

1. See KnowledgeBaseQueryTypeDef
2. See GuardrailConfigurationTypeDef
3. See KnowledgeBaseRetrievalConfigurationTypeDef
4. See RetrieveResponseTypeDef

# retrieve method usage example with argument unpacking

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

parent.retrieve(**kwargs)

1. See RetrieveRequestTypeDef

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: RetrieveAndGenerateRequestTypeDef = {  # (1)
    "input": ...,
}

parent.retrieve_and_generate(**kwargs)

1. See RetrieveAndGenerateRequestTypeDef

retrieve_and_generate_stream

Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.

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

# retrieve_and_generate_stream method definition

def retrieve_and_generate_stream(
    self,
    *,
    input: RetrieveAndGenerateInputTypeDef,  # (1)
    retrieveAndGenerateConfiguration: RetrieveAndGenerateConfigurationTypeDef = ...,  # (2)
    sessionConfiguration: RetrieveAndGenerateSessionConfigurationTypeDef = ...,  # (3)
    sessionId: str = ...,
) -> RetrieveAndGenerateStreamResponseTypeDef:  # (4)
    ...

1. See RetrieveAndGenerateInputTypeDef
2. See RetrieveAndGenerateConfigurationTypeDef
3. See RetrieveAndGenerateSessionConfigurationTypeDef
4. See RetrieveAndGenerateStreamResponseTypeDef

# retrieve_and_generate_stream method usage example with argument unpacking

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

parent.retrieve_and_generate_stream(**kwargs)

1. See RetrieveAndGenerateStreamRequestTypeDef

tag_resource

Associate tags with a resource.

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Remove tags from a resource.

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

update_session

Updates the metadata or encryption settings of a session.

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

# update_session method definition

def update_session(
    self,
    *,
    sessionIdentifier: str,
    sessionMetadata: Mapping[str, str] = ...,
) -> UpdateSessionResponseTypeDef:  # (1)
    ...

1. See UpdateSessionResponseTypeDef

# update_session method usage example with argument unpacking

kwargs: UpdateSessionRequestTypeDef = {  # (1)
    "sessionIdentifier": ...,
}

parent.update_session(**kwargs)

1. See UpdateSessionRequestTypeDef

get_paginator

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

• client.get_paginator("get_agent_memory") -> GetAgentMemoryPaginator
• client.get_paginator("list_invocation_steps") -> ListInvocationStepsPaginator
• client.get_paginator("list_invocations") -> ListInvocationsPaginator
• client.get_paginator("list_sessions") -> ListSessionsPaginator
• client.get_paginator("rerank") -> RerankPaginator
• client.get_paginator("retrieve") -> RetrievePaginator