AgentsforBedrockClient

Index > AgentsforBedrock > AgentsforBedrockClient

Auto-generated documentation for AgentsforBedrock type annotations stubs module types-aiobotocore-bedrock-agent.

AgentsforBedrockClient

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

# AgentsforBedrockClient usage example

from aioboto3.session import Session
from types_aiobotocore_bedrock_agent.client import AgentsforBedrockClient

session = Session()
async with session.client("bedrock-agent") as client:
    client: AgentsforBedrockClient

Exceptions

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

# AgentsforBedrockClient.exceptions usage example

async with session.client("bedrock-agent") as client:
    try:
        do_something(client)
    except (
            client.exceptions.AccessDeniedException,
        client.exceptions.ClientError,
        client.exceptions.ConflictException,
        client.exceptions.InternalServerException,
        client.exceptions.ResourceNotFoundException,
        client.exceptions.ServiceQuotaExceededException,
        client.exceptions.ThrottlingException,
        client.exceptions.ValidationException,
    ) as e:
        print(e)

# AgentsforBedrockClient.exceptions type checking example

from types_aiobotocore_bedrock_agent.client import Exceptions

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

Methods

associate_agent_knowledge_base

Associate a Knowledge Base to an existing Amazon Bedrock Agent See also: AWS API Documentation.

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

# associate_agent_knowledge_base method definition

await def associate_agent_knowledge_base(
    self,
    *,
    agentId: str,
    agentVersion: str,
    knowledgeBaseId: str,
    description: str,
    knowledgeBaseState: KnowledgeBaseStateType = ...,  # (1)
) -> AssociateAgentKnowledgeBaseResponseTypeDef:  # (2)
    ...

1. See KnowledgeBaseStateType
2. See AssociateAgentKnowledgeBaseResponseTypeDef

# associate_agent_knowledge_base method usage example with argument unpacking

kwargs: AssociateAgentKnowledgeBaseRequestRequestTypeDef = {  # (1)
    "agentId": ...,
    "agentVersion": ...,
    "knowledgeBaseId": ...,
    "description": ...,
}

parent.associate_agent_knowledge_base(**kwargs)

1. See AssociateAgentKnowledgeBaseRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

# close method definition

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

create_agent

Creates an Amazon Bedrock Agent See also: AWS API Documentation.

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

# create_agent method definition

await def create_agent(
    self,
    *,
    agentName: str,
    agentResourceRoleArn: str,
    clientToken: str = ...,
    instruction: str = ...,
    foundationModel: str = ...,
    description: str = ...,
    idleSessionTTLInSeconds: int = ...,
    customerEncryptionKeyArn: str = ...,
    tags: Mapping[str, str] = ...,
    promptOverrideConfiguration: PromptOverrideConfigurationTypeDef = ...,  # (1)
) -> CreateAgentResponseTypeDef:  # (2)
    ...

1. See PromptOverrideConfigurationTypeDef
2. See CreateAgentResponseTypeDef

# create_agent method usage example with argument unpacking

kwargs: CreateAgentRequestRequestTypeDef = {  # (1)
    "agentName": ...,
    "agentResourceRoleArn": ...,
}

parent.create_agent(**kwargs)

1. See CreateAgentRequestRequestTypeDef

create_agent_action_group

Creates an Action Group for existing Amazon Bedrock Agent See also: AWS API Documentation.

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

# create_agent_action_group method definition

await def create_agent_action_group(
    self,
    *,
    agentId: str,
    agentVersion: str,
    actionGroupName: str,
    clientToken: str = ...,
    description: str = ...,
    parentActionGroupSignature: ActionGroupSignatureType = ...,  # (1)
    actionGroupExecutor: ActionGroupExecutorTypeDef = ...,  # (2)
    apiSchema: APISchemaTypeDef = ...,  # (3)
    actionGroupState: ActionGroupStateType = ...,  # (4)
) -> CreateAgentActionGroupResponseTypeDef:  # (5)
    ...

1. See ActionGroupSignatureType
2. See ActionGroupExecutorTypeDef
3. See APISchemaTypeDef
4. See ActionGroupStateType
5. See CreateAgentActionGroupResponseTypeDef

# create_agent_action_group method usage example with argument unpacking

