#[non_exhaustive]pub struct DescribeBotOutput {Show 13 fields
pub bot_id: Option<String>,
pub bot_name: Option<String>,
pub description: Option<String>,
pub role_arn: Option<String>,
pub data_privacy: Option<DataPrivacy>,
pub idle_session_ttl_in_seconds: Option<i32>,
pub bot_status: Option<BotStatus>,
pub creation_date_time: Option<DateTime>,
pub last_updated_date_time: Option<DateTime>,
pub bot_type: Option<BotType>,
pub bot_members: Option<Vec<BotMember>>,
pub failure_reasons: Option<Vec<String>>,
pub error_log_settings: Option<ErrorLogSettings>,
/* private fields */
}
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.bot_id: Option<String>
The unique identifier of the bot.
bot_name: Option<String>
The name of the bot.
description: Option<String>
The description of the bot.
role_arn: Option<String>
The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
data_privacy: Option<DataPrivacy>
Settings for managing data privacy of the bot and its conversations with users.
idle_session_ttl_in_seconds: Option<i32>
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
bot_status: Option<BotStatus>
The current status of the bot. When the status is Available
the bot is ready to be used in conversations with users.
creation_date_time: Option<DateTime>
A timestamp of the date and time that the bot was created.
last_updated_date_time: Option<DateTime>
A timestamp of the date and time that the bot was last updated.
bot_type: Option<BotType>
The type of the bot that was described.
bot_members: Option<Vec<BotMember>>
The list of bots in the network that was described.
failure_reasons: Option<Vec<String>>
If the botStatus
is Failed
, this contains a list of reasons that the bot couldn't be built.
error_log_settings: Option<ErrorLogSettings>
Contains the configuration for error logging that specifies where and how bot errors are recorded, including destinations like CloudWatch Logs.
Implementations§
Source§impl DescribeBotOutput
impl DescribeBotOutput
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description of the bot.
Sourcepub fn role_arn(&self) -> Option<&str>
pub fn role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
Sourcepub fn data_privacy(&self) -> Option<&DataPrivacy>
pub fn data_privacy(&self) -> Option<&DataPrivacy>
Settings for managing data privacy of the bot and its conversations with users.
Sourcepub fn idle_session_ttl_in_seconds(&self) -> Option<i32>
pub fn idle_session_ttl_in_seconds(&self) -> Option<i32>
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
Sourcepub fn bot_status(&self) -> Option<&BotStatus>
pub fn bot_status(&self) -> Option<&BotStatus>
The current status of the bot. When the status is Available
the bot is ready to be used in conversations with users.
Sourcepub fn creation_date_time(&self) -> Option<&DateTime>
pub fn creation_date_time(&self) -> Option<&DateTime>
A timestamp of the date and time that the bot was created.
Sourcepub fn last_updated_date_time(&self) -> Option<&DateTime>
pub fn last_updated_date_time(&self) -> Option<&DateTime>
A timestamp of the date and time that the bot was last updated.
Sourcepub fn bot_members(&self) -> &[BotMember]
pub fn bot_members(&self) -> &[BotMember]
The list of bots in the network that was described.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .bot_members.is_none()
.
Sourcepub fn failure_reasons(&self) -> &[String]
pub fn failure_reasons(&self) -> &[String]
If the botStatus
is Failed
, this contains a list of reasons that the bot couldn't be built.
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()
.
Sourcepub fn error_log_settings(&self) -> Option<&ErrorLogSettings>
pub fn error_log_settings(&self) -> Option<&ErrorLogSettings>
Contains the configuration for error logging that specifies where and how bot errors are recorded, including destinations like CloudWatch Logs.
Source§impl DescribeBotOutput
impl DescribeBotOutput
Sourcepub fn builder() -> DescribeBotOutputBuilder
pub fn builder() -> DescribeBotOutputBuilder
Creates a new builder-style object to manufacture DescribeBotOutput
.
Trait Implementations§
Source§impl Clone for DescribeBotOutput
impl Clone for DescribeBotOutput
Source§fn clone(&self) -> DescribeBotOutput
fn clone(&self) -> DescribeBotOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DescribeBotOutput
impl Debug for DescribeBotOutput
Source§impl PartialEq for DescribeBotOutput
impl PartialEq for DescribeBotOutput
Source§impl RequestId for DescribeBotOutput
impl RequestId for DescribeBotOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for DescribeBotOutput
Auto Trait Implementations§
impl Freeze for DescribeBotOutput
impl RefUnwindSafe for DescribeBotOutput
impl Send for DescribeBotOutput
impl Sync for DescribeBotOutput
impl Unpin for DescribeBotOutput
impl UnwindSafe for DescribeBotOutput
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);