AgentsforBedrockClient

Index > AgentsforBedrock > AgentsforBedrockClient

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

AgentsforBedrockClient

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

# AgentsforBedrockClient usage example

from boto3.session import Session
from mypy_boto3_bedrock_agent.client import AgentsforBedrockClient

def get_bedrock-agent_client() -> AgentsforBedrockClient:
    return Session().client("bedrock-agent")

Exceptions

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

# Exceptions.exceptions usage example

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

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)

# Exceptions.exceptions type checking example

from mypy_boto3_bedrock_agent.client import Exceptions

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

Methods

associate_agent_knowledge_base

Associates a knowledge base with an agent.

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

# associate_agent_knowledge_base method definition

def associate_agent_knowledge_base(
    self,
    *,
    agentId: str,
    agentVersion: str,
    description: str,
    knowledgeBaseId: 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": ...,
    "description": ...,
    "knowledgeBaseId": ...,
}

parent.associate_agent_knowledge_base(**kwargs)

1. See AssociateAgentKnowledgeBaseRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

# close method definition

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

create_agent

Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.

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

# create_agent method definition

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

1. See PromptOverrideConfigurationTypeDef PromptOverrideConfigurationOutputTypeDef
2. See CreateAgentResponseTypeDef

# create_agent method usage example with argument unpacking

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

parent.create_agent(**kwargs)

1. See CreateAgentRequestRequestTypeDef

create_agent_action_group

Creates an action group for an agent.

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

# create_agent_action_group method definition

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

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

# create_agent_action_group method usage example with argument unpacking

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

parent.create_agent_action_group(**kwargs)

1. See CreateAgentActionGroupRequestRequestTypeDef

create_agent_alias

Creates an alias of an agent that can be used to deploy the agent.

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

# create_agent_alias method definition

def create_agent_alias(
    self,
    *,
    agentAliasName: str,
    agentId: 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)
    "agentAliasName": ...,
    "agentId": ...,
}

parent.create_agent_alias(**kwargs)

1. See CreateAgentAliasRequestRequestTypeDef

create_data_source

Sets up a data source to be added to a knowledge base.

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

# create_data_source method definition

def create_data_source(
    self,
    *,
    dataSourceConfiguration: Union[DataSourceConfigurationTypeDef, DataSourceConfigurationOutputTypeDef],  # (1)
    knowledgeBaseId: str,
    name: str,
    clientToken: str = ...,
    dataDeletionPolicy: DataDeletionPolicyType = ...,  # (2)
    description: str = ...,
    serverSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef = ...,  # (3)
    vectorIngestionConfiguration: VectorIngestionConfigurationTypeDef = ...,  # (4)
) -> CreateDataSourceResponseTypeDef:  # (5)
    ...

1. See DataSourceConfigurationTypeDef DataSourceConfigurationOutputTypeDef
2. See DataDeletionPolicyType
3. See ServerSideEncryptionConfigurationTypeDef
4. See VectorIngestionConfigurationTypeDef
5. See CreateDataSourceResponseTypeDef

# create_data_source method usage example with argument unpacking

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

parent.create_data_source(**kwargs)

1. See CreateDataSourceRequestRequestTypeDef

create_knowledge_base

Creates a knowledge base that contains data sources from which information can be queried and used by LLMs.

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

# create_knowledge_base method definition

def create_knowledge_base(
    self,
    *,
    knowledgeBaseConfiguration: KnowledgeBaseConfigurationTypeDef,  # (1)
    name: str,
    roleArn: str,
    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)
    "knowledgeBaseConfiguration": ...,
    "name": ...,
    "roleArn": ...,
    "storageConfiguration": ...,
}

parent.create_knowledge_base(**kwargs)

1. See CreateKnowledgeBaseRequestRequestTypeDef

delete_agent

Deletes an agent.

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

# delete_agent method definition

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 in an agent.

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

# delete_agent_action_group method definition

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

# delete_agent_action_group method usage example with argument unpacking

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

parent.delete_agent_action_group(**kwargs)

1. See DeleteAgentActionGroupRequestRequestTypeDef

delete_agent_alias

Deletes an alias of an agent.

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

# delete_agent_alias method definition

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

1. See DeleteAgentAliasResponseTypeDef

# delete_agent_alias method usage example with argument unpacking

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

parent.delete_agent_alias(**kwargs)

1. See DeleteAgentAliasRequestRequestTypeDef

delete_agent_version

Deletes a version of an agent.

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

# delete_agent_version method definition

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

Deletes a data source from a knowledge base.

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

# delete_data_source method definition

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

1. See DeleteDataSourceResponseTypeDef

# delete_data_source method usage example with argument unpacking

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

parent.delete_data_source(**kwargs)

1. See DeleteDataSourceRequestRequestTypeDef

delete_knowledge_base

Deletes a knowledge base.

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

# delete_knowledge_base method definition

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

Disassociates a knowledge base from an agent.

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

# disassociate_agent_knowledge_base method definition

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 boto3.client("bedrock-agent").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_agent

Gets information about an agent.

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

# get_agent method definition

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 information about an action group for an agent.

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

# get_agent_action_group method definition

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

1. See GetAgentActionGroupResponseTypeDef

# get_agent_action_group method usage example with argument unpacking

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

parent.get_agent_action_group(**kwargs)

1. See GetAgentActionGroupRequestRequestTypeDef

get_agent_alias

Gets information about an alias of an agent.

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

# get_agent_alias method definition

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

1. See GetAgentAliasResponseTypeDef

