Struct aws_sdk_bedrockagent::Client

pub struct Client { /* private fields */ }

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

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    Draft Version of the Agent.
    
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    Identifier for a resource.
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    Description of the Resource.
    
  • knowledge_base_state(KnowledgeBaseState) / set_knowledge_base_state(Option<KnowledgeBaseState>):
    required: false
    State of the knowledge base; whether it is enabled or disabled
    
• On success, responds with AssociateAgentKnowledgeBaseOutput with field(s):
  • agent_knowledge_base(Option<AgentKnowledgeBase>): Contains the information of an Agent Knowledge Base.
• On failure, responds with SdkError<AssociateAgentKnowledgeBaseError>

impl Client

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: true
    Name for a resource.
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    Client specified token used for idempotency checks
    
  • instruction(impl Into<String>) / set_instruction(Option<String>):
    required: false
    Instruction for the agent.
    
  • foundation_model(impl Into<String>) / set_foundation_model(Option<String>):
    required: false
    ARN or name of a Bedrock model.
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    Description of the Resource.
    
  • idle_session_ttl_in_seconds(i32) / set_idle_session_ttl_in_seconds(Option<i32>):
    required: false
    Max Session Time.
    
  • agent_resource_role_arn(impl Into<String>) / set_agent_resource_role_arn(Option<String>):
    required: true
    ARN of a IAM role.
    
  • customer_encryption_key_arn(impl Into<String>) / set_customer_encryption_key_arn(Option<String>):
    required: false
    A KMS key ARN
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    A map of tag keys and values
    
  • prompt_override_configuration(PromptOverrideConfiguration) / set_prompt_override_configuration(Option<PromptOverrideConfiguration>):
    required: false
    Configuration for prompt override.
    
• On success, responds with CreateAgentOutput with field(s):
  • agent(Option<Agent>): Contains the information of an agent
• On failure, responds with SdkError<CreateAgentError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    Draft Version of the Agent.
    
  • action_group_name(impl Into<String>) / set_action_group_name(Option<String>):
    required: true
    Name for a resource.
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    Client specified token used for idempotency checks
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    Description of the Resource.
    
  • parent_action_group_signature(ActionGroupSignature) / set_parent_action_group_signature(Option<ActionGroupSignature>):
    required: false
    Action Group Signature for a BuiltIn Action
    
  • action_group_executor(ActionGroupExecutor) / set_action_group_executor(Option<ActionGroupExecutor>):
    required: false
    Type of Executors for an Action Group
    
  • api_schema(ApiSchema) / set_api_schema(Option<ApiSchema>):
    required: false
    Contains information about the API Schema for the Action Group
    
  • action_group_state(ActionGroupState) / set_action_group_state(Option<ActionGroupState>):
    required: false
    State of the action group
    
• On success, responds with CreateAgentActionGroupOutput with field(s):
  • agent_action_group(Option<AgentActionGroup>): Contains the information of an Agent Action Group
• On failure, responds with SdkError<CreateAgentActionGroupError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • agent_alias_name(impl Into<String>) / set_agent_alias_name(Option<String>):
    required: true
    Name for a resource.
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    Client specified token used for idempotency checks
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    Description of the Resource.
    
  • routing_configuration(AgentAliasRoutingConfigurationListItem) / set_routing_configuration(Option<Vec::<AgentAliasRoutingConfigurationListItem>>):
    required: false
    Routing configuration for an Agent alias.
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    A map of tag keys and values
    
• On success, responds with CreateAgentAliasOutput with field(s):
  • agent_alias(Option<AgentAlias>): Contains the information of an agent alias
• On failure, responds with SdkError<CreateAgentAliasError>

impl Client

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: true
    Identifier for a resource.
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    Client specified token used for idempotency checks
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    Name for a resource.
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    Description of the Resource.
    
  • data_source_configuration(DataSourceConfiguration) / set_data_source_configuration(Option<DataSourceConfiguration>):
    required: true
    Specifies a raw data source location to ingest.
    
  • server_side_encryption_configuration(ServerSideEncryptionConfiguration) / set_server_side_encryption_configuration(Option<ServerSideEncryptionConfiguration>):
    required: false
    Server-side encryption configuration.
    
  • vector_ingestion_configuration(VectorIngestionConfiguration) / set_vector_ingestion_configuration(Option<VectorIngestionConfiguration>):
    required: false
    Configures ingestion for a vector knowledge base
    
