aws_sdk_wickr/client/
create_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 [`CreateBot`](crate::operation::create_bot::builders::CreateBotFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`network_id(impl Into<String>)`](crate::operation::create_bot::builders::CreateBotFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::create_bot::builders::CreateBotFluentBuilder::set_network_id):<br>required: **true**<br><p>The ID of the Wickr network where the bot will be created.</p><br>
7    ///   - [`username(impl Into<String>)`](crate::operation::create_bot::builders::CreateBotFluentBuilder::username) / [`set_username(Option<String>)`](crate::operation::create_bot::builders::CreateBotFluentBuilder::set_username):<br>required: **true**<br><p>The username for the bot. This must be unique within the network and follow the network's naming conventions.</p><br>
8    ///   - [`display_name(impl Into<String>)`](crate::operation::create_bot::builders::CreateBotFluentBuilder::display_name) / [`set_display_name(Option<String>)`](crate::operation::create_bot::builders::CreateBotFluentBuilder::set_display_name):<br>required: **false**<br><p>The display name for the bot that will be visible to users in the network.</p><br>
9    ///   - [`group_id(impl Into<String>)`](crate::operation::create_bot::builders::CreateBotFluentBuilder::group_id) / [`set_group_id(Option<String>)`](crate::operation::create_bot::builders::CreateBotFluentBuilder::set_group_id):<br>required: **true**<br><p>The ID of the security group to which the bot will be assigned.</p><br>
10    ///   - [`challenge(impl Into<String>)`](crate::operation::create_bot::builders::CreateBotFluentBuilder::challenge) / [`set_challenge(Option<String>)`](crate::operation::create_bot::builders::CreateBotFluentBuilder::set_challenge):<br>required: **true**<br><p>The password for the bot account.</p><br>
11    /// - On success, responds with [`CreateBotOutput`](crate::operation::create_bot::CreateBotOutput) with field(s):
12    ///   - [`message(Option<String>)`](crate::operation::create_bot::CreateBotOutput::message): <p>A message indicating the result of the bot creation operation.</p>
13    ///   - [`bot_id(String)`](crate::operation::create_bot::CreateBotOutput::bot_id): <p>The unique identifier assigned to the newly created bot.</p>
14    ///   - [`network_id(Option<String>)`](crate::operation::create_bot::CreateBotOutput::network_id): <p>The ID of the network where the bot was created.</p>
15    ///   - [`username(Option<String>)`](crate::operation::create_bot::CreateBotOutput::username): <p>The username of the newly created bot.</p>
16    ///   - [`display_name(Option<String>)`](crate::operation::create_bot::CreateBotOutput::display_name): <p>The display name of the newly created bot.</p>
17    ///   - [`group_id(Option<String>)`](crate::operation::create_bot::CreateBotOutput::group_id): <p>The ID of the security group to which the bot was assigned.</p>
18    /// - On failure, responds with [`SdkError<CreateBotError>`](crate::operation::create_bot::CreateBotError)
19    pub fn create_bot(&self) -> crate::operation::create_bot::builders::CreateBotFluentBuilder {
20        crate::operation::create_bot::builders::CreateBotFluentBuilder::new(self.handle.clone())
21    }
22}