# get_agent_alias method usage example with argument unpacking

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

parent.get_agent_alias(**kwargs)

1. See GetAgentAliasRequestRequestTypeDef

get_agent_knowledge_base

Gets information about a knowledge base associated with an agent.

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

# get_agent_knowledge_base method definition

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 details about a version of an agent.

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

# get_agent_version method definition

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

Gets information about a data source.

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

# get_data_source method definition

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

1. See GetDataSourceResponseTypeDef

# get_data_source method usage example with argument unpacking

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

parent.get_data_source(**kwargs)

1. See GetDataSourceRequestRequestTypeDef

get_ingestion_job

Gets information about a ingestion job, in which a data source is added to a knowledge base.

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

# get_ingestion_job method definition

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

1. See GetIngestionJobResponseTypeDef

# get_ingestion_job method usage example with argument unpacking

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

parent.get_ingestion_job(**kwargs)

1. See GetIngestionJobRequestRequestTypeDef

get_knowledge_base

Gets information about a knoweldge base.

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

# get_knowledge_base method definition

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 the action groups for an agent and information about each one.

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

# list_agent_action_groups method definition

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 the aliases of an agent and information about each one.

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

# list_agent_aliases method definition

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

Lists knowledge bases associated with an agent and information about each one.

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

# list_agent_knowledge_bases method definition

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 the versions of an agent and information about each version.

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

# list_agent_versions method definition

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 the agents belonging to an account and information about each agent.

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

# list_agents method definition

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

Lists the data sources in a knowledge base and information about each one.

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

# list_data_sources method definition

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

Lists the ingestion jobs for a data source and information about each of them.

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

# list_ingestion_jobs method definition

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

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

# list_ingestion_jobs method usage example with argument unpacking

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

parent.list_ingestion_jobs(**kwargs)

1. See ListIngestionJobsRequestRequestTypeDef

list_knowledge_bases

Lists the knowledge bases in an account and information about each of them.

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

# list_knowledge_bases method definition

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 all the tags for the resource you specify.

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

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

prepare_agent

Creates a DRAFT version of the agent that can be used for internal testing.

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

# prepare_agent method definition

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

Begins an ingestion job, in which a data source is added to a knowledge base.

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

# start_ingestion_job method definition

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

1. See StartIngestionJobResponseTypeDef

# start_ingestion_job method usage example with argument unpacking

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

parent.start_ingestion_job(**kwargs)

1. See StartIngestionJobRequestRequestTypeDef

tag_resource

Associate tags with a resource.

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Remove tags from a resource.

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

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_agent

Updates the configuration of an agent.

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

# update_agent method definition

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

1. See PromptOverrideConfigurationTypeDef PromptOverrideConfigurationOutputTypeDef
2. See UpdateAgentResponseTypeDef

# update_agent method usage example with argument unpacking

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

parent.update_agent(**kwargs)

1. See UpdateAgentRequestRequestTypeDef

update_agent_action_group

Updates the configuration for an action group for an agent.

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

# update_agent_action_group method definition

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

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

# update_agent_action_group method usage example with argument unpacking

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

parent.update_agent_action_group(**kwargs)

1. See UpdateAgentActionGroupRequestRequestTypeDef

update_agent_alias

Updates configurations for an alias of an agent.

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

# update_agent_alias method definition

def update_agent_alias(
    self,
    *,
    agentAliasId: str,
    agentAliasName: str,
    agentId: 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)
    "agentAliasId": ...,
    "agentAliasName": ...,
    "agentId": ...,
}

parent.update_agent_alias(**kwargs)

1. See UpdateAgentAliasRequestRequestTypeDef

update_agent_knowledge_base

Updates the configuration for a knowledge base that has been associated with an agent.

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

# update_agent_knowledge_base method definition

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

Updates configurations for a data source.

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

# update_data_source method definition

def update_data_source(
    self,
    *,
    dataSourceConfiguration: Union[DataSourceConfigurationTypeDef, DataSourceConfigurationOutputTypeDef],  # (1)
    dataSourceId: str,
    knowledgeBaseId: str,
    name: str,
    dataDeletionPolicy: DataDeletionPolicyType = ...,  # (2)
    description: str = ...,
    serverSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef = ...,  # (3)
    vectorIngestionConfiguration: VectorIngestionConfigurationTypeDef = ...,  # (4)
) -> UpdateDataSourceResponseTypeDef:  # (5)
    ...

1. See DataSourceConfigurationTypeDef DataSourceConfigurationOutputTypeDef
2. See DataDeletionPolicyType
3. See ServerSideEncryptionConfigurationTypeDef
4. See VectorIngestionConfigurationTypeDef
5. See UpdateDataSourceResponseTypeDef

# update_data_source method usage example with argument unpacking

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

parent.update_data_source(**kwargs)

1. See UpdateDataSourceRequestRequestTypeDef

update_knowledge_base

Updates the configuration of a knowledge base with the fields that you specify.

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

# update_knowledge_base method definition

def update_knowledge_base(
    self,
    *,
    knowledgeBaseConfiguration: KnowledgeBaseConfigurationTypeDef,  # (1)
    knowledgeBaseId: str,
    name: str,
    roleArn: str,
    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)
    "knowledgeBaseConfiguration": ...,
    "knowledgeBaseId": ...,
    "name": ...,
    "roleArn": ...,
    "storageConfiguration": ...,
}

parent.update_knowledge_base(**kwargs)

1. See UpdateKnowledgeBaseRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.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