• On success, responds with CreateDataSourceOutput with field(s):
  • data_source(Option<DataSource>): Contains the information of a data source.
• On failure, responds with SdkError<CreateDataSourceError>

impl Client

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: false
    Client specified token used for idempotency checks
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    Name for a resource.
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    Description of the Resource.
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    ARN of a IAM role.
    
  • knowledge_base_configuration(KnowledgeBaseConfiguration) / set_knowledge_base_configuration(Option<KnowledgeBaseConfiguration>):
    required: true
    Configures a bedrock knowledge base.
    
  • storage_configuration(StorageConfiguration) / set_storage_configuration(Option<StorageConfiguration>):
    required: true
    Configures the physical storage of ingested data in a knowledge base.
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    A map of tag keys and values
    
• On success, responds with CreateKnowledgeBaseOutput with field(s):
  • knowledge_base(Option<KnowledgeBase>): Contains the information of a knowledge base.
• On failure, responds with SdkError<CreateKnowledgeBaseError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • skip_resource_in_use_check(bool) / set_skip_resource_in_use_check(Option<bool>):
    required: false
    Skips checking if resource is in use when set to true. Defaults to false
    
• On success, responds with DeleteAgentOutput with field(s):
  • agent_id(String): Identifier for a resource.
  • agent_status(AgentStatus): Schema Type for Action APIs.
• On failure, responds with SdkError<DeleteAgentError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    Draft Version of the Agent.
    
  • action_group_id(impl Into<String>) / set_action_group_id(Option<String>):
    required: true
    Id generated at the server side when an Agent ActionGroup is created
    
  • skip_resource_in_use_check(bool) / set_skip_resource_in_use_check(Option<bool>):
    required: false
    Skips checking if resource is in use when set to true. Defaults to false
    
• On success, responds with DeleteAgentActionGroupOutput
• On failure, responds with SdkError<DeleteAgentActionGroupError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • agent_alias_id(impl Into<String>) / set_agent_alias_id(Option<String>):
    required: true
    Id generated at the server side when an Agent Alias is created
    
• On success, responds with DeleteAgentAliasOutput with field(s):
  • agent_id(String): Identifier for a resource.
  • agent_alias_id(String): Id for an Agent Alias generated at the server side.
  • agent_alias_status(AgentAliasStatus): The statuses an Agent Alias can be in.
• On failure, responds with SdkError<DeleteAgentAliasError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    Numerical Agent Version.
    
  • skip_resource_in_use_check(bool) / set_skip_resource_in_use_check(Option<bool>):
    required: false
    Skips checking if resource is in use when set to true. Defaults to false
    
• On success, responds with DeleteAgentVersionOutput with field(s):
  • agent_id(String): Identifier for a resource.
  • agent_version(String): Numerical Agent Version.
  • agent_status(AgentStatus): Schema Type for Action APIs.
• On failure, responds with SdkError<DeleteAgentVersionError>

impl Client

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: true
    Identifier for a resource.
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    Identifier for a resource.
    
• On success, responds with DeleteDataSourceOutput with field(s):
  • knowledge_base_id(String): Identifier for a resource.
  • data_source_id(String): Identifier for a resource.
  • status(DataSourceStatus): The status of a data source.
• On failure, responds with SdkError<DeleteDataSourceError>

impl Client

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: true
    Identifier for a resource.
    
• On success, responds with DeleteKnowledgeBaseOutput with field(s):
  • knowledge_base_id(String): Identifier for a resource.
  • status(KnowledgeBaseStatus): The status of a knowledge base.
• On failure, responds with SdkError<DeleteKnowledgeBaseError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    Draft Version of the Agent.
    
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    Id generated at the server side when a Knowledge Base is associated to an Agent
    
• On success, responds with DisassociateAgentKnowledgeBaseOutput
• On failure, responds with SdkError<DisassociateAgentKnowledgeBaseError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
• On success, responds with GetAgentOutput with field(s):
  • agent(Option<Agent>): Contains the information of an agent
