pub struct CreateAgentActionGroupFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateAgentActionGroup.
Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.
To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.CodeInterpreter.
You must leave the description, apiSchema, and actionGroupExecutor 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.
Implementations§
Source§impl CreateAgentActionGroupFluentBuilder
impl CreateAgentActionGroupFluentBuilder
Sourcepub fn as_input(&self) -> &CreateAgentActionGroupInputBuilder
pub fn as_input(&self) -> &CreateAgentActionGroupInputBuilder
Access the CreateAgentActionGroup as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateAgentActionGroupOutput, SdkError<CreateAgentActionGroupError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateAgentActionGroupOutput, SdkError<CreateAgentActionGroupError, 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.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateAgentActionGroupOutput, CreateAgentActionGroupError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateAgentActionGroupOutput, CreateAgentActionGroupError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn agent_id(self, input: impl Into<String>) -> Self
pub fn agent_id(self, input: impl Into<String>) -> Self
The unique identifier of the agent for which to create the action group.
Sourcepub fn set_agent_id(self, input: Option<String>) -> Self
pub fn set_agent_id(self, input: Option<String>) -> Self
The unique identifier of the agent for which to create the action group.
Sourcepub fn get_agent_id(&self) -> &Option<String>
pub fn get_agent_id(&self) -> &Option<String>
The unique identifier of the agent for which to create the action group.
Sourcepub fn agent_version(self, input: impl Into<String>) -> Self
pub fn agent_version(self, input: impl Into<String>) -> Self
The version of the agent for which to create the action group.
Sourcepub fn set_agent_version(self, input: Option<String>) -> Self
pub fn set_agent_version(self, input: Option<String>) -> Self
The version of the agent for which to create the action group.
Sourcepub fn get_agent_version(&self) -> &Option<String>
pub fn get_agent_version(&self) -> &Option<String>
The version of the agent for which to create the action group.
Sourcepub fn action_group_name(self, input: impl Into<String>) -> Self
pub fn action_group_name(self, input: impl Into<String>) -> Self
The name to give the action group.
Sourcepub fn set_action_group_name(self, input: Option<String>) -> Self
pub fn set_action_group_name(self, input: Option<String>) -> Self
The name to give the action group.
Sourcepub fn get_action_group_name(&self) -> &Option<String>
pub fn get_action_group_name(&self) -> &Option<String>
The name to give the action group.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
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.
Sourcepub fn get_client_token(&self) -> &Option<String>
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.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the action group.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the action group.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the action group.
Sourcepub fn parent_action_group_signature(self, input: ActionGroupSignature) -> Self
pub fn parent_action_group_signature(self, input: ActionGroupSignature) -> Self
Specify a built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.
-
To allow your agent to request the user for additional information when trying to complete a task, set this field to
AMAZON.UserInput. -
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to
AMAZON.CodeInterpreter. -
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
-
ANTHROPIC.Computer- Gives the agent permission to use the mouse and keyboard and take screenshots. -
ANTHROPIC.TextEditor- Gives the agent permission to view, create and edit files. -
ANTHROPIC.Bash- Gives the agent permission to run commands in a bash shell.
-
Sourcepub fn set_parent_action_group_signature(
self,
input: Option<ActionGroupSignature>,
) -> Self
pub fn set_parent_action_group_signature( self, input: Option<ActionGroupSignature>, ) -> Self
Specify a built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.
-
To allow your agent to request the user for additional information when trying to complete a task, set this field to
AMAZON.UserInput. -
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to
AMAZON.CodeInterpreter. -
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
-
ANTHROPIC.Computer- Gives the agent permission to use the mouse and keyboard and take screenshots. -
ANTHROPIC.TextEditor- Gives the agent permission to view, create and edit files. -
ANTHROPIC.Bash- Gives the agent permission to run commands in a bash shell.
-
Sourcepub fn get_parent_action_group_signature(&self) -> &Option<ActionGroupSignature>
pub fn get_parent_action_group_signature(&self) -> &Option<ActionGroupSignature>
Specify a built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.
-
To allow your agent to request the user for additional information when trying to complete a task, set this field to
AMAZON.UserInput. -
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to
AMAZON.CodeInterpreter. -
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
-
ANTHROPIC.Computer- Gives the agent permission to use the mouse and keyboard and take screenshots. -
ANTHROPIC.TextEditor- Gives the agent permission to view, create and edit files. -
ANTHROPIC.Bash- Gives the agent permission to run commands in a bash shell.
-
Sourcepub fn parent_action_group_signature_params(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn parent_action_group_signature_params( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to parentActionGroupSignatureParams.
To override the contents of this collection use set_parent_action_group_signature_params.
The configuration settings for a computer use action.
Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
Sourcepub fn set_parent_action_group_signature_params(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_parent_action_group_signature_params( self, input: Option<HashMap<String, String>>, ) -> Self
The configuration settings for a computer use action.
Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
Sourcepub fn get_parent_action_group_signature_params(
&self,
) -> &Option<HashMap<String, String>>
pub fn get_parent_action_group_signature_params( &self, ) -> &Option<HashMap<String, String>>
The configuration settings for a computer use action.
Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
Sourcepub fn action_group_executor(self, input: ActionGroupExecutor) -> Self
pub fn action_group_executor(self, input: ActionGroupExecutor) -> Self
The 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.
Sourcepub fn set_action_group_executor(
self,
input: Option<ActionGroupExecutor>,
) -> Self
pub fn set_action_group_executor( self, input: Option<ActionGroupExecutor>, ) -> Self
The 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.
Sourcepub fn get_action_group_executor(&self) -> &Option<ActionGroupExecutor>
pub fn get_action_group_executor(&self) -> &Option<ActionGroupExecutor>
The 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.
Sourcepub fn api_schema(self, input: ApiSchema) -> Self
pub fn api_schema(self, input: ApiSchema) -> Self
Contains 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.
Sourcepub fn set_api_schema(self, input: Option<ApiSchema>) -> Self
pub fn set_api_schema(self, input: Option<ApiSchema>) -> Self
Contains 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.
Sourcepub fn get_api_schema(&self) -> &Option<ApiSchema>
pub fn get_api_schema(&self) -> &Option<ApiSchema>
Contains 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.
Sourcepub fn action_group_state(self, input: ActionGroupState) -> Self
pub fn action_group_state(self, input: ActionGroupState) -> Self
Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
Sourcepub fn set_action_group_state(self, input: Option<ActionGroupState>) -> Self
pub fn set_action_group_state(self, input: Option<ActionGroupState>) -> Self
Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
Sourcepub fn get_action_group_state(&self) -> &Option<ActionGroupState>
pub fn get_action_group_state(&self) -> &Option<ActionGroupState>
Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
Sourcepub fn function_schema(self, input: FunctionSchema) -> Self
pub fn function_schema(self, input: FunctionSchema) -> Self
Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
Sourcepub fn set_function_schema(self, input: Option<FunctionSchema>) -> Self
pub fn set_function_schema(self, input: Option<FunctionSchema>) -> Self
Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
Sourcepub fn get_function_schema(&self) -> &Option<FunctionSchema>
pub fn get_function_schema(&self) -> &Option<FunctionSchema>
Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
Trait Implementations§
Source§impl Clone for CreateAgentActionGroupFluentBuilder
impl Clone for CreateAgentActionGroupFluentBuilder
Source§fn clone(&self) -> CreateAgentActionGroupFluentBuilder
fn clone(&self) -> CreateAgentActionGroupFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CreateAgentActionGroupFluentBuilder
impl !RefUnwindSafe for CreateAgentActionGroupFluentBuilder
impl Send for CreateAgentActionGroupFluentBuilder
impl Sync for CreateAgentActionGroupFluentBuilder
impl Unpin for CreateAgentActionGroupFluentBuilder
impl !UnwindSafe for CreateAgentActionGroupFluentBuilder
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);