kwargs: CreateAgentActionGroupRequestRequestTypeDef = {  # (1)
    "agentId": ...,
    "agentVersion": ...,
    "actionGroupName": ...,
}

parent.create_agent_action_group(**kwargs)

1. See CreateAgentActionGroupRequestRequestTypeDef

create_agent_alias

Creates an Alias for an existing Amazon Bedrock Agent See also: AWS API Documentation.

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

# create_agent_alias method definition

await def create_agent_alias(
    self,
    *,
    agentId: str,
    agentAliasName: str,
    clientToken: str = ...,
    description: str = ...,
    routingConfiguration: Sequence[AgentAliasRoutingConfigurationListItemTypeDef] = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateAgentAliasResponseTypeDef:  # (2)
    ...

1. See AgentAliasRoutingConfigurationListItemTypeDef
2. See CreateAgentAliasResponseTypeDef

# create_agent_alias method usage example with argument unpacking

kwargs: CreateAgentAliasRequestRequestTypeDef = {  # (1)
    "agentId": ...,
    "agentAliasName": ...,
}

parent.create_agent_alias(**kwargs)

1. See CreateAgentAliasRequestRequestTypeDef

create_data_source

Create a new data source See also: AWS API Documentation.

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

# create_data_source method definition

await def create_data_source(
    self,
    *,
    knowledgeBaseId: str,
    name: str,
    dataSourceConfiguration: DataSourceConfigurationTypeDef,  # (1)
    clientToken: str = ...,
    description: str = ...,
    serverSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef = ...,  # (2)
    vectorIngestionConfiguration: VectorIngestionConfigurationTypeDef = ...,  # (3)
) -> CreateDataSourceResponseTypeDef:  # (4)
    ...

1. See DataSourceConfigurationTypeDef
2. See ServerSideEncryptionConfigurationTypeDef
3. See VectorIngestionConfigurationTypeDef
4. See CreateDataSourceResponseTypeDef

# create_data_source method usage example with argument unpacking

kwargs: CreateDataSourceRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "name": ...,
    "dataSourceConfiguration": ...,
}

parent.create_data_source(**kwargs)

1. See CreateDataSourceRequestRequestTypeDef

create_knowledge_base

Create a new knowledge base See also: AWS API Documentation.

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

# create_knowledge_base method definition

await def create_knowledge_base(
    self,
    *,
    name: str,
    roleArn: str,
    knowledgeBaseConfiguration: KnowledgeBaseConfigurationTypeDef,  # (1)
    storageConfiguration: StorageConfigurationTypeDef,  # (2)
    clientToken: str = ...,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateKnowledgeBaseResponseTypeDef:  # (3)
    ...

1. See KnowledgeBaseConfigurationTypeDef
2. See StorageConfigurationTypeDef
3. See CreateKnowledgeBaseResponseTypeDef

# create_knowledge_base method usage example with argument unpacking

kwargs: CreateKnowledgeBaseRequestRequestTypeDef = {  # (1)
    "name": ...,
    "roleArn": ...,
    "knowledgeBaseConfiguration": ...,
    "storageConfiguration": ...,
}

parent.create_knowledge_base(**kwargs)

1. See CreateKnowledgeBaseRequestRequestTypeDef

delete_agent

Deletes an Agent for existing Amazon Bedrock Agent See also: AWS API Documentation.

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

# delete_agent method definition

await def delete_agent(
    self,
    *,
    agentId: str,
    skipResourceInUseCheck: bool = ...,
) -> DeleteAgentResponseTypeDef:  # (1)
    ...

1. See DeleteAgentResponseTypeDef

# delete_agent method usage example with argument unpacking

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

parent.delete_agent(**kwargs)

1. See DeleteAgentRequestRequestTypeDef

delete_agent_action_group

Deletes an Action Group for existing Amazon Bedrock Agent.

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

# delete_agent_action_group method definition

await def delete_agent_action_group(
    self,
    *,
    agentId: str,
    agentVersion: str,
    actionGroupId: str,
    skipResourceInUseCheck: bool = ...,
) -> Dict[str, Any]:
    ...

# delete_agent_action_group method usage example with argument unpacking

kwargs: DeleteAgentActionGroupRequestRequestTypeDef = {  # (1)
    "agentId": ...,
    "agentVersion": ...,
    "actionGroupId": ...,
}

parent.delete_agent_action_group(**kwargs)

1. See DeleteAgentActionGroupRequestRequestTypeDef

delete_agent_alias

Deletes an Alias for a Amazon Bedrock Agent See also: AWS API Documentation.

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

# delete_agent_alias method definition

await def delete_agent_alias(
    self,
    *,
    agentId: str,
    agentAliasId: str,
) -> DeleteAgentAliasResponseTypeDef:  # (1)
    ...

1. See DeleteAgentAliasResponseTypeDef

# delete_agent_alias method usage example with argument unpacking

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

parent.delete_agent_alias(**kwargs)

1. See DeleteAgentAliasRequestRequestTypeDef

delete_agent_version

Deletes an Agent version for existing Amazon Bedrock Agent See also: AWS API Documentation.

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

# delete_agent_version method definition

await def delete_agent_version(
    self,
    *,
    agentId: str,
    agentVersion: str,
    skipResourceInUseCheck: bool = ...,
) -> DeleteAgentVersionResponseTypeDef:  # (1)
    ...

1. See DeleteAgentVersionResponseTypeDef

# delete_agent_version method usage example with argument unpacking

kwargs: DeleteAgentVersionRequestRequestTypeDef = {  # (1)
    "agentId": ...,
    "agentVersion": ...,
}

parent.delete_agent_version(**kwargs)

1. See DeleteAgentVersionRequestRequestTypeDef

delete_data_source

Delete an existing data source See also: AWS API Documentation.

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

# delete_data_source method definition

await def delete_data_source(
    self,
    *,
    knowledgeBaseId: str,
    dataSourceId: str,
) -> DeleteDataSourceResponseTypeDef:  # (1)
    ...

1. See DeleteDataSourceResponseTypeDef

# delete_data_source method usage example with argument unpacking

kwargs: DeleteDataSourceRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "dataSourceId": ...,
}

