aws_sdk_wickr/client/
get_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 [`GetBot`](crate::operation::get_bot::builders::GetBotFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`network_id(impl Into<String>)`](crate::operation::get_bot::builders::GetBotFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::get_bot::builders::GetBotFluentBuilder::set_network_id):<br>required: **true**<br><p>The ID of the Wickr network containing the bot.</p><br>
7    ///   - [`bot_id(impl Into<String>)`](crate::operation::get_bot::builders::GetBotFluentBuilder::bot_id) / [`set_bot_id(Option<String>)`](crate::operation::get_bot::builders::GetBotFluentBuilder::set_bot_id):<br>required: **true**<br><p>The unique identifier of the bot to retrieve.</p><br>
8    /// - On success, responds with [`GetBotOutput`](crate::operation::get_bot::GetBotOutput) with field(s):
9    ///   - [`bot_id(Option<String>)`](crate::operation::get_bot::GetBotOutput::bot_id): <p>The unique identifier of the bot.</p>
10    ///   - [`display_name(Option<String>)`](crate::operation::get_bot::GetBotOutput::display_name): <p>The display name of the bot that is visible to users.</p>
11    ///   - [`username(Option<String>)`](crate::operation::get_bot::GetBotOutput::username): <p>The username of the bot.</p>
12    ///   - [`uname(Option<String>)`](crate::operation::get_bot::GetBotOutput::uname): <p>The unique username hash identifier for the bot.</p>
13    ///   - [`pubkey(Option<String>)`](crate::operation::get_bot::GetBotOutput::pubkey): <p>The public key of the bot used for encryption.</p>
14    ///   - [`status(Option<i32>)`](crate::operation::get_bot::GetBotOutput::status): <p>The current status of the bot (1 for pending, 2 for active).</p>
15    ///   - [`group_id(Option<String>)`](crate::operation::get_bot::GetBotOutput::group_id): <p>The ID of the security group to which the bot belongs.</p>
16    ///   - [`has_challenge(Option<bool>)`](crate::operation::get_bot::GetBotOutput::has_challenge): <p>Indicates whether the bot has a password set.</p>
17    ///   - [`suspended(Option<bool>)`](crate::operation::get_bot::GetBotOutput::suspended): <p>Indicates whether the bot is currently suspended.</p>
18    ///   - [`last_login(Option<String>)`](crate::operation::get_bot::GetBotOutput::last_login): <p>The timestamp of the bot's last login.</p>
19    /// - On failure, responds with [`SdkError<GetBotError>`](crate::operation::get_bot::GetBotError)
20    pub fn get_bot(&self) -> crate::operation::get_bot::builders::GetBotFluentBuilder {
21        crate::operation::get_bot::builders::GetBotFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_wickr/client/get_bot.rs

aws_sdk_wickr/client/
get_bot.rs
