#[non_exhaustive]pub struct CreateAiGuardrailInput {Show 13 fields
pub client_token: Option<String>,
pub assistant_id: Option<String>,
pub name: Option<String>,
pub blocked_input_messaging: Option<String>,
pub blocked_outputs_messaging: Option<String>,
pub visibility_status: Option<VisibilityStatus>,
pub description: Option<String>,
pub topic_policy_config: Option<AiGuardrailTopicPolicyConfig>,
pub content_policy_config: Option<AiGuardrailContentPolicyConfig>,
pub word_policy_config: Option<AiGuardrailWordPolicyConfig>,
pub sensitive_information_policy_config: Option<AiGuardrailSensitiveInformationPolicyConfig>,
pub contextual_grounding_policy_config: Option<AiGuardrailContextualGroundingPolicyConfig>,
pub tags: Option<HashMap<String, String>>,
}
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.client_token: Option<String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
assistant_id: Option<String>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
name: Option<String>
The name of the AI Guardrail.
blocked_input_messaging: Option<String>
The message to return when the AI Guardrail blocks a prompt.
blocked_outputs_messaging: Option<String>
The message to return when the AI Guardrail blocks a model response.
visibility_status: Option<VisibilityStatus>
The visibility status of the AI Guardrail.
description: Option<String>
A description of the AI Guardrail.
topic_policy_config: Option<AiGuardrailTopicPolicyConfig>
The topic policies to configure for the AI Guardrail.
content_policy_config: Option<AiGuardrailContentPolicyConfig>
The content filter policies to configure for the AI Guardrail.
word_policy_config: Option<AiGuardrailWordPolicyConfig>
The word policy you configure for the AI Guardrail.
sensitive_information_policy_config: Option<AiGuardrailSensitiveInformationPolicyConfig>
The sensitive information policy to configure for the AI Guardrail.
contextual_grounding_policy_config: Option<AiGuardrailContextualGroundingPolicyConfig>
The contextual grounding policy configuration used to create an AI Guardrail.
The tags used to organize, track, or control access for this resource.
Implementations§
Source§impl CreateAiGuardrailInput
impl CreateAiGuardrailInput
Sourcepub fn client_token(&self) -> Option<&str>
pub fn client_token(&self) -> Option<&str>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
Sourcepub fn assistant_id(&self) -> Option<&str>
pub fn assistant_id(&self) -> Option<&str>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Sourcepub fn blocked_input_messaging(&self) -> Option<&str>
pub fn blocked_input_messaging(&self) -> Option<&str>
The message to return when the AI Guardrail blocks a prompt.
Sourcepub fn blocked_outputs_messaging(&self) -> Option<&str>
pub fn blocked_outputs_messaging(&self) -> Option<&str>
The message to return when the AI Guardrail blocks a model response.
Sourcepub fn visibility_status(&self) -> Option<&VisibilityStatus>
pub fn visibility_status(&self) -> Option<&VisibilityStatus>
The visibility status of the AI Guardrail.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A description of the AI Guardrail.
Sourcepub fn topic_policy_config(&self) -> Option<&AiGuardrailTopicPolicyConfig>
pub fn topic_policy_config(&self) -> Option<&AiGuardrailTopicPolicyConfig>
The topic policies to configure for the AI Guardrail.
Sourcepub fn content_policy_config(&self) -> Option<&AiGuardrailContentPolicyConfig>
pub fn content_policy_config(&self) -> Option<&AiGuardrailContentPolicyConfig>
The content filter policies to configure for the AI Guardrail.
Sourcepub fn word_policy_config(&self) -> Option<&AiGuardrailWordPolicyConfig>
pub fn word_policy_config(&self) -> Option<&AiGuardrailWordPolicyConfig>
The word policy you configure for the AI Guardrail.
Sourcepub fn sensitive_information_policy_config(
&self,
) -> Option<&AiGuardrailSensitiveInformationPolicyConfig>
pub fn sensitive_information_policy_config( &self, ) -> Option<&AiGuardrailSensitiveInformationPolicyConfig>
The sensitive information policy to configure for the AI Guardrail.
Sourcepub fn contextual_grounding_policy_config(
&self,
) -> Option<&AiGuardrailContextualGroundingPolicyConfig>
pub fn contextual_grounding_policy_config( &self, ) -> Option<&AiGuardrailContextualGroundingPolicyConfig>
The contextual grounding policy configuration used to create an AI Guardrail.
The tags used to organize, track, or control access for this resource.
Source§impl CreateAiGuardrailInput
impl CreateAiGuardrailInput
Sourcepub fn builder() -> CreateAiGuardrailInputBuilder
pub fn builder() -> CreateAiGuardrailInputBuilder
Creates a new builder-style object to manufacture CreateAiGuardrailInput
.
Trait Implementations§
Source§impl Clone for CreateAiGuardrailInput
impl Clone for CreateAiGuardrailInput
Source§fn clone(&self) -> CreateAiGuardrailInput
fn clone(&self) -> CreateAiGuardrailInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateAiGuardrailInput
impl Debug for CreateAiGuardrailInput
Source§impl PartialEq for CreateAiGuardrailInput
impl PartialEq for CreateAiGuardrailInput
impl StructuralPartialEq for CreateAiGuardrailInput
Auto Trait Implementations§
impl Freeze for CreateAiGuardrailInput
impl RefUnwindSafe for CreateAiGuardrailInput
impl Send for CreateAiGuardrailInput
impl Sync for CreateAiGuardrailInput
impl Unpin for CreateAiGuardrailInput
impl UnwindSafe for CreateAiGuardrailInput
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);