parent.delete_data_source(**kwargs)

1. See DeleteDataSourceRequestRequestTypeDef

delete_knowledge_base

Delete an existing knowledge base See also: AWS API Documentation.

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

# delete_knowledge_base method definition

await def delete_knowledge_base(
    self,
    *,
    knowledgeBaseId: str,
) -> DeleteKnowledgeBaseResponseTypeDef:  # (1)
    ...

1. See DeleteKnowledgeBaseResponseTypeDef

# delete_knowledge_base method usage example with argument unpacking

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

parent.delete_knowledge_base(**kwargs)

1. See DeleteKnowledgeBaseRequestRequestTypeDef

disassociate_agent_knowledge_base

Disassociate an existing Knowledge Base from an Amazon Bedrock Agent See also: AWS API Documentation.

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

# disassociate_agent_knowledge_base method definition

await def disassociate_agent_knowledge_base(
    self,
    *,
    agentId: str,
    agentVersion: str,
    knowledgeBaseId: str,
) -> Dict[str, Any]:
    ...

# disassociate_agent_knowledge_base method usage example with argument unpacking

kwargs: DisassociateAgentKnowledgeBaseRequestRequestTypeDef = {  # (1)
    "agentId": ...,
    "agentVersion": ...,
    "knowledgeBaseId": ...,
}

parent.disassociate_agent_knowledge_base(**kwargs)

1. See DisassociateAgentKnowledgeBaseRequestRequestTypeDef

generate_presigned_url

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

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

Gets an Agent for existing Amazon Bedrock Agent See also: AWS API Documentation.

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

# get_agent method definition

await def get_agent(
    self,
    *,
    agentId: str,
) -> GetAgentResponseTypeDef:  # (1)
    ...

1. See GetAgentResponseTypeDef

# get_agent method usage example with argument unpacking

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

parent.get_agent(**kwargs)

1. See GetAgentRequestRequestTypeDef

get_agent_action_group

Gets an Action Group for existing Amazon Bedrock Agent Version See also: AWS API Documentation.

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

# get_agent_action_group method definition

await def get_agent_action_group(
    self,
    *,
    agentId: str,
    agentVersion: str,
    actionGroupId: str,
) -> GetAgentActionGroupResponseTypeDef:  # (1)
    ...

1. See GetAgentActionGroupResponseTypeDef

# get_agent_action_group method usage example with argument unpacking

