Struct AgentActionGroupBuilder 

#[non_exhaustive]
pub struct AgentActionGroupBuilder { /* private fields */ }

A builder for AgentActionGroup.

Implementations

impl AgentActionGroupBuilder

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

The unique identifier of the agent to which the action group belongs.

This field is required.

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

The unique identifier of the agent to which the action group belongs.

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

The unique identifier of the agent to which the action group belongs.

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

The version of the agent to which the action group belongs.

This field is required.

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

The version of the agent to which the action group belongs.

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

The version of the agent to which the action group belongs.

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

The unique identifier of the action group.

This field is required.

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

The unique identifier of the action group.

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

The unique identifier of the action group.

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

The name of the action group.

This field is required.

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

The name of the action group.

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

The name of the action group.

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.

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.

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.

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

The description of the action group.

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

The description of the action group.

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

The description of the action group.

pub fn created_at(self, input: DateTime) -> Self

The time at which the action group was created.

This field is required.

pub fn set_created_at(self, input: Option<DateTime>) -> Self

The time at which the action group was created.

pub fn get_created_at(&self) -> &Option<DateTime>

The time at which the action group was created.

pub fn updated_at(self, input: DateTime) -> Self

The time at which the action group was last updated.

This field is required.

pub fn set_updated_at(self, input: Option<DateTime>) -> Self

The time at which the action group was last updated.

pub fn get_updated_at(&self) -> &Option<DateTime>

The time at which the action group was last updated.

pub fn parent_action_signature(self, input: ActionGroupSignature) -> Self

If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.

During orchestration, if the 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.

pub fn set_parent_action_signature( self, input: Option<ActionGroupSignature>, ) -> Self

If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.

During orchestration, if the 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.

pub fn get_parent_action_signature(&self) -> &Option<ActionGroupSignature>

If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.

During orchestration, if the 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.

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

Adds a key-value pair to parent_action_group_signature_params.

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

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

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

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.

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.

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.

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.

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.

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.

pub fn function_schema(self, input: FunctionSchema) -> Self

Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.

pub fn set_function_schema(self, input: Option<FunctionSchema>) -> Self

Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.

pub fn get_function_schema(&self) -> &Option<FunctionSchema>

Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.

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.

This field is required.

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.

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.

pub fn build(self) -> Result<AgentActionGroup, BuildError>

Consumes the builder and constructs a AgentActionGroup. This method will fail if any of the following fields are not set:

• agent_id
• agent_version
• action_group_id
• action_group_name
• created_at
• updated_at
• action_group_state

Trait Implementations

impl Clone for AgentActionGroupBuilder

fn clone(&self) -> AgentActionGroupBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentActionGroupBuilder

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

Formats the value using the given formatter.

impl Default for AgentActionGroupBuilder

fn default() -> AgentActionGroupBuilder

Returns the “default value” for a type.

impl PartialEq for AgentActionGroupBuilder

fn eq(&self, other: &AgentActionGroupBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AgentActionGroupBuilder