rboto-bedrock-agent

rboto is an independent project maintained by Ferrumio. It is not affiliated with, sponsored by, or endorsed by Amazon Web Services (AWS).

Preview (Alpha). rboto is under active development. APIs may change between releases.

rboto provides an async-only, typed Python client for Amazon Bedrock Agents, powered by Rust. This package contains BedrockAgentClient and 86 operations.

Installation

Requires Python 3.12 or newer and a native wheel for your Python version and platform.

python -m pip install "rboto[bedrock-agent]"

You can also install rboto-bedrock-agent directly; it installs the matching rboto package. Only the selected service is installed.

These are the package names to use when a release is available on your package index. If your index has no release yet, follow the source installation instructions.

Usage

Configure credentials through your environment, shared profile, or workload role. The example uses us-east-1; select a region where your service and resources are available. Resource names, identifiers, input files, and model IDs in the example are placeholders to replace with your own.

import asyncio

from rboto import BedrockAgentClient


async def main() -> None:
    client = BedrockAgentClient(region="us-east-1")
    response = await client.list_agents(max_results=10)
    for agent in response.agent_summaries:
        print(agent.agent_id, agent.agent_name)


if __name__ == "__main__":
    asyncio.run(main())

In an application with an event loop, call await main() instead of asyncio.run(main()). Reuse the client across calls. Constructing a client does not send a request.

API conventions

• Import the client with from rboto import BedrockAgentClient.

• Every operation is asynchronous: use await client.method(...).

• Operation arguments are keyword-only and use the Python names listed below.

• Structured inputs use typed dictionaries and tagged unions from rboto_bedrock_agent.types.

• Regular responses expose typed attributes; response.to_dict() converts them to a dictionary.

• Event-stream responses may be typed dictionaries containing async iterators. Follow the declared return type; consume event streams with async for.

• Byte streams are consumed asynchronously. await stream.read() buffers the complete body; iterate the stream when processing a large response.

• Direct operation calls return one page.

• Use async for page in client.paginators.method(...) for supported paginated operations. Paginators accept the same typed arguments as the corresponding client method.

• Catch modeled exceptions from rboto_bedrock_agent.exceptions. Their error_code, message, and operation_name identify service failures.

Clients also accept profile, endpoint_url, or shared Session settings. See configuration, errors, and streaming.

Operations

This is the complete operation catalog for this generated package. “Required arguments” lists arguments without defaults in the Python signature. Service-side conditions may require additional arguments. Each method links to its complete signature, including optional arguments. Nested input definitions are in rboto_bedrock_agent.types; native response definitions are in the package's _native.pyi.

