#[non_exhaustive]pub struct AssistantData {
pub assistant_id: String,
pub assistant_arn: String,
pub name: String,
pub type: AssistantType,
pub status: AssistantStatus,
pub description: Option<String>,
pub tags: Option<HashMap<String, String>>,
pub server_side_encryption_configuration: Option<ServerSideEncryptionConfiguration>,
pub integration_configuration: Option<AssistantIntegrationConfiguration>,
pub capability_configuration: Option<AssistantCapabilityConfiguration>,
pub ai_agent_configuration: Option<HashMap<AiAgentType, AiAgentConfigurationData>>,
}
Expand description
The assistant data.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.assistant_id: String
The identifier of the Amazon Q in Connect assistant.
assistant_arn: String
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
name: String
The name.
type: AssistantType
The type of assistant.
status: AssistantStatus
The status of the assistant.
description: Option<String>
The description.
The tags used to organize, track, or control access for this resource.
server_side_encryption_configuration: Option<ServerSideEncryptionConfiguration>
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant
, kms:DescribeKey
, kms:Decrypt
, and kms:GenerateDataKey*
permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt
, kms:GenerateDataKey*
, and kms:DescribeKey
permissions to the connect.amazonaws.com
service principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
integration_configuration: Option<AssistantIntegrationConfiguration>
The configuration information for the Amazon Q in Connect assistant integration.
capability_configuration: Option<AssistantCapabilityConfiguration>
The configuration information for the Amazon Q in Connect assistant capability.
ai_agent_configuration: Option<HashMap<AiAgentType, AiAgentConfigurationData>>
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
Implementations§
Source§impl AssistantData
impl AssistantData
Sourcepub fn assistant_id(&self) -> &str
pub fn assistant_id(&self) -> &str
The identifier of the Amazon Q in Connect assistant.
Sourcepub fn assistant_arn(&self) -> &str
pub fn assistant_arn(&self) -> &str
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
Sourcepub fn type(&self) -> &AssistantType
pub fn type(&self) -> &AssistantType
The type of assistant.
Sourcepub fn status(&self) -> &AssistantStatus
pub fn status(&self) -> &AssistantStatus
The status of the assistant.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description.
The tags used to organize, track, or control access for this resource.
Sourcepub fn server_side_encryption_configuration(
&self,
) -> Option<&ServerSideEncryptionConfiguration>
pub fn server_side_encryption_configuration( &self, ) -> Option<&ServerSideEncryptionConfiguration>
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant
, kms:DescribeKey
, kms:Decrypt
, and kms:GenerateDataKey*
permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt
, kms:GenerateDataKey*
, and kms:DescribeKey
permissions to the connect.amazonaws.com
service principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
Sourcepub fn integration_configuration(
&self,
) -> Option<&AssistantIntegrationConfiguration>
pub fn integration_configuration( &self, ) -> Option<&AssistantIntegrationConfiguration>
The configuration information for the Amazon Q in Connect assistant integration.
Sourcepub fn capability_configuration(
&self,
) -> Option<&AssistantCapabilityConfiguration>
pub fn capability_configuration( &self, ) -> Option<&AssistantCapabilityConfiguration>
The configuration information for the Amazon Q in Connect assistant capability.
Sourcepub fn ai_agent_configuration(
&self,
) -> Option<&HashMap<AiAgentType, AiAgentConfigurationData>>
pub fn ai_agent_configuration( &self, ) -> Option<&HashMap<AiAgentType, AiAgentConfigurationData>>
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
Source§impl AssistantData
impl AssistantData
Sourcepub fn builder() -> AssistantDataBuilder
pub fn builder() -> AssistantDataBuilder
Creates a new builder-style object to manufacture AssistantData
.
Trait Implementations§
Source§impl Clone for AssistantData
impl Clone for AssistantData
Source§fn clone(&self) -> AssistantData
fn clone(&self) -> AssistantData
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for AssistantData
impl Debug for AssistantData
Source§impl PartialEq for AssistantData
impl PartialEq for AssistantData
impl StructuralPartialEq for AssistantData
Auto Trait Implementations§
impl Freeze for AssistantData
impl RefUnwindSafe for AssistantData
impl Send for AssistantData
impl Sync for AssistantData
impl Unpin for AssistantData
impl UnwindSafe for AssistantData
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);