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

source

pub fn associate_agent_knowledge_base( &self ) -> AssociateAgentKnowledgeBaseFluentBuilder

Constructs a fluent builder for the AssociateAgentKnowledgeBase operation.

source§

impl Client

source

pub fn create_agent(&self) -> CreateAgentFluentBuilder

Constructs a fluent builder for the CreateAgent operation.

source§

impl Client

source

pub fn create_agent_action_group(&self) -> CreateAgentActionGroupFluentBuilder

Constructs a fluent builder for the CreateAgentActionGroup operation.

source§

impl Client

source

pub fn create_agent_alias(&self) -> CreateAgentAliasFluentBuilder

Constructs a fluent builder for the CreateAgentAlias operation.

source§

impl Client

source

pub fn create_data_source(&self) -> CreateDataSourceFluentBuilder

Constructs a fluent builder for the CreateDataSource operation.

source§

impl Client

source

pub fn create_knowledge_base(&self) -> CreateKnowledgeBaseFluentBuilder

Constructs a fluent builder for the CreateKnowledgeBase operation.

source§

impl Client

source

pub fn delete_agent(&self) -> DeleteAgentFluentBuilder

Constructs a fluent builder for the DeleteAgent operation.

source§

impl Client

source

pub fn delete_agent_action_group(&self) -> DeleteAgentActionGroupFluentBuilder

Constructs a fluent builder for the DeleteAgentActionGroup operation.

source§

impl Client

source

pub fn delete_agent_alias(&self) -> DeleteAgentAliasFluentBuilder

Constructs a fluent builder for the DeleteAgentAlias operation.

source§

impl Client

source

pub fn delete_agent_version(&self) -> DeleteAgentVersionFluentBuilder

Constructs a fluent builder for the DeleteAgentVersion operation.

source§

impl Client

source

pub fn delete_data_source(&self) -> DeleteDataSourceFluentBuilder

Constructs a fluent builder for the DeleteDataSource operation.

source§

impl Client

source

pub fn delete_knowledge_base(&self) -> DeleteKnowledgeBaseFluentBuilder

Constructs a fluent builder for the DeleteKnowledgeBase operation.

source§

impl Client

source

pub fn disassociate_agent_knowledge_base( &self ) -> DisassociateAgentKnowledgeBaseFluentBuilder

Constructs a fluent builder for the DisassociateAgentKnowledgeBase operation.

source§

impl Client

source

pub fn get_agent(&self) -> GetAgentFluentBuilder

Constructs a fluent builder for the GetAgent operation.

source§

impl Client

source

pub fn get_agent_action_group(&self) -> GetAgentActionGroupFluentBuilder

Constructs a fluent builder for the GetAgentActionGroup operation.

source§

impl Client

source

pub fn get_agent_alias(&self) -> GetAgentAliasFluentBuilder

Constructs a fluent builder for the GetAgentAlias operation.

source§

impl Client

source

pub fn get_agent_knowledge_base(&self) -> GetAgentKnowledgeBaseFluentBuilder

Constructs a fluent builder for the GetAgentKnowledgeBase operation.

source§

impl Client

source

pub fn get_agent_version(&self) -> GetAgentVersionFluentBuilder

Constructs a fluent builder for the GetAgentVersion operation.

source§

impl Client

source

pub fn get_data_source(&self) -> GetDataSourceFluentBuilder

Constructs a fluent builder for the GetDataSource operation.

source§

impl Client

source

pub fn get_ingestion_job(&self) -> GetIngestionJobFluentBuilder

Constructs a fluent builder for the GetIngestionJob operation.

source§

impl Client

source

pub fn get_knowledge_base(&self) -> GetKnowledgeBaseFluentBuilder

Constructs a fluent builder for the GetKnowledgeBase operation.

source§

impl Client

source

pub fn list_agent_action_groups(&self) -> ListAgentActionGroupsFluentBuilder

Constructs a fluent builder for the ListAgentActionGroups operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn list_agent_aliases(&self) -> ListAgentAliasesFluentBuilder

Constructs a fluent builder for the ListAgentAliases operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn list_agent_knowledge_bases(&self) -> ListAgentKnowledgeBasesFluentBuilder

Constructs a fluent builder for the ListAgentKnowledgeBases operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn list_agent_versions(&self) -> ListAgentVersionsFluentBuilder

Constructs a fluent builder for the ListAgentVersions operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

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

      The 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: false

      If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken 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 the nextToken field to return the next batch of results.

  • On failure, responds with SdkError<ListAgentsError>
source§

impl Client

source

pub fn list_data_sources(&self) -> ListDataSourcesFluentBuilder

Constructs a fluent builder for the ListDataSources operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn list_ingestion_jobs(&self) -> ListIngestionJobsFluentBuilder

Constructs a fluent builder for the ListIngestionJobs operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn list_knowledge_bases(&self) -> ListKnowledgeBasesFluentBuilder

Constructs a fluent builder for the ListKnowledgeBases operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

source§

impl Client

source

pub fn prepare_agent(&self) -> PrepareAgentFluentBuilder

Constructs a fluent builder for the PrepareAgent operation.

source§

impl Client

source

pub fn start_ingestion_job(&self) -> StartIngestionJobFluentBuilder

Constructs a fluent builder for the StartIngestionJob operation.

source§

impl Client

source

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

source§

impl Client

source

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

source§

impl Client

source

pub fn update_agent(&self) -> UpdateAgentFluentBuilder

Constructs a fluent builder for the UpdateAgent operation.

source§

impl Client

source

pub fn update_agent_action_group(&self) -> UpdateAgentActionGroupFluentBuilder

Constructs a fluent builder for the UpdateAgentActionGroup operation.

source§

impl Client

source

pub fn update_agent_alias(&self) -> UpdateAgentAliasFluentBuilder

Constructs a fluent builder for the UpdateAgentAlias operation.

source§

impl Client

source

pub fn update_agent_knowledge_base( &self ) -> UpdateAgentKnowledgeBaseFluentBuilder

Constructs a fluent builder for the UpdateAgentKnowledgeBase operation.

source§

impl Client

source

pub fn update_data_source(&self) -> UpdateDataSourceFluentBuilder

Constructs a fluent builder for the UpdateDataSource operation.

source§

impl Client

source

pub fn update_knowledge_base(&self) -> UpdateKnowledgeBaseFluentBuilder

Constructs a fluent builder for the UpdateKnowledgeBase operation.

source§

impl Client

source

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.

source

pub fn config(&self) -> &Config

Returns the client’s configuration.

source§

impl Client

source

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§

source§

impl Clone for Client

source§

fn clone(&self) -> Client

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Client

source§

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

Formats the value using the given formatter. Read more

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> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more