• On failure, responds with SdkError<GetAgentError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    Version number generated when a version is created
    
  • action_group_id(impl Into<String>) / set_action_group_id(Option<String>):
    required: true
    Id generated at the server side when an Agent Action Group is created
    
• On success, responds with GetAgentActionGroupOutput with field(s):
  • agent_action_group(Option<AgentActionGroup>): Contains the information of an Agent Action Group
• On failure, responds with SdkError<GetAgentActionGroupError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • agent_alias_id(impl Into<String>) / set_agent_alias_id(Option<String>):
    required: true
    Id generated at the server side when an Agent Alias is created
    
• On success, responds with GetAgentAliasOutput with field(s):
  • agent_alias(Option<AgentAlias>): Contains the information of an agent alias
• On failure, responds with SdkError<GetAgentAliasError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    Version number generated when a version is created
    
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    Id generated at the server side when a Knowledge Base is associated
    
• On success, responds with GetAgentKnowledgeBaseOutput with field(s):
  • agent_knowledge_base(Option<AgentKnowledgeBase>): Contains the information of an Agent Knowledge Base.
• On failure, responds with SdkError<GetAgentKnowledgeBaseError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    Numerical Agent Version.
    
• On success, responds with GetAgentVersionOutput with field(s):
  • agent_version(Option<AgentVersion>): Contains the information of an agent version.
• On failure, responds with SdkError<GetAgentVersionError>

impl Client

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: true
    Identifier for a resource.
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    Identifier for a resource.
    
• On success, responds with GetDataSourceOutput with field(s):
  • data_source(Option<DataSource>): Contains the information of a data source.
• On failure, responds with SdkError<GetDataSourceError>

impl Client

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: true
    Identifier for a resource.
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    Identifier for a resource.
    
  • ingestion_job_id(impl Into<String>) / set_ingestion_job_id(Option<String>):
    required: true
    Identifier for a resource.
    
• On success, responds with GetIngestionJobOutput with field(s):
  • ingestion_job(Option<IngestionJob>): Contains the information of an ingestion job.
• On failure, responds with SdkError<GetIngestionJobError>

impl Client

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: true
    Identifier for a resource.
    
• On success, responds with GetKnowledgeBaseOutput with field(s):
  • knowledge_base(Option<KnowledgeBase>): Contains the information of a knowledge base.
• On failure, responds with SdkError<GetKnowledgeBaseError>

impl Client

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: true
    Id generated at the server side when an Agent is Listed
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    Id generated at the server side when an Agent is Listed
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    Max Results.
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    Opaque continuation token of previous paginated response.
    
• On success, responds with ListAgentActionGroupsOutput with field(s):
  • action_group_summaries(Vec::<ActionGroupSummary>): List of ActionGroup Summaries
  • next_token(Option<String>): Opaque continuation token of previous paginated response.
• On failure, responds with SdkError<ListAgentActionGroupsError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    Max Results.
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    Opaque continuation token of previous paginated response.
    
• On success, responds with ListAgentAliasesOutput with field(s):
  • agent_alias_summaries(Vec::<AgentAliasSummary>): The list of summaries of all the aliases for an Agent.
  • next_token(Option<String>): Opaque continuation token of previous paginated response.
• On failure, responds with SdkError<ListAgentAliasesError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    Version number generated when a version is created
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    Max Results.
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    Opaque continuation token of previous paginated response.
    
• On success, responds with ListAgentKnowledgeBasesOutput with field(s):
  • agent_knowledge_base_summaries(Vec::<AgentKnowledgeBaseSummary>): List of Agent Knowledge Base Summaries
  • next_token(Option<String>): Opaque continuation token of previous paginated response.
• On failure, responds with SdkError<ListAgentKnowledgeBasesError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    Max Results.
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    Opaque continuation token of previous paginated response.
    
• On success, responds with ListAgentVersionsOutput with field(s):
  • agent_version_summaries(Vec::<AgentVersionSummary>): List of AgentVersionSummary.
  • next_token(Option<String>): Opaque continuation token of previous paginated response.
• On failure, responds with SdkError<ListAgentVersionsError>

impl Client

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: false
    Max Results.
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    Opaque continuation token of previous paginated response.
    