kwargs: GetAgentActionGroupRequestRequestTypeDef = {  # (1)
    "agentId": ...,
    "agentVersion": ...,
    "actionGroupId": ...,
}

parent.get_agent_action_group(**kwargs)

1. See GetAgentActionGroupRequestRequestTypeDef

get_agent_alias

Describes an Alias for a Amazon Bedrock Agent See also: AWS API Documentation.

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

# get_agent_alias method definition

await def get_agent_alias(
    self,
    *,
    agentId: str,
    agentAliasId: str,
) -> GetAgentAliasResponseTypeDef:  # (1)
    ...

1. See GetAgentAliasResponseTypeDef

# get_agent_alias method usage example with argument unpacking

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

parent.get_agent_alias(**kwargs)

1. See GetAgentAliasRequestRequestTypeDef

get_agent_knowledge_base

Gets a knowledge base associated to an existing Amazon Bedrock Agent Version See also: AWS API Documentation.

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

# get_agent_knowledge_base method definition

await def get_agent_knowledge_base(
    self,
    *,
    agentId: str,
    agentVersion: str,
    knowledgeBaseId: str,
) -> GetAgentKnowledgeBaseResponseTypeDef:  # (1)
    ...

1. See GetAgentKnowledgeBaseResponseTypeDef

# get_agent_knowledge_base method usage example with argument unpacking

kwargs: GetAgentKnowledgeBaseRequestRequestTypeDef = {  # (1)
    "agentId": ...,
    "agentVersion": ...,
    "knowledgeBaseId": ...,
}

parent.get_agent_knowledge_base(**kwargs)

1. See GetAgentKnowledgeBaseRequestRequestTypeDef

get_agent_version

Gets an Agent version for existing Amazon Bedrock Agent See also: AWS API Documentation.

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

# get_agent_version method definition

await def get_agent_version(
    self,
    *,
    agentId: str,
    agentVersion: str,
) -> GetAgentVersionResponseTypeDef:  # (1)
    ...

1. See GetAgentVersionResponseTypeDef

# get_agent_version method usage example with argument unpacking

kwargs: GetAgentVersionRequestRequestTypeDef = {  # (1)
    "agentId": ...,
    "agentVersion": ...,
}

parent.get_agent_version(**kwargs)

1. See GetAgentVersionRequestRequestTypeDef

get_data_source

Get an existing data source See also: AWS API Documentation.

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

# get_data_source method definition

await def get_data_source(
    self,
    *,
    knowledgeBaseId: str,
    dataSourceId: str,
) -> GetDataSourceResponseTypeDef:  # (1)
    ...

1. See GetDataSourceResponseTypeDef

# get_data_source method usage example with argument unpacking

kwargs: GetDataSourceRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "dataSourceId": ...,
}

parent.get_data_source(**kwargs)

1. See GetDataSourceRequestRequestTypeDef

get_ingestion_job

Get an ingestion job See also: AWS API Documentation.

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

# get_ingestion_job method definition

await def get_ingestion_job(
    self,
    *,
    knowledgeBaseId: str,
    dataSourceId: str,
    ingestionJobId: str,
) -> GetIngestionJobResponseTypeDef:  # (1)
    ...

1. See GetIngestionJobResponseTypeDef

# get_ingestion_job method usage example with argument unpacking

kwargs: GetIngestionJobRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "dataSourceId": ...,
    "ingestionJobId": ...,
}

parent.get_ingestion_job(**kwargs)

1. See GetIngestionJobRequestRequestTypeDef

get_knowledge_base

Get an existing knowledge base See also: AWS API Documentation.

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

# get_knowledge_base method definition

await def get_knowledge_base(
    self,
    *,
    knowledgeBaseId: str,
) -> GetKnowledgeBaseResponseTypeDef:  # (1)
    ...

1. See GetKnowledgeBaseResponseTypeDef

# get_knowledge_base method usage example with argument unpacking

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

parent.get_knowledge_base(**kwargs)

1. See GetKnowledgeBaseRequestRequestTypeDef

list_agent_action_groups

Lists an Action Group for existing Amazon Bedrock Agent Version See also: AWS API Documentation.

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

# list_agent_action_groups method definition