Method	Required arguments	Return type
associate_agent_collaborator	agent_id: str, agent_version: str, agent_descriptor: AgentDescriptor, collaborator_name: str, collaboration_instruction: str	AssociateAgentCollaboratorOutput
associate_agent_knowledge_base	agent_id: str, agent_version: str, knowledge_base_id: str, description: str	AssociateAgentKnowledgeBaseOutput
create_agent	agent_name: str	CreateAgentOutput
create_agent_action_group	agent_id: str, agent_version: str, action_group_name: str	CreateAgentActionGroupOutput
create_agent_alias	agent_id: str, agent_alias_name: str	CreateAgentAliasOutput
create_data_source	knowledge_base_id: str, name: str, data_source_configuration: DataSourceConfiguration	CreateDataSourceOutput
create_flow	name: str, execution_role_arn: str	CreateFlowOutput
create_flow_alias	name: str, routing_configuration: Sequence[FlowAliasRoutingConfigurationListItem], flow_identifier: str	CreateFlowAliasOutput
create_flow_version	flow_identifier: str	CreateFlowVersionOutput
create_knowledge_base	name: str, role_arn: str, knowledge_base_configuration: KnowledgeBaseConfiguration	CreateKnowledgeBaseOutput
create_prompt	name: str	CreatePromptOutput
create_prompt_version	prompt_identifier: str	CreatePromptVersionOutput
create_retrieval_instruction	name: str, instruction: RetrievalInstructionContent	CreateRetrievalInstructionOutput
create_retrieval_instruction_version	retrieval_instruction_id: str	CreateRetrievalInstructionVersionOutput
create_vpc_configuration	knowledge_base_id: str, vpc_id: str, subnet_ids: Sequence[str], resource_target: str, port: int, protocol: VpcProtocol, resolution_mode: VpcResolutionMode	CreateVpcConfigurationOutput
delete_agent	agent_id: str	DeleteAgentOutput
delete_agent_action_group	agent_id: str, agent_version: str, action_group_id: str	DeleteAgentActionGroupOutput
delete_agent_alias	agent_id: str, agent_alias_id: str	DeleteAgentAliasOutput
delete_agent_version	agent_id: str, agent_version: str	DeleteAgentVersionOutput
delete_data_source	knowledge_base_id: str, data_source_id: str	DeleteDataSourceOutput
delete_flow	flow_identifier: str	DeleteFlowOutput
delete_flow_alias	flow_identifier: str, alias_identifier: str	DeleteFlowAliasOutput
delete_flow_version	flow_identifier: str, flow_version: str	DeleteFlowVersionOutput
delete_knowledge_base	knowledge_base_id: str	DeleteKnowledgeBaseOutput
delete_knowledge_base_documents	knowledge_base_id: str, data_source_id: str, document_identifiers: Sequence[DocumentIdentifier]	DeleteKnowledgeBaseDocumentsOutput
delete_prompt	prompt_identifier: str	DeletePromptOutput
delete_resource_policy	resource_arn: str	DeleteResourcePolicyOutput
delete_retrieval_instruction	retrieval_instruction_id: str	DeleteRetrievalInstructionOutput
delete_vpc_configuration	knowledge_base_id: str, vpc_configuration_id: str	DeleteVpcConfigurationOutput
disassociate_agent_collaborator	agent_id: str, agent_version: str, collaborator_id: str	DisassociateAgentCollaboratorOutput
disassociate_agent_knowledge_base	agent_id: str, agent_version: str, knowledge_base_id: str	DisassociateAgentKnowledgeBaseOutput
get_agent	agent_id: str	GetAgentOutput
get_agent_action_group	agent_id: str, agent_version: str, action_group_id: str	GetAgentActionGroupOutput
get_agent_alias	agent_id: str, agent_alias_id: str	GetAgentAliasOutput
get_agent_collaborator	agent_id: str, agent_version: str, collaborator_id: str	GetAgentCollaboratorOutput
get_agent_knowledge_base	agent_id: str, agent_version: str, knowledge_base_id: str	GetAgentKnowledgeBaseOutput
get_agent_version	agent_id: str, agent_version: str	GetAgentVersionOutput
get_data_source	knowledge_base_id: str, data_source_id: str	GetDataSourceOutput
get_flow	flow_identifier: str	GetFlowOutput
get_flow_alias	flow_identifier: str, alias_identifier: str	GetFlowAliasOutput
get_flow_version	flow_identifier: str, flow_version: str	GetFlowVersionOutput
get_ingestion_job	knowledge_base_id: str, data_source_id: str, ingestion_job_id: str	GetIngestionJobOutput
get_knowledge_base	knowledge_base_id: str	GetKnowledgeBaseOutput
get_knowledge_base_documents	knowledge_base_id: str, data_source_id: str, document_identifiers: Sequence[DocumentIdentifier]	GetKnowledgeBaseDocumentsOutput
get_prompt	prompt_identifier: str	GetPromptOutput
get_resource_policy	resource_arn: str	GetResourcePolicyOutput
get_retrieval_instruction	retrieval_instruction_id: str	GetRetrievalInstructionOutput
get_vpc_configuration	knowledge_base_id: str, vpc_configuration_id: str	GetVpcConfigurationOutput
ingest_knowledge_base_documents	knowledge_base_id: str, data_source_id: str, documents: Sequence[KnowledgeBaseDocument]	IngestKnowledgeBaseDocumentsOutput
list_agent_action_groups	agent_id: str, agent_version: str	ListAgentActionGroupsOutput
list_agent_aliases	agent_id: str	ListAgentAliasesOutput
list_agent_collaborators	agent_id: str, agent_version: str	ListAgentCollaboratorsOutput
list_agent_knowledge_bases	agent_id: str, agent_version: str	ListAgentKnowledgeBasesOutput
list_agent_versions	agent_id: str	ListAgentVersionsOutput
list_agents	None	ListAgentsOutput
list_data_sources	knowledge_base_id: str	ListDataSourcesOutput
list_flow_aliases	flow_identifier: str	ListFlowAliasesOutput
list_flow_versions	flow_identifier: str	ListFlowVersionsOutput
list_flows	None	ListFlowsOutput
list_ingestion_jobs	knowledge_base_id: str, data_source_id: str	ListIngestionJobsOutput
list_knowledge_base_documents	knowledge_base_id: str, data_source_id: str	ListKnowledgeBaseDocumentsOutput
list_knowledge_bases	None	ListKnowledgeBasesOutput
list_prompts	None	ListPromptsOutput
list_retrieval_instruction_versions	retrieval_instruction_id: str	ListRetrievalInstructionVersionsOutput
list_retrieval_instructions	None	ListRetrievalInstructionsOutput
list_tags_for_resource	resource_arn: str	ListTagsForResourceOutput
list_vpc_configurations	knowledge_base_id: str	ListVpcConfigurationsOutput
prepare_agent	agent_id: str	PrepareAgentOutput
prepare_flow	flow_identifier: str	PrepareFlowOutput
put_resource_policy	resource_arn: str, policy: str	PutResourcePolicyOutput
start_ingestion_job	knowledge_base_id: str, data_source_id: str	StartIngestionJobOutput
stop_ingestion_job	knowledge_base_id: str, data_source_id: str, ingestion_job_id: str	StopIngestionJobOutput
tag_resource	resource_arn: str, tags: dict[str, str]	TagResourceOutput
untag_resource	resource_arn: str, tag_keys: Sequence[str]	UntagResourceOutput
update_agent	agent_id: str, agent_name: str, foundation_model: str, agent_resource_role_arn: str	UpdateAgentOutput
update_agent_action_group	agent_id: str, agent_version: str, action_group_id: str, action_group_name: str	UpdateAgentActionGroupOutput
update_agent_alias	agent_id: str, agent_alias_id: str, agent_alias_name: str	UpdateAgentAliasOutput
update_agent_collaborator	agent_id: str, agent_version: str, collaborator_id: str, agent_descriptor: AgentDescriptor, collaborator_name: str, collaboration_instruction: str	UpdateAgentCollaboratorOutput
update_agent_knowledge_base	agent_id: str, agent_version: str, knowledge_base_id: str	UpdateAgentKnowledgeBaseOutput
update_data_source	knowledge_base_id: str, data_source_id: str, name: str, data_source_configuration: DataSourceConfiguration	UpdateDataSourceOutput
update_flow	name: str, execution_role_arn: str, flow_identifier: str	UpdateFlowOutput
update_flow_alias	name: str, routing_configuration: Sequence[FlowAliasRoutingConfigurationListItem], flow_identifier: str, alias_identifier: str	UpdateFlowAliasOutput
update_knowledge_base	knowledge_base_id: str, name: str, role_arn: str, knowledge_base_configuration: KnowledgeBaseConfiguration	UpdateKnowledgeBaseOutput
update_prompt	name: str, prompt_identifier: str	UpdatePromptOutput
update_retrieval_instruction	retrieval_instruction_id: str, instruction: RetrievalInstructionContent	UpdateRetrievalInstructionOutput
validate_flow_definition	definition: FlowDefinition	ValidateFlowDefinitionOutput

