Struct aws_sdk_bedrockagent::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Agents for Amazon Bedrock
Client for invoking operations on Agents for Amazon Bedrock. Each operation on Agents for Amazon Bedrock is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_bedrockagent::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_bedrockagent::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
Implementations§
source§impl Client
impl Client
sourcepub fn associate_agent_knowledge_base(
&self
) -> AssociateAgentKnowledgeBaseFluentBuilder
pub fn associate_agent_knowledge_base( &self ) -> AssociateAgentKnowledgeBaseFluentBuilder
Constructs a fluent builder for the AssociateAgentKnowledgeBase
operation.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent with which you want to associate the knowledge base.
agent_version(impl Into<String>)
/set_agent_version(Option<String>)
:
required: trueThe version of the agent with which you want to associate the knowledge base.
knowledge_base_id(impl Into<String>)
/set_knowledge_base_id(Option<String>)
:
required: trueThe unique identifier of the knowledge base to associate with the agent.
description(impl Into<String>)
/set_description(Option<String>)
:
required: trueA description of what the agent should use the knowledge base for.
knowledge_base_state(KnowledgeBaseState)
/set_knowledge_base_state(Option<KnowledgeBaseState>)
:
required: falseSpecifies whether to use the knowledge base or not when sending an InvokeAgent request.
- On success, responds with
AssociateAgentKnowledgeBaseOutput
with field(s):agent_knowledge_base(Option<AgentKnowledgeBase>)
:Contains details about the knowledge base that has been associated with the agent.
- On failure, responds with
SdkError<AssociateAgentKnowledgeBaseError>
source§impl Client
impl Client
sourcepub fn create_agent(&self) -> CreateAgentFluentBuilder
pub fn create_agent(&self) -> CreateAgentFluentBuilder
Constructs a fluent builder for the CreateAgent
operation.
- The fluent builder is configurable:
agent_name(impl Into<String>)
/set_agent_name(Option<String>)
:
required: trueA name for the agent that you create.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
instruction(impl Into<String>)
/set_instruction(Option<String>)
:
required: falseInstructions that tell the agent what it should do and how it should interact with users.
foundation_model(impl Into<String>)
/set_foundation_model(Option<String>)
:
required: falseThe foundation model to be used for orchestration by the agent you create.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the agent.
idle_session_ttl_in_seconds(i32)
/set_idle_session_ttl_in_seconds(Option<i32>)
:
required: falseThe number of seconds for which Amazon Bedrock keeps information about a user’s conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
agent_resource_role_arn(impl Into<String>)
/set_agent_resource_role_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
customer_encryption_key_arn(impl Into<String>)
/set_customer_encryption_key_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseAny tags that you want to attach to the agent.
prompt_override_configuration(PromptOverrideConfiguration)
/set_prompt_override_configuration(Option<PromptOverrideConfiguration>)
:
required: falseContains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
- On success, responds with
CreateAgentOutput
with field(s):agent(Option<Agent>)
:Contains details about the agent created.
- On failure, responds with
SdkError<CreateAgentError>
source§impl Client
impl Client
sourcepub fn create_agent_action_group(&self) -> CreateAgentActionGroupFluentBuilder
pub fn create_agent_action_group(&self) -> CreateAgentActionGroupFluentBuilder
Constructs a fluent builder for the CreateAgentActionGroup
operation.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent for which to create the action group.
agent_version(impl Into<String>)
/set_agent_version(Option<String>)
:
required: trueThe version of the agent for which to create the action group.
action_group_name(impl Into<String>)
/set_action_group_name(Option<String>)
:
required: trueThe name to give the action group.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the action group.
parent_action_group_signature(ActionGroupSignature)
/set_parent_action_group_signature(Option<ActionGroupSignature>)
:
required: falseTo allow your agent to request the user for additional information when trying to complete a task, set this field to
AMAZON.UserInput
. You must leave thedescription
,apiSchema
, andactionGroupExecutor
fields blank for this action group.During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn’t have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
action_group_executor(ActionGroupExecutor)
/set_action_group_executor(Option<ActionGroupExecutor>)
:
required: falseThe Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
api_schema(ApiSchema)
/set_api_schema(Option<ApiSchema>)
:
required: falseContains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
action_group_state(ActionGroupState)
/set_action_group_state(Option<ActionGroupState>)
:
required: falseSpecifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
function_schema(FunctionSchema)
/set_function_schema(Option<FunctionSchema>)
:
required: falseContains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
- On success, responds with
CreateAgentActionGroupOutput
with field(s):agent_action_group(Option<AgentActionGroup>)
:Contains details about the action group that was created.
- On failure, responds with
SdkError<CreateAgentActionGroupError>
source§impl Client
impl Client
sourcepub fn create_agent_alias(&self) -> CreateAgentAliasFluentBuilder
pub fn create_agent_alias(&self) -> CreateAgentAliasFluentBuilder
Constructs a fluent builder for the CreateAgentAlias
operation.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent.
agent_alias_name(impl Into<String>)
/set_agent_alias_name(Option<String>)
:
required: trueThe name of the alias.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the alias of the agent.
routing_configuration(AgentAliasRoutingConfigurationListItem)
/set_routing_configuration(Option<Vec::<AgentAliasRoutingConfigurationListItem>>)
:
required: falseContains details about the routing configuration of the alias.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseAny tags that you want to attach to the alias of the agent.
- On success, responds with
CreateAgentAliasOutput
with field(s):agent_alias(Option<AgentAlias>)
:Contains details about the alias that was created.
- On failure, responds with
SdkError<CreateAgentAliasError>
source§impl Client
impl Client
sourcepub fn create_data_source(&self) -> CreateDataSourceFluentBuilder
pub fn create_data_source(&self) -> CreateDataSourceFluentBuilder
Constructs a fluent builder for the CreateDataSource
operation.
- The fluent builder is configurable:
knowledge_base_id(impl Into<String>)
/set_knowledge_base_id(Option<String>)
:
required: trueThe unique identifier of the knowledge base to which to add the data source.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the data source.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the data source.
data_source_configuration(DataSourceConfiguration)
/set_data_source_configuration(Option<DataSourceConfiguration>)
:
required: trueContains metadata about where the data source is stored.
data_deletion_policy(DataDeletionPolicy)
/set_data_deletion_policy(Option<DataDeletionPolicy>)
:
required: falseThe data deletion policy assigned to the data source.
server_side_encryption_configuration(ServerSideEncryptionConfiguration)
/set_server_side_encryption_configuration(Option<ServerSideEncryptionConfiguration>)
:
required: falseContains details about the server-side encryption for the data source.
vector_ingestion_configuration(VectorIngestionConfiguration)
/set_vector_ingestion_configuration(Option<VectorIngestionConfiguration>)
:
required: falseContains details about how to ingest the documents in the data source.
- On success, responds with
CreateDataSourceOutput
with field(s):data_source(Option<DataSource>)
:Contains details about the data source.
- On failure, responds with
SdkError<CreateDataSourceError>
source§impl Client
impl Client
sourcepub fn create_knowledge_base(&self) -> CreateKnowledgeBaseFluentBuilder
pub fn create_knowledge_base(&self) -> CreateKnowledgeBaseFluentBuilder
Constructs a fluent builder for the CreateKnowledgeBase
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA name for the knowledge base.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the knowledge base.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
knowledge_base_configuration(KnowledgeBaseConfiguration)
/set_knowledge_base_configuration(Option<KnowledgeBaseConfiguration>)
:
required: trueContains details about the embeddings model used for the knowledge base.
storage_configuration(StorageConfiguration)
/set_storage_configuration(Option<StorageConfiguration>)
:
required: trueContains details about the configuration of the vector database used for the knowledge base.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseSpecify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
- On success, responds with
CreateKnowledgeBaseOutput
with field(s):knowledge_base(Option<KnowledgeBase>)
:Contains details about the knowledge base.
- On failure, responds with
SdkError<CreateKnowledgeBaseError>
source§impl Client
impl Client
sourcepub fn delete_agent(&self) -> DeleteAgentFluentBuilder
pub fn delete_agent(&self) -> DeleteAgentFluentBuilder
Constructs a fluent builder for the DeleteAgent
operation.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent to delete.
skip_resource_in_use_check(bool)
/set_skip_resource_in_use_check(Option<bool>)
:
required: falseBy default, this value is
false
and deletion is stopped if the resource is in use. If you set it totrue
, the resource will be deleted even if the resource is in use.
- On success, responds with
DeleteAgentOutput
with field(s):agent_id(String)
:The unique identifier of the agent that was deleted.
agent_status(AgentStatus)
:The status of the agent.
- On failure, responds with
SdkError<DeleteAgentError>
source§impl Client
impl Client
sourcepub fn delete_agent_action_group(&self) -> DeleteAgentActionGroupFluentBuilder
pub fn delete_agent_action_group(&self) -> DeleteAgentActionGroupFluentBuilder
Constructs a fluent builder for the DeleteAgentActionGroup
operation.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent that the action group belongs to.
agent_version(impl Into<String>)
/set_agent_version(Option<String>)
:
required: trueThe version of the agent that the action group belongs to.
action_group_id(impl Into<String>)
/set_action_group_id(Option<String>)
:
required: trueThe unique identifier of the action group to delete.
skip_resource_in_use_check(bool)
/set_skip_resource_in_use_check(Option<bool>)
:
required: falseBy default, this value is
false
and deletion is stopped if the resource is in use. If you set it totrue
, the resource will be deleted even if the resource is in use.
- On success, responds with
DeleteAgentActionGroupOutput
- On failure, responds with
SdkError<DeleteAgentActionGroupError>
source§impl Client
impl Client
sourcepub fn delete_agent_alias(&self) -> DeleteAgentAliasFluentBuilder
pub fn delete_agent_alias(&self) -> DeleteAgentAliasFluentBuilder
Constructs a fluent builder for the DeleteAgentAlias
operation.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent that the alias belongs to.
agent_alias_id(impl Into<String>)
/set_agent_alias_id(Option<String>)
:
required: trueThe unique identifier of the alias to delete.
- On success, responds with
DeleteAgentAliasOutput
with field(s):agent_id(String)
:The unique identifier of the agent that the alias belongs to.
agent_alias_id(String)
:The unique identifier of the alias that was deleted.
agent_alias_status(AgentAliasStatus)
:The status of the alias.
- On failure, responds with
SdkError<DeleteAgentAliasError>
source§impl Client
impl Client
sourcepub fn delete_agent_version(&self) -> DeleteAgentVersionFluentBuilder
pub fn delete_agent_version(&self) -> DeleteAgentVersionFluentBuilder
Constructs a fluent builder for the DeleteAgentVersion
operation.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent that the version belongs to.
agent_version(impl Into<String>)
/set_agent_version(Option<String>)
:
required: trueThe version of the agent to delete.
skip_resource_in_use_check(bool)
/set_skip_resource_in_use_check(Option<bool>)
:
required: falseBy default, this value is
false
and deletion is stopped if the resource is in use. If you set it totrue
, the resource will be deleted even if the resource is in use.
- On success, responds with
DeleteAgentVersionOutput
with field(s):agent_id(String)
:The unique identifier of the agent that the version belongs to.
agent_version(String)
:The version that was deleted.
agent_status(AgentStatus)
:The status of the agent version.
- On failure, responds with
SdkError<DeleteAgentVersionError>
source§impl Client
impl Client
sourcepub fn delete_data_source(&self) -> DeleteDataSourceFluentBuilder
pub fn delete_data_source(&self) -> DeleteDataSourceFluentBuilder
Constructs a fluent builder for the DeleteDataSource
operation.
- The fluent builder is configurable:
knowledge_base_id(impl Into<String>)
/set_knowledge_base_id(Option<String>)
:
required: trueThe unique identifier of the knowledge base from which to delete the data source.
data_source_id(impl Into<String>)
/set_data_source_id(Option<String>)
:
required: trueThe unique identifier of the data source to delete.
- On success, responds with
DeleteDataSourceOutput
with field(s):knowledge_base_id(String)
:The unique identifier of the knowledge base to which the data source that was deleted belonged.
data_source_id(String)
:The unique identifier of the data source that was deleted.
status(DataSourceStatus)
:The status of the data source.
- On failure, responds with
SdkError<DeleteDataSourceError>
source§impl Client
impl Client
sourcepub fn delete_knowledge_base(&self) -> DeleteKnowledgeBaseFluentBuilder
pub fn delete_knowledge_base(&self) -> DeleteKnowledgeBaseFluentBuilder
Constructs a fluent builder for the DeleteKnowledgeBase
operation.
- The fluent builder is configurable:
knowledge_base_id(impl Into<String>)
/set_knowledge_base_id(Option<String>)
:
required: trueThe unique identifier of the knowledge base to delete.
- On success, responds with
DeleteKnowledgeBaseOutput
with field(s):knowledge_base_id(String)
:The unique identifier of the knowledge base that was deleted.
status(KnowledgeBaseStatus)
:The status of the knowledge base and whether it has been successfully deleted.
- On failure, responds with
SdkError<DeleteKnowledgeBaseError>
source§impl Client
impl Client
sourcepub fn disassociate_agent_knowledge_base(
&self
) -> DisassociateAgentKnowledgeBaseFluentBuilder
pub fn disassociate_agent_knowledge_base( &self ) -> DisassociateAgentKnowledgeBaseFluentBuilder
Constructs a fluent builder for the DisassociateAgentKnowledgeBase
operation.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent from which to disassociate the knowledge base.
agent_version(impl Into<String>)
/set_agent_version(Option<String>)
:
required: trueThe version of the agent from which to disassociate the knowledge base.
knowledge_base_id(impl Into<String>)
/set_knowledge_base_id(Option<String>)
:
required: trueThe unique identifier of the knowledge base to disassociate.
- On success, responds with
DisassociateAgentKnowledgeBaseOutput
- On failure, responds with
SdkError<DisassociateAgentKnowledgeBaseError>
source§impl Client
impl Client
sourcepub fn get_agent(&self) -> GetAgentFluentBuilder
pub fn get_agent(&self) -> GetAgentFluentBuilder
Constructs a fluent builder for the GetAgent
operation.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent.
- On success, responds with
GetAgentOutput
with field(s):agent(Option<Agent>)
:Contains details about the agent.
- On failure, responds with
SdkError<GetAgentError>
source§impl Client
impl Client
sourcepub fn get_agent_action_group(&self) -> GetAgentActionGroupFluentBuilder
pub fn get_agent_action_group(&self) -> GetAgentActionGroupFluentBuilder
Constructs a fluent builder for the GetAgentActionGroup
operation.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent that the action group belongs to.
agent_version(impl Into<String>)
/set_agent_version(Option<String>)
:
required: trueThe version of the agent that the action group belongs to.
action_group_id(impl Into<String>)
/set_action_group_id(Option<String>)
:
required: trueThe unique identifier of the action group for which to get information.
- On success, responds with
GetAgentActionGroupOutput
with field(s):agent_action_group(Option<AgentActionGroup>)
:Contains details about the action group.
- On failure, responds with
SdkError<GetAgentActionGroupError>
source§impl Client
impl Client
sourcepub fn get_agent_alias(&self) -> GetAgentAliasFluentBuilder
pub fn get_agent_alias(&self) -> GetAgentAliasFluentBuilder
Constructs a fluent builder for the GetAgentAlias
operation.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent to which the alias to get information belongs.
agent_alias_id(impl Into<String>)
/set_agent_alias_id(Option<String>)
:
required: trueThe unique identifier of the alias for which to get information.
- On success, responds with
GetAgentAliasOutput
with field(s):agent_alias(Option<AgentAlias>)
:Contains information about the alias.
- On failure, responds with
SdkError<GetAgentAliasError>
source§impl Client
impl Client
sourcepub fn get_agent_knowledge_base(&self) -> GetAgentKnowledgeBaseFluentBuilder
pub fn get_agent_knowledge_base(&self) -> GetAgentKnowledgeBaseFluentBuilder
Constructs a fluent builder for the GetAgentKnowledgeBase
operation.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent with which the knowledge base is associated.
agent_version(impl Into<String>)
/set_agent_version(Option<String>)
:
required: trueThe version of the agent with which the knowledge base is associated.
knowledge_base_id(impl Into<String>)
/set_knowledge_base_id(Option<String>)
:
required: trueThe unique identifier of the knowledge base associated with the agent.
- On success, responds with
GetAgentKnowledgeBaseOutput
with field(s):agent_knowledge_base(Option<AgentKnowledgeBase>)
:Contains details about a knowledge base attached to an agent.
- On failure, responds with
SdkError<GetAgentKnowledgeBaseError>
source§impl Client
impl Client
sourcepub fn get_agent_version(&self) -> GetAgentVersionFluentBuilder
pub fn get_agent_version(&self) -> GetAgentVersionFluentBuilder
Constructs a fluent builder for the GetAgentVersion
operation.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent.
agent_version(impl Into<String>)
/set_agent_version(Option<String>)
:
required: trueThe version of the agent.
- On success, responds with
GetAgentVersionOutput
with field(s):agent_version(Option<AgentVersion>)
:Contains details about the version of the agent.
- On failure, responds with
SdkError<GetAgentVersionError>
source§impl Client
impl Client
sourcepub fn get_data_source(&self) -> GetDataSourceFluentBuilder
pub fn get_data_source(&self) -> GetDataSourceFluentBuilder
Constructs a fluent builder for the GetDataSource
operation.
- The fluent builder is configurable:
knowledge_base_id(impl Into<String>)
/set_knowledge_base_id(Option<String>)
:
required: trueThe unique identifier of the knowledge base that the data source was added to.
data_source_id(impl Into<String>)
/set_data_source_id(Option<String>)
:
required: trueThe unique identifier of the data source.
- On success, responds with
GetDataSourceOutput
with field(s):data_source(Option<DataSource>)
:Contains details about the data source.
- On failure, responds with
SdkError<GetDataSourceError>
source§impl Client
impl Client
sourcepub fn get_ingestion_job(&self) -> GetIngestionJobFluentBuilder
pub fn get_ingestion_job(&self) -> GetIngestionJobFluentBuilder
Constructs a fluent builder for the GetIngestionJob
operation.
- The fluent builder is configurable:
knowledge_base_id(impl Into<String>)
/set_knowledge_base_id(Option<String>)
:
required: trueThe unique identifier of the knowledge base for which the ingestion job applies.
data_source_id(impl Into<String>)
/set_data_source_id(Option<String>)
:
required: trueThe unique identifier of the data source in the ingestion job.
ingestion_job_id(impl Into<String>)
/set_ingestion_job_id(Option<String>)
:
required: trueThe unique identifier of the ingestion job.
- On success, responds with
GetIngestionJobOutput
with field(s):ingestion_job(Option<IngestionJob>)
:Contains details about the ingestion job.
- On failure, responds with
SdkError<GetIngestionJobError>
source§impl Client
impl Client
sourcepub fn get_knowledge_base(&self) -> GetKnowledgeBaseFluentBuilder
pub fn get_knowledge_base(&self) -> GetKnowledgeBaseFluentBuilder
Constructs a fluent builder for the GetKnowledgeBase
operation.
- The fluent builder is configurable:
knowledge_base_id(impl Into<String>)
/set_knowledge_base_id(Option<String>)
:
required: trueThe unique identifier of the knowledge base for which to get information.
- On success, responds with
GetKnowledgeBaseOutput
with field(s):knowledge_base(Option<KnowledgeBase>)
:Contains details about the knowledge base.
- On failure, responds with
SdkError<GetKnowledgeBaseError>
source§impl Client
impl Client
sourcepub fn list_agent_action_groups(&self) -> ListAgentActionGroupsFluentBuilder
pub fn list_agent_action_groups(&self) -> ListAgentActionGroupsFluentBuilder
Constructs a fluent builder for the ListAgentActionGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent.
agent_version(impl Into<String>)
/set_agent_version(Option<String>)
:
required: trueThe version of the agent.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextToken
field when making another request to return the next batch of results.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.
- On success, responds with
ListAgentActionGroupsOutput
with field(s):action_group_summaries(Vec::<ActionGroupSummary>)
:A list of objects, each of which contains information about an action group.
next_token(Option<String>)
:If the total number of results is greater than the
maxResults
value provided in the request, use this token when making another request in thenextToken
field to return the next batch of results.
- On failure, responds with
SdkError<ListAgentActionGroupsError>
source§impl Client
impl Client
sourcepub fn list_agent_aliases(&self) -> ListAgentAliasesFluentBuilder
pub fn list_agent_aliases(&self) -> ListAgentAliasesFluentBuilder
Constructs a fluent builder for the ListAgentAliases
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextToken
field when making another request to return the next batch of results.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.
- On success, responds with
ListAgentAliasesOutput
with field(s):agent_alias_summaries(Vec::<AgentAliasSummary>)
:A list of objects, each of which contains information about an alias of the agent.
next_token(Option<String>)
:If the total number of results is greater than the
maxResults
value provided in the request, use this token when making another request in thenextToken
field to return the next batch of results.
- On failure, responds with
SdkError<ListAgentAliasesError>
source§impl Client
impl Client
sourcepub fn list_agent_knowledge_bases(&self) -> ListAgentKnowledgeBasesFluentBuilder
pub fn list_agent_knowledge_bases(&self) -> ListAgentKnowledgeBasesFluentBuilder
Constructs a fluent builder for the ListAgentKnowledgeBases
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent for which to return information about knowledge bases associated with it.
agent_version(impl Into<String>)
/set_agent_version(Option<String>)
:
required: trueThe version of the agent for which to return information about knowledge bases associated with it.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextToken
field when making another request to return the next batch of results.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.
- On success, responds with
ListAgentKnowledgeBasesOutput
with field(s):agent_knowledge_base_summaries(Vec::<AgentKnowledgeBaseSummary>)
:A list of objects, each of which contains information about a knowledge base associated with the agent.
next_token(Option<String>)
:If the total number of results is greater than the
maxResults
value provided in the request, use this token when making another request in thenextToken
field to return the next batch of results.
- On failure, responds with
SdkError<ListAgentKnowledgeBasesError>
source§impl Client
impl Client
sourcepub fn list_agent_versions(&self) -> ListAgentVersionsFluentBuilder
pub fn list_agent_versions(&self) -> ListAgentVersionsFluentBuilder
Constructs a fluent builder for the ListAgentVersions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextToken
field when making another request to return the next batch of results.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.
- On success, responds with
ListAgentVersionsOutput
with field(s):agent_version_summaries(Vec::<AgentVersionSummary>)
:A list of objects, each of which contains information about a version of the agent.
next_token(Option<String>)
:If the total number of results is greater than the
maxResults
value provided in the request, use this token when making another request in thenextToken
field to return the next batch of results.
- On failure, responds with
SdkError<ListAgentVersionsError>
source§impl Client
impl Client
sourcepub fn list_agents(&self) -> ListAgentsFluentBuilder
pub fn list_agents(&self) -> ListAgentsFluentBuilder
Constructs a fluent builder for the ListAgents
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextToken
field when making another request to return the next batch of results.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.
- On success, responds with
ListAgentsOutput
with field(s):agent_summaries(Vec::<AgentSummary>)
:A list of objects, each of which contains information about an agent.
next_token(Option<String>)
:If the total number of results is greater than the
maxResults
value provided in the request, use this token when making another request in thenextToken
field to return the next batch of results.
- On failure, responds with
SdkError<ListAgentsError>
source§impl Client
impl Client
sourcepub fn list_data_sources(&self) -> ListDataSourcesFluentBuilder
pub fn list_data_sources(&self) -> ListDataSourcesFluentBuilder
Constructs a fluent builder for the ListDataSources
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
knowledge_base_id(impl Into<String>)
/set_knowledge_base_id(Option<String>)
:
required: trueThe unique identifier of the knowledge base for which to return a list of information.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextToken
field when making another request to return the next batch of results.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.
- On success, responds with
ListDataSourcesOutput
with field(s):data_source_summaries(Vec::<DataSourceSummary>)
:A list of objects, each of which contains information about a data source.
next_token(Option<String>)
:If the total number of results is greater than the
maxResults
value provided in the request, use this token when making another request in thenextToken
field to return the next batch of results.
- On failure, responds with
SdkError<ListDataSourcesError>
source§impl Client
impl Client
sourcepub fn list_ingestion_jobs(&self) -> ListIngestionJobsFluentBuilder
pub fn list_ingestion_jobs(&self) -> ListIngestionJobsFluentBuilder
Constructs a fluent builder for the ListIngestionJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
knowledge_base_id(impl Into<String>)
/set_knowledge_base_id(Option<String>)
:
required: trueThe unique identifier of the knowledge base for which to return ingestion jobs.
data_source_id(impl Into<String>)
/set_data_source_id(Option<String>)
:
required: trueThe unique identifier of the data source for which to return ingestion jobs.
filters(IngestionJobFilter)
/set_filters(Option<Vec::<IngestionJobFilter>>)
:
required: falseContains a definition of a filter for which to filter the results.
sort_by(IngestionJobSortBy)
/set_sort_by(Option<IngestionJobSortBy>)
:
required: falseContains details about how to sort the results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextToken
field when making another request to return the next batch of results.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.
- On success, responds with
ListIngestionJobsOutput
with field(s):ingestion_job_summaries(Vec::<IngestionJobSummary>)
:A list of objects, each of which contains information about an ingestion job.
next_token(Option<String>)
:If the total number of results is greater than the
maxResults
value provided in the request, use this token when making another request in thenextToken
field to return the next batch of results.
- On failure, responds with
SdkError<ListIngestionJobsError>
source§impl Client
impl Client
sourcepub fn list_knowledge_bases(&self) -> ListKnowledgeBasesFluentBuilder
pub fn list_knowledge_bases(&self) -> ListKnowledgeBasesFluentBuilder
Constructs a fluent builder for the ListKnowledgeBases
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextToken
field when making another request to return the next batch of results.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.
- On success, responds with
ListKnowledgeBasesOutput
with field(s):knowledge_base_summaries(Vec::<KnowledgeBaseSummary>)
:A list of objects, each of which contains information about a knowledge base.
next_token(Option<String>)
:If the total number of results is greater than the
maxResults
value provided in the request, use this token when making another request in thenextToken
field to return the next batch of results.
- On failure, responds with
SdkError<ListKnowledgeBasesError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource for which to list tags.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
:The key-value pairs for the tags associated with the resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn prepare_agent(&self) -> PrepareAgentFluentBuilder
pub fn prepare_agent(&self) -> PrepareAgentFluentBuilder
Constructs a fluent builder for the PrepareAgent
operation.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent for which to create a
DRAFT
version.
- On success, responds with
PrepareAgentOutput
with field(s):agent_id(String)
:The unique identifier of the agent for which the
DRAFT
version was created.agent_status(AgentStatus)
:The status of the
DRAFT
version and whether it is ready for use.agent_version(String)
:The version of the agent.
prepared_at(DateTime)
:The time at which the
DRAFT
version of the agent was last prepared.
- On failure, responds with
SdkError<PrepareAgentError>
source§impl Client
impl Client
sourcepub fn start_ingestion_job(&self) -> StartIngestionJobFluentBuilder
pub fn start_ingestion_job(&self) -> StartIngestionJobFluentBuilder
Constructs a fluent builder for the StartIngestionJob
operation.
- The fluent builder is configurable:
knowledge_base_id(impl Into<String>)
/set_knowledge_base_id(Option<String>)
:
required: trueThe unique identifier of the knowledge base to which to add the data source.
data_source_id(impl Into<String>)
/set_data_source_id(Option<String>)
:
required: trueThe unique identifier of the data source to ingest.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the ingestion job.
- On success, responds with
StartIngestionJobOutput
with field(s):ingestion_job(Option<IngestionJob>)
:An object containing information about the ingestion job.
- On failure, responds with
SdkError<StartIngestionJobError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource to tag.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueAn object containing key-value pairs that define the tags to attach to the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource from which to remove tags.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueA list of keys of the tags to remove from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_agent(&self) -> UpdateAgentFluentBuilder
pub fn update_agent(&self) -> UpdateAgentFluentBuilder
Constructs a fluent builder for the UpdateAgent
operation.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent.
agent_name(impl Into<String>)
/set_agent_name(Option<String>)
:
required: trueSpecifies a new name for the agent.
instruction(impl Into<String>)
/set_instruction(Option<String>)
:
required: falseSpecifies new instructions that tell the agent what it should do and how it should interact with users.
foundation_model(impl Into<String>)
/set_foundation_model(Option<String>)
:
required: trueSpecifies a new foundation model to be used for orchestration by the agent.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseSpecifies a new description of the agent.
idle_session_ttl_in_seconds(i32)
/set_idle_session_ttl_in_seconds(Option<i32>)
:
required: falseThe number of seconds for which Amazon Bedrock keeps information about a user’s conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
agent_resource_role_arn(impl Into<String>)
/set_agent_resource_role_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
customer_encryption_key_arn(impl Into<String>)
/set_customer_encryption_key_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
prompt_override_configuration(PromptOverrideConfiguration)
/set_prompt_override_configuration(Option<PromptOverrideConfiguration>)
:
required: falseContains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
- On success, responds with
UpdateAgentOutput
with field(s):agent(Option<Agent>)
:Contains details about the agent that was updated.
- On failure, responds with
SdkError<UpdateAgentError>
source§impl Client
impl Client
sourcepub fn update_agent_action_group(&self) -> UpdateAgentActionGroupFluentBuilder
pub fn update_agent_action_group(&self) -> UpdateAgentActionGroupFluentBuilder
Constructs a fluent builder for the UpdateAgentActionGroup
operation.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent for which to update the action group.
agent_version(impl Into<String>)
/set_agent_version(Option<String>)
:
required: trueThe unique identifier of the agent version for which to update the action group.
action_group_id(impl Into<String>)
/set_action_group_id(Option<String>)
:
required: trueThe unique identifier of the action group.
action_group_name(impl Into<String>)
/set_action_group_name(Option<String>)
:
required: trueSpecifies a new name for the action group.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseSpecifies a new name for the action group.
parent_action_group_signature(ActionGroupSignature)
/set_parent_action_group_signature(Option<ActionGroupSignature>)
:
required: falseTo allow your agent to request the user for additional information when trying to complete a task, set this field to
AMAZON.UserInput
. You must leave thedescription
,apiSchema
, andactionGroupExecutor
fields blank for this action group.During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn’t have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
action_group_executor(ActionGroupExecutor)
/set_action_group_executor(Option<ActionGroupExecutor>)
:
required: falseThe Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
action_group_state(ActionGroupState)
/set_action_group_state(Option<ActionGroupState>)
:
required: falseSpecifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
api_schema(ApiSchema)
/set_api_schema(Option<ApiSchema>)
:
required: falseContains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
function_schema(FunctionSchema)
/set_function_schema(Option<FunctionSchema>)
:
required: falseContains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
- On success, responds with
UpdateAgentActionGroupOutput
with field(s):agent_action_group(Option<AgentActionGroup>)
:Contains details about the action group that was updated.
- On failure, responds with
SdkError<UpdateAgentActionGroupError>
source§impl Client
impl Client
sourcepub fn update_agent_alias(&self) -> UpdateAgentAliasFluentBuilder
pub fn update_agent_alias(&self) -> UpdateAgentAliasFluentBuilder
Constructs a fluent builder for the UpdateAgentAlias
operation.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent.
agent_alias_id(impl Into<String>)
/set_agent_alias_id(Option<String>)
:
required: trueThe unique identifier of the alias.
agent_alias_name(impl Into<String>)
/set_agent_alias_name(Option<String>)
:
required: trueSpecifies a new name for the alias.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseSpecifies a new description for the alias.
routing_configuration(AgentAliasRoutingConfigurationListItem)
/set_routing_configuration(Option<Vec::<AgentAliasRoutingConfigurationListItem>>)
:
required: falseContains details about the routing configuration of the alias.
- On success, responds with
UpdateAgentAliasOutput
with field(s):agent_alias(Option<AgentAlias>)
:Contains details about the alias that was updated.
- On failure, responds with
SdkError<UpdateAgentAliasError>
source§impl Client
impl Client
sourcepub fn update_agent_knowledge_base(
&self
) -> UpdateAgentKnowledgeBaseFluentBuilder
pub fn update_agent_knowledge_base( &self ) -> UpdateAgentKnowledgeBaseFluentBuilder
Constructs a fluent builder for the UpdateAgentKnowledgeBase
operation.
- The fluent builder is configurable:
agent_id(impl Into<String>)
/set_agent_id(Option<String>)
:
required: trueThe unique identifier of the agent associated with the knowledge base that you want to update.
agent_version(impl Into<String>)
/set_agent_version(Option<String>)
:
required: trueThe version of the agent associated with the knowledge base that you want to update.
knowledge_base_id(impl Into<String>)
/set_knowledge_base_id(Option<String>)
:
required: trueThe unique identifier of the knowledge base that has been associated with an agent.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseSpecifies a new description for the knowledge base associated with an agent.
knowledge_base_state(KnowledgeBaseState)
/set_knowledge_base_state(Option<KnowledgeBaseState>)
:
required: falseSpecifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
- On success, responds with
UpdateAgentKnowledgeBaseOutput
with field(s):agent_knowledge_base(Option<AgentKnowledgeBase>)
:Contains details about the knowledge base that has been associated with an agent.
- On failure, responds with
SdkError<UpdateAgentKnowledgeBaseError>
source§impl Client
impl Client
sourcepub fn update_data_source(&self) -> UpdateDataSourceFluentBuilder
pub fn update_data_source(&self) -> UpdateDataSourceFluentBuilder
Constructs a fluent builder for the UpdateDataSource
operation.
- The fluent builder is configurable:
knowledge_base_id(impl Into<String>)
/set_knowledge_base_id(Option<String>)
:
required: trueThe unique identifier of the knowledge base to which the data source belongs.
data_source_id(impl Into<String>)
/set_data_source_id(Option<String>)
:
required: trueThe unique identifier of the data source.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueSpecifies a new name for the data source.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseSpecifies a new description for the data source.
data_source_configuration(DataSourceConfiguration)
/set_data_source_configuration(Option<DataSourceConfiguration>)
:
required: trueContains details about the storage configuration of the data source.
data_deletion_policy(DataDeletionPolicy)
/set_data_deletion_policy(Option<DataDeletionPolicy>)
:
required: falseThe data deletion policy of the updated data source.
server_side_encryption_configuration(ServerSideEncryptionConfiguration)
/set_server_side_encryption_configuration(Option<ServerSideEncryptionConfiguration>)
:
required: falseContains details about server-side encryption of the data source.
vector_ingestion_configuration(VectorIngestionConfiguration)
/set_vector_ingestion_configuration(Option<VectorIngestionConfiguration>)
:
required: falseContains details about how to ingest the documents in the data source.
- On success, responds with
UpdateDataSourceOutput
with field(s):data_source(Option<DataSource>)
:Contains details about the data source.
- On failure, responds with
SdkError<UpdateDataSourceError>
source§impl Client
impl Client
sourcepub fn update_knowledge_base(&self) -> UpdateKnowledgeBaseFluentBuilder
pub fn update_knowledge_base(&self) -> UpdateKnowledgeBaseFluentBuilder
Constructs a fluent builder for the UpdateKnowledgeBase
operation.
- The fluent builder is configurable:
knowledge_base_id(impl Into<String>)
/set_knowledge_base_id(Option<String>)
:
required: trueThe unique identifier of the knowledge base to update.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueSpecifies a new name for the knowledge base.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseSpecifies a new description for the knowledge base.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: trueSpecifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
knowledge_base_configuration(KnowledgeBaseConfiguration)
/set_knowledge_base_configuration(Option<KnowledgeBaseConfiguration>)
:
required: trueSpecifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.
storage_configuration(StorageConfiguration)
/set_storage_configuration(Option<StorageConfiguration>)
:
required: trueSpecifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.
- On success, responds with
UpdateKnowledgeBaseOutput
with field(s):knowledge_base(Option<KnowledgeBase>)
:Contains details about the knowledge base.
- On failure, responds with
SdkError<UpdateKnowledgeBaseError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more