await def list_agent_action_groups(
    self,
    *,
    agentId: str,
    agentVersion: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAgentActionGroupsResponseTypeDef:  # (1)
    ...

1. See ListAgentActionGroupsResponseTypeDef

# list_agent_action_groups method usage example with argument unpacking

kwargs: ListAgentActionGroupsRequestRequestTypeDef = {  # (1)
    "agentId": ...,
    "agentVersion": ...,
}

parent.list_agent_action_groups(**kwargs)

1. See ListAgentActionGroupsRequestRequestTypeDef

list_agent_aliases

Lists all the Aliases for an Amazon Bedrock Agent See also: AWS API Documentation.

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

# list_agent_aliases method definition

await def list_agent_aliases(
    self,
    *,
    agentId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAgentAliasesResponseTypeDef:  # (1)
    ...

1. See ListAgentAliasesResponseTypeDef

# list_agent_aliases method usage example with argument unpacking

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

parent.list_agent_aliases(**kwargs)

1. See ListAgentAliasesRequestRequestTypeDef

list_agent_knowledge_bases

List of Knowledge Bases associated to an existing Amazon Bedrock Agent Version See also: AWS API Documentation.

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

# list_agent_knowledge_bases method definition

await def list_agent_knowledge_bases(
    self,
    *,
    agentId: str,
    agentVersion: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAgentKnowledgeBasesResponseTypeDef:  # (1)
    ...

1. See ListAgentKnowledgeBasesResponseTypeDef

# list_agent_knowledge_bases method usage example with argument unpacking

kwargs: ListAgentKnowledgeBasesRequestRequestTypeDef = {  # (1)
    "agentId": ...,
    "agentVersion": ...,
}

parent.list_agent_knowledge_bases(**kwargs)

1. See ListAgentKnowledgeBasesRequestRequestTypeDef

list_agent_versions

Lists Agent Versions See also: AWS API Documentation.

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

# list_agent_versions method definition

await def list_agent_versions(
    self,
    *,
    agentId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAgentVersionsResponseTypeDef:  # (1)
    ...

1. See ListAgentVersionsResponseTypeDef

# list_agent_versions method usage example with argument unpacking

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

parent.list_agent_versions(**kwargs)

1. See ListAgentVersionsRequestRequestTypeDef

list_agents

Lists Agents See also: AWS API Documentation.

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

# list_agents method definition

await def list_agents(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAgentsResponseTypeDef:  # (1)
    ...

1. See ListAgentsResponseTypeDef

# list_agents method usage example with argument unpacking

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

parent.list_agents(**kwargs)

1. See ListAgentsRequestRequestTypeDef

list_data_sources

List data sources See also: AWS API Documentation.

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

# list_data_sources method definition

await def list_data_sources(
    self,
    *,
    knowledgeBaseId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDataSourcesResponseTypeDef:  # (1)
    ...

1. See ListDataSourcesResponseTypeDef

# list_data_sources method usage example with argument unpacking

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

parent.list_data_sources(**kwargs)

1. See ListDataSourcesRequestRequestTypeDef

list_ingestion_jobs

List ingestion jobs See also: AWS API Documentation.

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

# list_ingestion_jobs method definition

await def list_ingestion_jobs(
    self,
    *,
    knowledgeBaseId: str,
    dataSourceId: str,
    filters: Sequence[IngestionJobFilterTypeDef] = ...,  # (1)
    sortBy: IngestionJobSortByTypeDef = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListIngestionJobsResponseTypeDef:  # (3)
    ...

1. See IngestionJobFilterTypeDef
2. See IngestionJobSortByTypeDef
3. See ListIngestionJobsResponseTypeDef

# list_ingestion_jobs method usage example with argument unpacking

kwargs: ListIngestionJobsRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "dataSourceId": ...,
}

parent.list_ingestion_jobs(**kwargs)

1. See ListIngestionJobsRequestRequestTypeDef

list_knowledge_bases

List Knowledge Bases See also: AWS API Documentation.

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

# list_knowledge_bases method definition

await def list_knowledge_bases(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListKnowledgeBasesResponseTypeDef:  # (1)
    ...

1. See ListKnowledgeBasesResponseTypeDef

# list_knowledge_bases method usage example with argument unpacking

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

parent.list_knowledge_bases(**kwargs)

1. See ListKnowledgeBasesRequestRequestTypeDef

list_tags_for_resource

List tags for a resource See also: AWS API Documentation.

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

# list_tags_for_resource method definition

await def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

prepare_agent

Prepares an existing Amazon Bedrock Agent to receive runtime requests See also: AWS API Documentation.

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

# prepare_agent method definition

await def prepare_agent(
    self,
    *,
    agentId: str,
) -> PrepareAgentResponseTypeDef:  # (1)
    ...

1. See PrepareAgentResponseTypeDef

# prepare_agent method usage example with argument unpacking

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

parent.prepare_agent(**kwargs)

1. See PrepareAgentRequestRequestTypeDef

start_ingestion_job

Start a new ingestion job See also: AWS API Documentation.

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

# start_ingestion_job method definition

await def start_ingestion_job(
    self,
    *,
    knowledgeBaseId: str,
    dataSourceId: str,
    clientToken: str = ...,
    description: str = ...,
) -> StartIngestionJobResponseTypeDef:  # (1)
    ...

1. See StartIngestionJobResponseTypeDef

# start_ingestion_job method usage example with argument unpacking

kwargs: StartIngestionJobRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "dataSourceId": ...,
}

parent.start_ingestion_job(**kwargs)

1. See StartIngestionJobRequestRequestTypeDef

tag_resource

Tag a resource See also: AWS API Documentation.

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

# tag_resource method definition

await def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Untag a resource See also: AWS API Documentation.

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

# untag_resource method definition

await def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_agent

Updates an existing Amazon Bedrock Agent See also: AWS API Documentation.

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

# update_agent method definition

await def update_agent(
    self,
    *,
    agentId: str,
    agentName: str,
    agentResourceRoleArn: str,
    instruction: str = ...,
    foundationModel: str = ...,
    description: str = ...,
    idleSessionTTLInSeconds: int = ...,
    customerEncryptionKeyArn: str = ...,
    promptOverrideConfiguration: PromptOverrideConfigurationTypeDef = ...,  # (1)
) -> UpdateAgentResponseTypeDef:  # (2)
    ...

1. See PromptOverrideConfigurationTypeDef
2. See UpdateAgentResponseTypeDef

# update_agent method usage example with argument unpacking

kwargs: UpdateAgentRequestRequestTypeDef = {  # (1)
    "agentId": ...,
    "agentName": ...,
    "agentResourceRoleArn": ...,
}

parent.update_agent(**kwargs)

1. See UpdateAgentRequestRequestTypeDef

update_agent_action_group

Updates an existing Action Group for Amazon Bedrock Agent See also: AWS API Documentation.

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

# update_agent_action_group method definition

await def update_agent_action_group(
    self,
    *,
    agentId: str,
    agentVersion: str,
    actionGroupId: str,
    actionGroupName: str,
    description: str = ...,
    parentActionGroupSignature: ActionGroupSignatureType = ...,  # (1)
    actionGroupExecutor: ActionGroupExecutorTypeDef = ...,  # (2)
    actionGroupState: ActionGroupStateType = ...,  # (3)
    apiSchema: APISchemaTypeDef = ...,  # (4)
) -> UpdateAgentActionGroupResponseTypeDef:  # (5)
    ...

1. See ActionGroupSignatureType
2. See ActionGroupExecutorTypeDef
3. See ActionGroupStateType
4. See APISchemaTypeDef
5. See UpdateAgentActionGroupResponseTypeDef

# update_agent_action_group method usage example with argument unpacking

kwargs: UpdateAgentActionGroupRequestRequestTypeDef = {  # (1)
    "agentId": ...,
    "agentVersion": ...,
    "actionGroupId": ...,
    "actionGroupName": ...,
}

parent.update_agent_action_group(**kwargs)

1. See UpdateAgentActionGroupRequestRequestTypeDef

update_agent_alias

Updates an existing Alias for an Amazon Bedrock Agent See also: AWS API Documentation.

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

# update_agent_alias method definition

await def update_agent_alias(
    self,
    *,
    agentId: str,
    agentAliasId: str,
    agentAliasName: str,
    description: str = ...,
    routingConfiguration: Sequence[AgentAliasRoutingConfigurationListItemTypeDef] = ...,  # (1)
) -> UpdateAgentAliasResponseTypeDef:  # (2)
    ...

1. See AgentAliasRoutingConfigurationListItemTypeDef
2. See UpdateAgentAliasResponseTypeDef

# update_agent_alias method usage example with argument unpacking

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

parent.update_agent_alias(**kwargs)

1. See UpdateAgentAliasRequestRequestTypeDef

update_agent_knowledge_base

Updates an existing Knowledge Base associated to an Amazon Bedrock Agent See also: AWS API Documentation.

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

# update_agent_knowledge_base method definition

await def update_agent_knowledge_base(
    self,
    *,
    agentId: str,
    agentVersion: str,
    knowledgeBaseId: str,
    description: str = ...,
    knowledgeBaseState: KnowledgeBaseStateType = ...,  # (1)
) -> UpdateAgentKnowledgeBaseResponseTypeDef:  # (2)
    ...

1. See KnowledgeBaseStateType
2. See UpdateAgentKnowledgeBaseResponseTypeDef

# update_agent_knowledge_base method usage example with argument unpacking

kwargs: UpdateAgentKnowledgeBaseRequestRequestTypeDef = {  # (1)
    "agentId": ...,
    "agentVersion": ...,
    "knowledgeBaseId": ...,
}

parent.update_agent_knowledge_base(**kwargs)

1. See UpdateAgentKnowledgeBaseRequestRequestTypeDef

update_data_source

Update an existing data source See also: AWS API Documentation.

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

# update_data_source method definition

await def update_data_source(
    self,
    *,
    knowledgeBaseId: str,
    dataSourceId: str,
    name: str,
    dataSourceConfiguration: DataSourceConfigurationTypeDef,  # (1)
    description: str = ...,
    serverSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef = ...,  # (2)
    vectorIngestionConfiguration: VectorIngestionConfigurationTypeDef = ...,  # (3)
) -> UpdateDataSourceResponseTypeDef:  # (4)
    ...

1. See DataSourceConfigurationTypeDef
2. See ServerSideEncryptionConfigurationTypeDef
3. See VectorIngestionConfigurationTypeDef
4. See UpdateDataSourceResponseTypeDef

# update_data_source method usage example with argument unpacking

kwargs: UpdateDataSourceRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "dataSourceId": ...,
    "name": ...,
    "dataSourceConfiguration": ...,
}

parent.update_data_source(**kwargs)

1. See UpdateDataSourceRequestRequestTypeDef

update_knowledge_base

Update an existing knowledge base See also: AWS API Documentation.

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

# update_knowledge_base method definition

await def update_knowledge_base(
    self,
    *,
    knowledgeBaseId: str,
    name: str,
    roleArn: str,
    knowledgeBaseConfiguration: KnowledgeBaseConfigurationTypeDef,  # (1)
    storageConfiguration: StorageConfigurationTypeDef,  # (2)
    description: str = ...,
) -> UpdateKnowledgeBaseResponseTypeDef:  # (3)
    ...

1. See KnowledgeBaseConfigurationTypeDef
2. See StorageConfigurationTypeDef
3. See UpdateKnowledgeBaseResponseTypeDef

# update_knowledge_base method usage example with argument unpacking

kwargs: UpdateKnowledgeBaseRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "name": ...,
    "roleArn": ...,
    "knowledgeBaseConfiguration": ...,
    "storageConfiguration": ...,
}

parent.update_knowledge_base(**kwargs)

1. See UpdateKnowledgeBaseRequestRequestTypeDef

__aenter__

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

# __aenter__ method definition

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

__aexit__

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

# __aexit__ method definition

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

get_paginator

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

• client.get_paginator("list_agent_action_groups") -> ListAgentActionGroupsPaginator
• client.get_paginator("list_agent_aliases") -> ListAgentAliasesPaginator
• client.get_paginator("list_agent_knowledge_bases") -> ListAgentKnowledgeBasesPaginator
• client.get_paginator("list_agent_versions") -> ListAgentVersionsPaginator
• client.get_paginator("list_agents") -> ListAgentsPaginator
• client.get_paginator("list_data_sources") -> ListDataSourcesPaginator
• client.get_paginator("list_ingestion_jobs") -> ListIngestionJobsPaginator
• client.get_paginator("list_knowledge_bases") -> ListKnowledgeBasesPaginator