Complete signatures

associate_agent_collaborator

async def associate_agent_collaborator(
    *,
    agent_id: str,
    agent_version: str,
    agent_descriptor: AgentDescriptor,
    collaborator_name: str,
    collaboration_instruction: str,
    relay_conversation_history: RelayConversationHistory | None = None,
    client_token: str | None = None,
) -> AssociateAgentCollaboratorOutput: ...

associate_agent_knowledge_base

async def associate_agent_knowledge_base(
    *,
    agent_id: str,
    agent_version: str,
    knowledge_base_id: str,
    description: str,
    knowledge_base_state: KnowledgeBaseState | None = None,
) -> AssociateAgentKnowledgeBaseOutput: ...

create_agent

async def create_agent(
    *,
    agent_name: str,
    client_token: str | None = None,
    instruction: str | None = None,
    foundation_model: str | None = None,
    description: str | None = None,
    orchestration_type: OrchestrationType | None = None,
    custom_orchestration: CustomOrchestration | None = None,
    idle_session_ttl_in_seconds: int | None = None,
    agent_resource_role_arn: str | None = None,
    customer_encryption_key_arn: str | None = None,
    tags: dict[str, str] | None = None,
    prompt_override_configuration: PromptOverrideConfiguration | None = None,
    guardrail_configuration: GuardrailConfiguration | None = None,
    memory_configuration: MemoryConfiguration | None = None,
    agent_collaboration: AgentCollaboration | None = None,
) -> CreateAgentOutput: ...

