Struct aws_sdk_bedrockagent::types::Agent

#[non_exhaustive]
pub struct Agent {

    pub agent_id: String,
    pub agent_name: String,
    pub agent_arn: String,
    pub agent_version: String,
    pub client_token: Option<String>,
    pub instruction: Option<String>,
    pub agent_status: AgentStatus,
    pub foundation_model: Option<String>,
    pub description: Option<String>,
    pub idle_session_ttl_in_seconds: i32,
    pub agent_resource_role_arn: String,
    pub customer_encryption_key_arn: Option<String>,
    pub created_at: DateTime,
    pub updated_at: DateTime,
    pub prepared_at: Option<DateTime>,
    pub failure_reasons: Option<Vec<String>>,
    pub recommended_actions: Option<Vec<String>>,
    pub prompt_override_configuration: Option<PromptOverrideConfiguration>,
}

Contains the information of an agent

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

agent_id: String

Identifier for a resource.

agent_name: String

Name for a resource.

agent_arn: String

Arn representation of the Agent.

agent_version: String

Draft Agent Version.

client_token: Option<String>

Client specified token used for idempotency checks

instruction: Option<String>

Instruction for the agent.

agent_status: AgentStatus

Schema Type for Action APIs.

foundation_model: Option<String>

ARN or name of a Bedrock model.

description: Option<String>

Description of the Resource.

idle_session_ttl_in_seconds: i32

Max Session Time.

agent_resource_role_arn: String

ARN of a IAM role.

customer_encryption_key_arn: Option<String>

A KMS key ARN

created_at: DateTime

Time Stamp.

updated_at: DateTime

Time Stamp.

prepared_at: Option<DateTime>

Time Stamp.

failure_reasons: Option<Vec<String>>

Failure Reasons for Error.

recommended_actions: Option<Vec<String>>

The recommended actions users can take to resolve an error in failureReasons.

prompt_override_configuration: Option<PromptOverrideConfiguration>

Configuration for prompt override.

Implementations

impl Agent

pub fn agent_id(&self) -> &str

Identifier for a resource.

pub fn agent_name(&self) -> &str

Name for a resource.

pub fn agent_arn(&self) -> &str

Arn representation of the Agent.

pub fn agent_version(&self) -> &str

Draft Agent Version.

pub fn client_token(&self) -> Option<&str>

Client specified token used for idempotency checks

pub fn instruction(&self) -> Option<&str>

Instruction for the agent.

pub fn agent_status(&self) -> &AgentStatus

Schema Type for Action APIs.

pub fn foundation_model(&self) -> Option<&str>

ARN or name of a Bedrock model.

pub fn description(&self) -> Option<&str>

Description of the Resource.

pub fn idle_session_ttl_in_seconds(&self) -> i32

Max Session Time.

pub fn agent_resource_role_arn(&self) -> &str

ARN of a IAM role.

pub fn customer_encryption_key_arn(&self) -> Option<&str>

A KMS key ARN

pub fn created_at(&self) -> &DateTime

Time Stamp.

pub fn updated_at(&self) -> &DateTime

Time Stamp.

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

Time Stamp.

pub fn failure_reasons(&self) -> &[String]

Failure Reasons for Error.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .failure_reasons.is_none().

pub fn recommended_actions(&self) -> &[String]

The recommended actions users can take to resolve an error in failureReasons.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .recommended_actions.is_none().

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

Configuration for prompt override.

impl Agent

pub fn builder() -> AgentBuilder

Creates a new builder-style object to manufacture Agent.

Trait Implementations

impl Clone for Agent

fn clone(&self) -> Agent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Agent

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

Formats the value using the given formatter.

impl PartialEq for Agent

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Agent