aws_sdk_lexmodelsv2/client/
update_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 [`UpdateBot`](crate::operation::update_bot::builders::UpdateBotFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`bot_id(impl Into<String>)`](crate::operation::update_bot::builders::UpdateBotFluentBuilder::bot_id) / [`set_bot_id(Option<String>)`](crate::operation::update_bot::builders::UpdateBotFluentBuilder::set_bot_id):<br>required: **true**<br><p>The unique identifier of the bot to update. This identifier is returned by the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html">CreateBot</a> operation.</p><br>
7    ///   - [`bot_name(impl Into<String>)`](crate::operation::update_bot::builders::UpdateBotFluentBuilder::bot_name) / [`set_bot_name(Option<String>)`](crate::operation::update_bot::builders::UpdateBotFluentBuilder::set_bot_name):<br>required: **true**<br><p>The new name of the bot. The name must be unique in the account that creates the bot.</p><br>
8    ///   - [`description(impl Into<String>)`](crate::operation::update_bot::builders::UpdateBotFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_bot::builders::UpdateBotFluentBuilder::set_description):<br>required: **false**<br><p>A description of the bot.</p><br>
9    ///   - [`role_arn(impl Into<String>)`](crate::operation::update_bot::builders::UpdateBotFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::update_bot::builders::UpdateBotFluentBuilder::set_role_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.</p><br>
10    ///   - [`data_privacy(DataPrivacy)`](crate::operation::update_bot::builders::UpdateBotFluentBuilder::data_privacy) / [`set_data_privacy(Option<DataPrivacy>)`](crate::operation::update_bot::builders::UpdateBotFluentBuilder::set_data_privacy):<br>required: **true**<br><p>Provides information on additional privacy protections Amazon Lex should use with the bot's data.</p><br>
11    ///   - [`idle_session_ttl_in_seconds(i32)`](crate::operation::update_bot::builders::UpdateBotFluentBuilder::idle_session_ttl_in_seconds) / [`set_idle_session_ttl_in_seconds(Option<i32>)`](crate::operation::update_bot::builders::UpdateBotFluentBuilder::set_idle_session_ttl_in_seconds):<br>required: **true**<br><p>The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.</p> <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.</p> <p>You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.</p><br>
12    ///   - [`bot_type(BotType)`](crate::operation::update_bot::builders::UpdateBotFluentBuilder::bot_type) / [`set_bot_type(Option<BotType>)`](crate::operation::update_bot::builders::UpdateBotFluentBuilder::set_bot_type):<br>required: **false**<br><p>The type of the bot to be updated.</p><br>
13    ///   - [`bot_members(BotMember)`](crate::operation::update_bot::builders::UpdateBotFluentBuilder::bot_members) / [`set_bot_members(Option<Vec::<BotMember>>)`](crate::operation::update_bot::builders::UpdateBotFluentBuilder::set_bot_members):<br>required: **false**<br><p>The list of bot members in the network associated with the update action.</p><br>
14    ///   - [`error_log_settings(ErrorLogSettings)`](crate::operation::update_bot::builders::UpdateBotFluentBuilder::error_log_settings) / [`set_error_log_settings(Option<ErrorLogSettings>)`](crate::operation::update_bot::builders::UpdateBotFluentBuilder::set_error_log_settings):<br>required: **false**<br><p>Allows you to modify how Amazon Lex logs errors during bot interactions, including destinations for error logs and the types of errors to be captured.</p><br>
15    /// - On success, responds with [`UpdateBotOutput`](crate::operation::update_bot::UpdateBotOutput) with field(s):
16    ///   - [`bot_id(Option<String>)`](crate::operation::update_bot::UpdateBotOutput::bot_id): <p>The unique identifier of the bot that was updated.</p>
17    ///   - [`bot_name(Option<String>)`](crate::operation::update_bot::UpdateBotOutput::bot_name): <p>The name of the bot after the update.</p>
18    ///   - [`description(Option<String>)`](crate::operation::update_bot::UpdateBotOutput::description): <p>The description of the bot after the update.</p>
19    ///   - [`role_arn(Option<String>)`](crate::operation::update_bot::UpdateBotOutput::role_arn): <p>The Amazon Resource Name (ARN) of the IAM role used by the bot after the update.</p>
20    ///   - [`data_privacy(Option<DataPrivacy>)`](crate::operation::update_bot::UpdateBotOutput::data_privacy): <p>The data privacy settings for the bot after the update.</p>
21    ///   - [`idle_session_ttl_in_seconds(Option<i32>)`](crate::operation::update_bot::UpdateBotOutput::idle_session_ttl_in_seconds): <p>The session timeout, in seconds, for the bot after the update.</p>
22    ///   - [`bot_status(Option<BotStatus>)`](crate::operation::update_bot::UpdateBotOutput::bot_status): <p>Shows the current status of the bot. The bot is first in the <code>Creating</code> status. Once the bot is read for use, it changes to the <code>Available</code> status. After the bot is created, you can use the <code>DRAFT</code> version of the bot.</p>
23    ///   - [`creation_date_time(Option<DateTime>)`](crate::operation::update_bot::UpdateBotOutput::creation_date_time): <p>A timestamp of the date and time that the bot was created.</p>
24    ///   - [`last_updated_date_time(Option<DateTime>)`](crate::operation::update_bot::UpdateBotOutput::last_updated_date_time): <p>A timestamp of the date and time that the bot was last updated.</p>
25    ///   - [`bot_type(Option<BotType>)`](crate::operation::update_bot::UpdateBotOutput::bot_type): <p>The type of the bot that was updated.</p>
26    ///   - [`bot_members(Option<Vec::<BotMember>>)`](crate::operation::update_bot::UpdateBotOutput::bot_members): <p>The list of bot members in the network that was updated.</p>
27    ///   - [`error_log_settings(Option<ErrorLogSettings>)`](crate::operation::update_bot::UpdateBotOutput::error_log_settings): <p>Settings for managing error logs within the response of an update bot operation.</p>
28    /// - On failure, responds with [`SdkError<UpdateBotError>`](crate::operation::update_bot::UpdateBotError)
29    pub fn update_bot(&self) -> crate::operation::update_bot::builders::UpdateBotFluentBuilder {
30        crate::operation::update_bot::builders::UpdateBotFluentBuilder::new(self.handle.clone())
31    }
32}