create_agent_action_group

async def create_agent_action_group(
    *,
    agent_id: str,
    agent_version: str,
    action_group_name: str,
    client_token: str | None = None,
    description: str | None = None,
    parent_action_group_signature: ActionGroupSignature | None = None,
    parent_action_group_signature_params: dict[str, str] | None = None,
    action_group_executor: ActionGroupExecutor | None = None,
    api_schema: APISchema | None = None,
    action_group_state: ActionGroupState | None = None,
    function_schema: FunctionSchema | None = None,
) -> CreateAgentActionGroupOutput: ...

create_agent_alias

async def create_agent_alias(
    *,
    agent_id: str,
    agent_alias_name: str,
    client_token: str | None = None,
    description: str | None = None,
    routing_configuration: Sequence[AgentAliasRoutingConfigurationListItem] | None = None,
    tags: dict[str, str] | None = None,
) -> CreateAgentAliasOutput: ...

create_data_source

async def create_data_source(
    *,
    knowledge_base_id: str,
    name: str,
    data_source_configuration: DataSourceConfiguration,
    client_token: str | None = None,
    description: str | None = None,
    data_deletion_policy: DataDeletionPolicy | None = None,
    server_side_encryption_configuration: ServerSideEncryptionConfiguration | None = None,
    vector_ingestion_configuration: VectorIngestionConfiguration | None = None,
) -> CreateDataSourceOutput: ...

create_flow

async def create_flow(
    *,
    name: str,
    execution_role_arn: str,
    description: str | None = None,
    customer_encryption_key_arn: str | None = None,
    definition: FlowDefinition | None = None,
    client_token: str | None = None,
    tags: dict[str, str] | None = None,
) -> CreateFlowOutput: ...

create_flow_alias

async def create_flow_alias(
    *,
    name: str,
    routing_configuration: Sequence[FlowAliasRoutingConfigurationListItem],
    flow_identifier: str,
    description: str | None = None,
    concurrency_configuration: FlowAliasConcurrencyConfiguration | None = None,
    client_token: str | None = None,
    tags: dict[str, str] | None = None,
) -> CreateFlowAliasOutput: ...

create_flow_version

async def create_flow_version(
    *,
    flow_identifier: str,
    description: str | None = None,
    client_token: str | None = None,
) -> CreateFlowVersionOutput: ...

create_knowledge_base

async def create_knowledge_base(
    *,
    name: str,
    role_arn: str,
    knowledge_base_configuration: KnowledgeBaseConfiguration,
    client_token: str | None = None,
    description: str | None = None,
    storage_configuration: StorageConfiguration | None = None,
    tags: dict[str, str] | None = None,
) -> CreateKnowledgeBaseOutput: ...

create_prompt

async def create_prompt(
    *,
    name: str,
    description: str | None = None,
    customer_encryption_key_arn: str | None = None,
    default_variant: str | None = None,
    variants: Sequence[PromptVariant] | None = None,
    client_token: str | None = None,
    tags: dict[str, str] | None = None,
) -> CreatePromptOutput: ...

create_prompt_version

async def create_prompt_version(
    *,
    prompt_identifier: str,
    description: str | None = None,
    client_token: str | None = None,
    tags: dict[str, str] | None = None,
) -> CreatePromptVersionOutput: ...

create_retrieval_instruction

async def create_retrieval_instruction(
    *,
    name: str,
    instruction: RetrievalInstructionContent,
    client_token: str | None = None,
    description: str | None = None,
    customer_encryption_key_arn: str | None = None,
    tags: dict[str, str] | None = None,
) -> CreateRetrievalInstructionOutput: ...

create_retrieval_instruction_version

