pub struct CreateAgentFluentBuilder { /* private fields */ }
Expand description

Fluent builder constructing a request to CreateAgent.

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

  • Specify the following fields for security purposes.

    • agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.

    • (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.

    • (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.

  • To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.

  • If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.

Implementations§

source§

impl CreateAgentFluentBuilder

source

pub fn as_input(&self) -> &CreateAgentInputBuilder

Access the CreateAgent as a reference.

source

pub async fn send( self ) -> Result<CreateAgentOutput, SdkError<CreateAgentError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

source

pub fn customize( self ) -> CustomizableOperation<CreateAgentOutput, CreateAgentError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

source

pub fn agent_name(self, input: impl Into<String>) -> Self

A name for the agent that you create.

source

pub fn set_agent_name(self, input: Option<String>) -> Self

A name for the agent that you create.

source

pub fn get_agent_name(&self) -> &Option<String>

A name for the agent that you create.

source

pub fn client_token(self, input: impl Into<String>) -> Self

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

source

pub fn set_client_token(self, input: Option<String>) -> Self

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

source

pub fn get_client_token(&self) -> &Option<String>

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

source

pub fn instruction(self, input: impl Into<String>) -> Self

Instructions that tell the agent what it should do and how it should interact with users.

source

pub fn set_instruction(self, input: Option<String>) -> Self

Instructions that tell the agent what it should do and how it should interact with users.

source

pub fn get_instruction(&self) -> &Option<String>

Instructions that tell the agent what it should do and how it should interact with users.

source

pub fn foundation_model(self, input: impl Into<String>) -> Self

The foundation model to be used for orchestration by the agent you create.

source

pub fn set_foundation_model(self, input: Option<String>) -> Self

The foundation model to be used for orchestration by the agent you create.

source

pub fn get_foundation_model(&self) -> &Option<String>

The foundation model to be used for orchestration by the agent you create.

source

pub fn description(self, input: impl Into<String>) -> Self

A description of the agent.

source

pub fn set_description(self, input: Option<String>) -> Self

A description of the agent.

source

pub fn get_description(&self) -> &Option<String>

A description of the agent.

source

pub fn idle_session_ttl_in_seconds(self, input: i32) -> Self

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

source

pub fn set_idle_session_ttl_in_seconds(self, input: Option<i32>) -> Self

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

source

pub fn get_idle_session_ttl_in_seconds(&self) -> &Option<i32>

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

source

pub fn agent_resource_role_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

source

pub fn set_agent_resource_role_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

source

pub fn get_agent_resource_role_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

source

pub fn customer_encryption_key_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

source

pub fn set_customer_encryption_key_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

source

pub fn get_customer_encryption_key_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

source

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

Any tags that you want to attach to the agent.

source

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

Any tags that you want to attach to the agent.

source

pub fn get_tags(&self) -> &Option<HashMap<String, String>>

Any tags that you want to attach to the agent.

source

pub fn prompt_override_configuration( self, input: PromptOverrideConfiguration ) -> Self

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

source

pub fn set_prompt_override_configuration( self, input: Option<PromptOverrideConfiguration> ) -> Self

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

source

pub fn get_prompt_override_configuration( &self ) -> &Option<PromptOverrideConfiguration>

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

source

pub fn guardrail_configuration(self, input: GuardrailConfiguration) -> Self

The unique Guardrail configuration assigned to the agent when it is created.

source

pub fn set_guardrail_configuration( self, input: Option<GuardrailConfiguration> ) -> Self

The unique Guardrail configuration assigned to the agent when it is created.

source

pub fn get_guardrail_configuration(&self) -> &Option<GuardrailConfiguration>

The unique Guardrail configuration assigned to the agent when it is created.

Trait Implementations§

source§

impl Clone for CreateAgentFluentBuilder

source§

fn clone(&self) -> CreateAgentFluentBuilder

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 CreateAgentFluentBuilder

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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