• On success, responds with ListAgentsOutput with field(s):
  • agent_summaries(Vec::<AgentSummary>): List of AgentSummary.
  • next_token(Option<String>): Opaque continuation token of previous paginated response.
• On failure, responds with SdkError<ListAgentsError>

impl Client

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: true
    Identifier for a resource.
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    Max Results.
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    Opaque continuation token of previous paginated response.
    
• On success, responds with ListDataSourcesOutput with field(s):
  • data_source_summaries(Vec::<DataSourceSummary>): list of data source summaries
  • next_token(Option<String>): Opaque continuation token of previous paginated response.
• On failure, responds with SdkError<ListDataSourcesError>

impl Client

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: true
    Identifier for a resource.
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    Identifier for a resource.
    
  • filters(IngestionJobFilter) / set_filters(Option<Vec::<IngestionJobFilter>>):
    required: false
    List of IngestionJobFilters
    
  • sort_by(IngestionJobSortBy) / set_sort_by(Option<IngestionJobSortBy>):
    required: false
    Sorts the response returned by ListIngestionJobs operation.
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    Max Results.
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    Opaque continuation token of previous paginated response.
    
• On success, responds with ListIngestionJobsOutput with field(s):
  • ingestion_job_summaries(Vec::<IngestionJobSummary>): List of IngestionJobSummaries
  • next_token(Option<String>): Opaque continuation token of previous paginated response.
• On failure, responds with SdkError<ListIngestionJobsError>

impl Client

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: false
    Max Results.
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    Opaque continuation token of previous paginated response.
    
• On success, responds with ListKnowledgeBasesOutput with field(s):
  • knowledge_base_summaries(Vec::<KnowledgeBaseSummary>): List of KnowledgeBaseSummaries
  • next_token(Option<String>): Opaque continuation token of previous paginated response.
• On failure, responds with SdkError<ListKnowledgeBasesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base]
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>): A map of tag keys and values
• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
• On success, responds with PrepareAgentOutput with field(s):
  • agent_id(String): Identifier for a resource.
  • agent_status(AgentStatus): Schema Type for Action APIs.
  • agent_version(String): Agent Version.
  • prepared_at(DateTime): Time Stamp.
• On failure, responds with SdkError<PrepareAgentError>

impl Client

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: true
    Identifier for a resource.
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    Identifier for a resource.
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    Client specified token used for idempotency checks
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    Description of the Resource.
    
• On success, responds with StartIngestionJobOutput with field(s):
  • ingestion_job(Option<IngestionJob>): Contains the information of an ingestion job.
• On failure, responds with SdkError<StartIngestionJobError>

impl Client

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: true
    ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base]
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    A map of tag keys and values
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

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: true
    ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base]
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    List of Tag Keys
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • agent_name(impl Into<String>) / set_agent_name(Option<String>):
    required: true
    Name for a resource.
    
  • instruction(impl Into<String>) / set_instruction(Option<String>):
    required: false
    Instruction for the agent.
    
  • foundation_model(impl Into<String>) / set_foundation_model(Option<String>):
    required: false
    ARN or name of a Bedrock model.
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    Description of the Resource.
    
  • idle_session_ttl_in_seconds(i32) / set_idle_session_ttl_in_seconds(Option<i32>):
    required: false
    Max Session Time.
    
  • agent_resource_role_arn(impl Into<String>) / set_agent_resource_role_arn(Option<String>):
    required: true
    ARN of a IAM role.
    
  • customer_encryption_key_arn(impl Into<String>) / set_customer_encryption_key_arn(Option<String>):
    required: false
    A KMS key ARN
    
  • prompt_override_configuration(PromptOverrideConfiguration) / set_prompt_override_configuration(Option<PromptOverrideConfiguration>):
    required: false
    Configuration for prompt override.
    
• On success, responds with UpdateAgentOutput with field(s):
  • agent(Option<Agent>): Contains the information of an agent