async def create_retrieval_instruction_version(
    *,
    retrieval_instruction_id: str,
    description: str | None = None,
    client_token: str | None = None,
) -> CreateRetrievalInstructionVersionOutput: ...

create_vpc_configuration

async def create_vpc_configuration(
    *,
    knowledge_base_id: str,
    vpc_id: str,
    subnet_ids: Sequence[str],
    resource_target: str,
    port: int,
    protocol: VpcProtocol,
    resolution_mode: VpcResolutionMode,
    client_token: str | None = None,
    host_header: str | None = None,
    tls_server_name: str | None = None,
    name: str | None = None,
    description: str | None = None,
) -> CreateVpcConfigurationOutput: ...

delete_agent

async def delete_agent(
    *,
    agent_id: str,
    skip_resource_in_use_check: bool | None = None,
) -> DeleteAgentOutput: ...

delete_agent_action_group

async def delete_agent_action_group(
    *,
    agent_id: str,
    agent_version: str,
    action_group_id: str,
    skip_resource_in_use_check: bool | None = None,
) -> DeleteAgentActionGroupOutput: ...

delete_agent_alias

async def delete_agent_alias(
    *,
    agent_id: str,
    agent_alias_id: str,
) -> DeleteAgentAliasOutput: ...

delete_agent_version

async def delete_agent_version(
    *,
    agent_id: str,
    agent_version: str,
    skip_resource_in_use_check: bool | None = None,
) -> DeleteAgentVersionOutput: ...

delete_data_source

async def delete_data_source(
    *,
    knowledge_base_id: str,
    data_source_id: str,
) -> DeleteDataSourceOutput: ...

delete_flow

async def delete_flow(
    *,
    flow_identifier: str,
    skip_resource_in_use_check: bool | None = None,
) -> DeleteFlowOutput: ...

delete_flow_alias

async def delete_flow_alias(
    *,
    flow_identifier: str,
    alias_identifier: str,
) -> DeleteFlowAliasOutput: ...

delete_flow_version

async def delete_flow_version(
    *,
    flow_identifier: str,
    flow_version: str,
    skip_resource_in_use_check: bool | None = None,
) -> DeleteFlowVersionOutput: ...

delete_knowledge_base

async def delete_knowledge_base(
    *,
    knowledge_base_id: str,
) -> DeleteKnowledgeBaseOutput: ...

delete_knowledge_base_documents

async def delete_knowledge_base_documents(
    *,
    knowledge_base_id: str,
    data_source_id: str,
    document_identifiers: Sequence[DocumentIdentifier],
    client_token: str | None = None,
) -> DeleteKnowledgeBaseDocumentsOutput: ...

delete_prompt

async def delete_prompt(
    *,
    prompt_identifier: str,
    prompt_version: str | None = None,
) -> DeletePromptOutput: ...

delete_resource_policy

async def delete_resource_policy(
    *,
    resource_arn: str,
    expected_revision_id: str | None = None,
) -> DeleteResourcePolicyOutput: ...

delete_retrieval_instruction

async def delete_retrieval_instruction(
    *,
    retrieval_instruction_id: str,
    retrieval_instruction_version: str | None = None,
) -> DeleteRetrievalInstructionOutput: ...

delete_vpc_configuration

async def delete_vpc_configuration(
    *,
    knowledge_base_id: str,
    vpc_configuration_id: str,
) -> DeleteVpcConfigurationOutput: ...

disassociate_agent_collaborator

async def disassociate_agent_collaborator(
    *,
    agent_id: str,
    agent_version: str,
    collaborator_id: str,
) -> DisassociateAgentCollaboratorOutput: ...

disassociate_agent_knowledge_base

async def disassociate_agent_knowledge_base(
    *,
    agent_id: str,
    agent_version: str,
    knowledge_base_id: str,
) -> DisassociateAgentKnowledgeBaseOutput: ...

get_agent

async def get_agent(
    *,
    agent_id: str,
) -> GetAgentOutput: ...

get_agent_action_group

async def get_agent_action_group(
    *,
    agent_id: str,
    agent_version: str,
    action_group_id: str,
) -> GetAgentActionGroupOutput: ...

get_agent_alias

async def get_agent_alias(
    *,
    agent_id: str,
    agent_alias_id: str,
) -> GetAgentAliasOutput: ...

