aws_sdk_lexmodelsv2/client/
describe_bot.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeBot`](crate::operation::describe_bot::builders::DescribeBotFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`bot_id(impl Into<String>)`](crate::operation::describe_bot::builders::DescribeBotFluentBuilder::bot_id) / [`set_bot_id(Option<String>)`](crate::operation::describe_bot::builders::DescribeBotFluentBuilder::set_bot_id):<br>required: **true**<br><p>The unique identifier of the bot to describe.</p><br>
7    /// - On success, responds with [`DescribeBotOutput`](crate::operation::describe_bot::DescribeBotOutput) with field(s):
8    ///   - [`bot_id(Option<String>)`](crate::operation::describe_bot::DescribeBotOutput::bot_id): <p>The unique identifier of the bot.</p>
9    ///   - [`bot_name(Option<String>)`](crate::operation::describe_bot::DescribeBotOutput::bot_name): <p>The name of the bot.</p>
10    ///   - [`description(Option<String>)`](crate::operation::describe_bot::DescribeBotOutput::description): <p>The description of the bot.</p>
11    ///   - [`role_arn(Option<String>)`](crate::operation::describe_bot::DescribeBotOutput::role_arn): <p>The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.</p>
12    ///   - [`data_privacy(Option<DataPrivacy>)`](crate::operation::describe_bot::DescribeBotOutput::data_privacy): <p>Settings for managing data privacy of the bot and its conversations with users.</p>
13    ///   - [`idle_session_ttl_in_seconds(Option<i32>)`](crate::operation::describe_bot::DescribeBotOutput::idle_session_ttl_in_seconds): <p>The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.</p>
14    ///   - [`bot_status(Option<BotStatus>)`](crate::operation::describe_bot::DescribeBotOutput::bot_status): <p>The current status of the bot. When the status is <code>Available</code> the bot is ready to be used in conversations with users.</p>
15    ///   - [`creation_date_time(Option<DateTime>)`](crate::operation::describe_bot::DescribeBotOutput::creation_date_time): <p>A timestamp of the date and time that the bot was created.</p>
16    ///   - [`last_updated_date_time(Option<DateTime>)`](crate::operation::describe_bot::DescribeBotOutput::last_updated_date_time): <p>A timestamp of the date and time that the bot was last updated.</p>
17    ///   - [`bot_type(Option<BotType>)`](crate::operation::describe_bot::DescribeBotOutput::bot_type): <p>The type of the bot that was described.</p>
18    ///   - [`bot_members(Option<Vec::<BotMember>>)`](crate::operation::describe_bot::DescribeBotOutput::bot_members): <p>The list of bots in the network that was described.</p>
19    ///   - [`failure_reasons(Option<Vec::<String>>)`](crate::operation::describe_bot::DescribeBotOutput::failure_reasons): <p>If the <code>botStatus</code> is <code>Failed</code>, this contains a list of reasons that the bot couldn't be built.</p>
20    ///   - [`error_log_settings(Option<ErrorLogSettings>)`](crate::operation::describe_bot::DescribeBotOutput::error_log_settings): <p>Contains the configuration for error logging that specifies where and how bot errors are recorded, including destinations like CloudWatch Logs.</p>
21    /// - On failure, responds with [`SdkError<DescribeBotError>`](crate::operation::describe_bot::DescribeBotError)
22    pub fn describe_bot(&self) -> crate::operation::describe_bot::builders::DescribeBotFluentBuilder {
23        crate::operation::describe_bot::builders::DescribeBotFluentBuilder::new(self.handle.clone())
24    }
25}
aws_sdk_lexmodelsv2/client/describe_bot.rs

aws_sdk_lexmodelsv2/client/
describe_bot.rs