• On failure, responds with SdkError<UpdateAgentError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    Draft Version of the Agent.
    
  • action_group_id(impl Into<String>) / set_action_group_id(Option<String>):
    required: true
    Id generated at the server side when an Action Group is created under Agent
    
  • action_group_name(impl Into<String>) / set_action_group_name(Option<String>):
    required: true
    Name for a resource.
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    Description of the Resource.
    
  • parent_action_group_signature(ActionGroupSignature) / set_parent_action_group_signature(Option<ActionGroupSignature>):
    required: false
    Action Group Signature for a BuiltIn Action
    
  • action_group_executor(ActionGroupExecutor) / set_action_group_executor(Option<ActionGroupExecutor>):
    required: false
    Type of Executors for an Action Group
    
  • action_group_state(ActionGroupState) / set_action_group_state(Option<ActionGroupState>):
    required: false
    State of the action group
    
  • api_schema(ApiSchema) / set_api_schema(Option<ApiSchema>):
    required: false
    Contains information about the API Schema for the Action Group
    
• On success, responds with UpdateAgentActionGroupOutput with field(s):
  • agent_action_group(Option<AgentActionGroup>): Contains the information of an Agent Action Group
• On failure, responds with SdkError<UpdateAgentActionGroupError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • agent_alias_id(impl Into<String>) / set_agent_alias_id(Option<String>):
    required: true
    Id generated at the server side when an Agent Alias is created
    
  • agent_alias_name(impl Into<String>) / set_agent_alias_name(Option<String>):
    required: true
    Name for a resource.
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    Description of the Resource.
    
  • routing_configuration(AgentAliasRoutingConfigurationListItem) / set_routing_configuration(Option<Vec::<AgentAliasRoutingConfigurationListItem>>):
    required: false
    Routing configuration for an Agent alias.
    
• On success, responds with UpdateAgentAliasOutput with field(s):
  • agent_alias(Option<AgentAlias>): Contains the information of an agent alias
• On failure, responds with SdkError<UpdateAgentAliasError>

impl Client

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: true
    Id generated at the server side when an Agent is created
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    Draft Version of the Agent.
    
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    Id generated at the server side when a Knowledge Base is associated to an Agent
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    Description of the Resource.
    
  • knowledge_base_state(KnowledgeBaseState) / set_knowledge_base_state(Option<KnowledgeBaseState>):
    required: false
    State of the knowledge base; whether it is enabled or disabled
    
• On success, responds with UpdateAgentKnowledgeBaseOutput with field(s):
  • agent_knowledge_base(Option<AgentKnowledgeBase>): Contains the information of an Agent Knowledge Base.
• On failure, responds with SdkError<UpdateAgentKnowledgeBaseError>

impl Client

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: true
    Identifier for a resource.
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    Identifier for a resource.
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    Name for a resource.
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    Description of the Resource.
    
  • data_source_configuration(DataSourceConfiguration) / set_data_source_configuration(Option<DataSourceConfiguration>):
    required: true
    Specifies a raw data source location to ingest.
    
  • server_side_encryption_configuration(ServerSideEncryptionConfiguration) / set_server_side_encryption_configuration(Option<ServerSideEncryptionConfiguration>):
    required: false
    Server-side encryption configuration.
    
  • vector_ingestion_configuration(VectorIngestionConfiguration) / set_vector_ingestion_configuration(Option<VectorIngestionConfiguration>):
    required: false
    Configures ingestion for a vector knowledge base
    
• On success, responds with UpdateDataSourceOutput with field(s):
  • data_source(Option<DataSource>): Contains the information of a data source.
• On failure, responds with SdkError<UpdateDataSourceError>

impl Client

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: true
    Identifier for a resource.
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    Name for a resource.
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    Description of the Resource.
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    ARN of a IAM role.
    
  • knowledge_base_configuration(KnowledgeBaseConfiguration) / set_knowledge_base_configuration(Option<KnowledgeBaseConfiguration>):
    required: true
    Configures a bedrock knowledge base.
    
  • storage_configuration(StorageConfiguration) / set_storage_configuration(Option<StorageConfiguration>):
    required: true
    Configures the physical storage of ingested data in a knowledge base.
    
• On success, responds with UpdateKnowledgeBaseOutput with field(s):
  • knowledge_base(Option<KnowledgeBase>): Contains the information of a knowledge base.
• On failure, responds with SdkError<UpdateKnowledgeBaseError>

impl Client

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 and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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 the sleep_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 the http_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, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.