get_agent_collaborator

async def get_agent_collaborator(
    *,
    agent_id: str,
    agent_version: str,
    collaborator_id: str,
) -> GetAgentCollaboratorOutput: ...

get_agent_knowledge_base

async def get_agent_knowledge_base(
    *,
    agent_id: str,
    agent_version: str,
    knowledge_base_id: str,
) -> GetAgentKnowledgeBaseOutput: ...

get_agent_version

async def get_agent_version(
    *,
    agent_id: str,
    agent_version: str,
) -> GetAgentVersionOutput: ...

get_data_source

async def get_data_source(
    *,
    knowledge_base_id: str,
    data_source_id: str,
) -> GetDataSourceOutput: ...

get_flow

async def get_flow(
    *,
    flow_identifier: str,
    included_data: IncludedData | None = None,
) -> GetFlowOutput: ...

get_flow_alias

async def get_flow_alias(
    *,
    flow_identifier: str,
    alias_identifier: str,
) -> GetFlowAliasOutput: ...

get_flow_version

async def get_flow_version(
    *,
    flow_identifier: str,
    flow_version: str,
    included_data: IncludedData | None = None,
) -> GetFlowVersionOutput: ...

get_ingestion_job

async def get_ingestion_job(
    *,
    knowledge_base_id: str,
    data_source_id: str,
    ingestion_job_id: str,
) -> GetIngestionJobOutput: ...

get_knowledge_base

async def get_knowledge_base(
    *,
    knowledge_base_id: str,
) -> GetKnowledgeBaseOutput: ...

get_knowledge_base_documents

async def get_knowledge_base_documents(
    *,
    knowledge_base_id: str,
    data_source_id: str,
    document_identifiers: Sequence[DocumentIdentifier],
) -> GetKnowledgeBaseDocumentsOutput: ...

get_prompt

async def get_prompt(
    *,
    prompt_identifier: str,
    prompt_version: str | None = None,
    included_data: IncludedData | None = None,
) -> GetPromptOutput: ...

get_resource_policy

async def get_resource_policy(
    *,
    resource_arn: str,
) -> GetResourcePolicyOutput: ...

get_retrieval_instruction

async def get_retrieval_instruction(
    *,
    retrieval_instruction_id: str,
    retrieval_instruction_version: str | None = None,
) -> GetRetrievalInstructionOutput: ...

get_vpc_configuration

async def get_vpc_configuration(
    *,
    knowledge_base_id: str,
    vpc_configuration_id: str,
) -> GetVpcConfigurationOutput: ...

ingest_knowledge_base_documents

async def ingest_knowledge_base_documents(
    *,
    knowledge_base_id: str,
    data_source_id: str,
    documents: Sequence[KnowledgeBaseDocument],
    client_token: str | None = None,
) -> IngestKnowledgeBaseDocumentsOutput: ...

list_agent_action_groups

async def list_agent_action_groups(
    *,
    agent_id: str,
    agent_version: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListAgentActionGroupsOutput: ...

Also available as client.paginators.list_agent_action_groups(...), returning an async iterator of the response type above.

list_agent_aliases

async def list_agent_aliases(
    *,
    agent_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListAgentAliasesOutput: ...

Also available as client.paginators.list_agent_aliases(...), returning an async iterator of the response type above.

list_agent_collaborators

async def list_agent_collaborators(
    *,
    agent_id: str,
    agent_version: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListAgentCollaboratorsOutput: ...

Also available as client.paginators.list_agent_collaborators(...), returning an async iterator of the response type above.

list_agent_knowledge_bases

async def list_agent_knowledge_bases(
    *,
    agent_id: str,
    agent_version: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListAgentKnowledgeBasesOutput: ...

Also available as client.paginators.list_agent_knowledge_bases(...), returning an async iterator of the response type above.

list_agent_versions

async def list_agent_versions(
    *,
    agent_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListAgentVersionsOutput: ...

Also available as client.paginators.list_agent_versions(...), returning an async iterator of the response type above.

list_agents

async def list_agents(
    *,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListAgentsOutput: ...

Also available as client.paginators.list_agents(...), returning an async iterator of the response type above.

list_data_sources

async def list_data_sources(
    *,
    knowledge_base_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListDataSourcesOutput: ...

Also available as client.paginators.list_data_sources(...), returning an async iterator of the response type above.

list_flow_aliases

async def list_flow_aliases(
    *,
    flow_identifier: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListFlowAliasesOutput: ...

Also available as client.paginators.list_flow_aliases(...), returning an async iterator of the response type above.

list_flow_versions

async def list_flow_versions(
    *,
    flow_identifier: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListFlowVersionsOutput: ...

Also available as client.paginators.list_flow_versions(...), returning an async iterator of the response type above.

list_flows

async def list_flows(
    *,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListFlowsOutput: ...

Also available as client.paginators.list_flows(...), returning an async iterator of the response type above.

list_ingestion_jobs

async def list_ingestion_jobs(
    *,
    knowledge_base_id: str,
    data_source_id: str,
    filters: Sequence[IngestionJobFilter] | None = None,
    sort_by: IngestionJobSortBy | None = None,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListIngestionJobsOutput: ...

Also available as client.paginators.list_ingestion_jobs(...), returning an async iterator of the response type above.

list_knowledge_base_documents

async def list_knowledge_base_documents(
    *,
    knowledge_base_id: str,
    data_source_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListKnowledgeBaseDocumentsOutput: ...

Also available as client.paginators.list_knowledge_base_documents(...), returning an async iterator of the response type above.

list_knowledge_bases

async def list_knowledge_bases(
    *,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListKnowledgeBasesOutput: ...

Also available as client.paginators.list_knowledge_bases(...), returning an async iterator of the response type above.

list_prompts

async def list_prompts(
    *,
    prompt_identifier: str | None = None,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListPromptsOutput: ...

Also available as client.paginators.list_prompts(...), returning an async iterator of the response type above.

list_retrieval_instruction_versions

async def list_retrieval_instruction_versions(
    *,
    retrieval_instruction_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListRetrievalInstructionVersionsOutput: ...

Also available as client.paginators.list_retrieval_instruction_versions(...), returning an async iterator of the response type above.

list_retrieval_instructions

async def list_retrieval_instructions(
    *,
    status: RetrievalInstructionStatus | None = None,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListRetrievalInstructionsOutput: ...

Also available as client.paginators.list_retrieval_instructions(...), returning an async iterator of the response type above.

list_tags_for_resource

async def list_tags_for_resource(
    *,
    resource_arn: str,
) -> ListTagsForResourceOutput: ...

list_vpc_configurations

async def list_vpc_configurations(
    *,
    knowledge_base_id: str,
    status_filter: VpcConfigurationStatus | None = None,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListVpcConfigurationsOutput: ...

Also available as client.paginators.list_vpc_configurations(...), returning an async iterator of the response type above.

prepare_agent

async def prepare_agent(
    *,
    agent_id: str,
) -> PrepareAgentOutput: ...

prepare_flow

async def prepare_flow(
    *,
    flow_identifier: str,
) -> PrepareFlowOutput: ...

put_resource_policy

async def put_resource_policy(
    *,
    resource_arn: str,
    policy: str,
    expected_revision_id: str | None = None,
) -> PutResourcePolicyOutput: ...

start_ingestion_job

async def start_ingestion_job(
    *,
    knowledge_base_id: str,
    data_source_id: str,
    client_token: str | None = None,
    description: str | None = None,
) -> StartIngestionJobOutput: ...

stop_ingestion_job

async def stop_ingestion_job(
    *,
    knowledge_base_id: str,
    data_source_id: str,
    ingestion_job_id: str,
) -> StopIngestionJobOutput: ...

tag_resource

async def tag_resource(
    *,
    resource_arn: str,
    tags: dict[str, str],
) -> TagResourceOutput: ...

untag_resource

async def untag_resource(
    *,
    resource_arn: str,
    tag_keys: Sequence[str],
) -> UntagResourceOutput: ...

update_agent

async def update_agent(
    *,
    agent_id: str,
    agent_name: str,
    foundation_model: str,
    agent_resource_role_arn: str,
    instruction: str | None = None,
    description: str | None = None,
    orchestration_type: OrchestrationType | None = None,
    custom_orchestration: CustomOrchestration | None = None,
    idle_session_ttl_in_seconds: int | None = None,
    customer_encryption_key_arn: str | None = None,
    prompt_override_configuration: PromptOverrideConfiguration | None = None,
    guardrail_configuration: GuardrailConfiguration | None = None,
    memory_configuration: MemoryConfiguration | None = None,
    agent_collaboration: AgentCollaboration | None = None,
) -> UpdateAgentOutput: ...

update_agent_action_group

async def update_agent_action_group(
    *,
    agent_id: str,
    agent_version: str,
    action_group_id: str,
    action_group_name: str,
    description: str | None = None,
    parent_action_group_signature: ActionGroupSignature | None = None,
    parent_action_group_signature_params: dict[str, str] | None = None,
    action_group_executor: ActionGroupExecutor | None = None,
    action_group_state: ActionGroupState | None = None,
    api_schema: APISchema | None = None,
    function_schema: FunctionSchema | None = None,
) -> UpdateAgentActionGroupOutput: ...

update_agent_alias

async def update_agent_alias(
    *,
    agent_id: str,
    agent_alias_id: str,
    agent_alias_name: str,
    description: str | None = None,
    routing_configuration: Sequence[AgentAliasRoutingConfigurationListItem] | None = None,
    alias_invocation_state: AliasInvocationState | None = None,
) -> UpdateAgentAliasOutput: ...

update_agent_collaborator

async def update_agent_collaborator(
    *,
    agent_id: str,
    agent_version: str,
    collaborator_id: str,
    agent_descriptor: AgentDescriptor,
    collaborator_name: str,
    collaboration_instruction: str,
    relay_conversation_history: RelayConversationHistory | None = None,
) -> UpdateAgentCollaboratorOutput: ...

update_agent_knowledge_base

async def update_agent_knowledge_base(
    *,
    agent_id: str,
    agent_version: str,
    knowledge_base_id: str,
    description: str | None = None,
    knowledge_base_state: KnowledgeBaseState | None = None,
) -> UpdateAgentKnowledgeBaseOutput: ...

update_data_source

async def update_data_source(
    *,
    knowledge_base_id: str,
    data_source_id: str,
    name: str,
    data_source_configuration: DataSourceConfiguration,
    description: str | None = None,
    data_deletion_policy: DataDeletionPolicy | None = None,
    server_side_encryption_configuration: ServerSideEncryptionConfiguration | None = None,
    vector_ingestion_configuration: VectorIngestionConfiguration | None = None,
) -> UpdateDataSourceOutput: ...

update_flow

async def update_flow(
    *,
    name: str,
    execution_role_arn: str,
    flow_identifier: str,
    description: str | None = None,
    customer_encryption_key_arn: str | None = None,
    definition: FlowDefinition | None = None,
) -> UpdateFlowOutput: ...

update_flow_alias

async def update_flow_alias(
    *,
    name: str,
    routing_configuration: Sequence[FlowAliasRoutingConfigurationListItem],
    flow_identifier: str,
    alias_identifier: str,
    description: str | None = None,
    concurrency_configuration: FlowAliasConcurrencyConfiguration | None = None,
) -> UpdateFlowAliasOutput: ...

update_knowledge_base

async def update_knowledge_base(
    *,
    knowledge_base_id: str,
    name: str,
    role_arn: str,
    knowledge_base_configuration: KnowledgeBaseConfiguration,
    description: str | None = None,
    storage_configuration: StorageConfiguration | None = None,
) -> UpdateKnowledgeBaseOutput: ...

update_prompt

async def update_prompt(
    *,
    name: str,
    prompt_identifier: str,
    description: str | None = None,
    customer_encryption_key_arn: str | None = None,
    default_variant: str | None = None,
    variants: Sequence[PromptVariant] | None = None,
) -> UpdatePromptOutput: ...

update_retrieval_instruction

async def update_retrieval_instruction(
    *,
    retrieval_instruction_id: str,
    instruction: RetrievalInstructionContent,
    description: str | None = None,
) -> UpdateRetrievalInstructionOutput: ...

validate_flow_definition

async def validate_flow_definition(
    *,
    definition: FlowDefinition,
) -> ValidateFlowDefinitionOutput: ...

Links

• Service guide
• Repository
• Issues
• Releases

Licensed under Apache-2.0.