aws_sdk_connect/operation/update_authentication_profile/

builders.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::update_authentication_profile::_update_authentication_profile_output::UpdateAuthenticationProfileOutputBuilder;

pub use crate::operation::update_authentication_profile::_update_authentication_profile_input::UpdateAuthenticationProfileInputBuilder;

impl crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::update_authentication_profile::UpdateAuthenticationProfileOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::update_authentication_profile::UpdateAuthenticationProfileError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.update_authentication_profile();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `UpdateAuthenticationProfile`.
///
/// <p>This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.</p>
/// <p>Updates the selected authentication profile.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct UpdateAuthenticationProfileFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::update_authentication_profile::UpdateAuthenticationProfileOutput,
        crate::operation::update_authentication_profile::UpdateAuthenticationProfileError,
    > for UpdateAuthenticationProfileFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::update_authentication_profile::UpdateAuthenticationProfileOutput,
            crate::operation::update_authentication_profile::UpdateAuthenticationProfileError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl UpdateAuthenticationProfileFluentBuilder {
    /// Creates a new `UpdateAuthenticationProfileFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the UpdateAuthenticationProfile as a reference.
    pub fn as_input(&self) -> &crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::update_authentication_profile::UpdateAuthenticationProfileOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::update_authentication_profile::UpdateAuthenticationProfileError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::update_authentication_profile::UpdateAuthenticationProfile::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::update_authentication_profile::UpdateAuthenticationProfile::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::update_authentication_profile::UpdateAuthenticationProfileOutput,
        crate::operation::update_authentication_profile::UpdateAuthenticationProfileError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// <p>A unique identifier for the authentication profile.</p>
    pub fn authentication_profile_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.authentication_profile_id(input.into());
        self
    }
    /// <p>A unique identifier for the authentication profile.</p>
    pub fn set_authentication_profile_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_authentication_profile_id(input);
        self
    }
    /// <p>A unique identifier for the authentication profile.</p>
    pub fn get_authentication_profile_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_authentication_profile_id()
    }
    /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
    pub fn instance_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.instance_id(input.into());
        self
    }
    /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
    pub fn set_instance_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_instance_id(input);
        self
    }
    /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
    pub fn get_instance_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_instance_id()
    }
    /// <p>The name for the authentication profile.</p>
    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.name(input.into());
        self
    }
    /// <p>The name for the authentication profile.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_name(input);
        self
    }
    /// <p>The name for the authentication profile.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_name()
    }
    /// <p>The description for the authentication profile.</p>
    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.description(input.into());
        self
    }
    /// <p>The description for the authentication profile.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_description(input);
        self
    }
    /// <p>The description for the authentication profile.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_description()
    }
    ///
    /// Appends an item to `AllowedIps`.
    ///
    /// To override the contents of this collection use [`set_allowed_ips`](Self::set_allowed_ips).
    ///
    /// <p>A list of IP address range strings that are allowed to access the instance. For more information on how to configure IP addresses, see<a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts">Configure session timeouts</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
    pub fn allowed_ips(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.allowed_ips(input.into());
        self
    }
    /// <p>A list of IP address range strings that are allowed to access the instance. For more information on how to configure IP addresses, see<a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts">Configure session timeouts</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
    pub fn set_allowed_ips(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.inner = self.inner.set_allowed_ips(input);
        self
    }
    /// <p>A list of IP address range strings that are allowed to access the instance. For more information on how to configure IP addresses, see<a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts">Configure session timeouts</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
    pub fn get_allowed_ips(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        self.inner.get_allowed_ips()
    }
    ///
    /// Appends an item to `BlockedIps`.
    ///
    /// To override the contents of this collection use [`set_blocked_ips`](Self::set_blocked_ips).
    ///
    /// <p>A list of IP address range strings that are blocked from accessing the instance. For more information on how to configure IP addresses, For more information on how to configure IP addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac">Configure IP-based access control</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
    pub fn blocked_ips(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.blocked_ips(input.into());
        self
    }
    /// <p>A list of IP address range strings that are blocked from accessing the instance. For more information on how to configure IP addresses, For more information on how to configure IP addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac">Configure IP-based access control</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
    pub fn set_blocked_ips(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.inner = self.inner.set_blocked_ips(input);
        self
    }
    /// <p>A list of IP address range strings that are blocked from accessing the instance. For more information on how to configure IP addresses, For more information on how to configure IP addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac">Configure IP-based access control</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
    pub fn get_blocked_ips(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        self.inner.get_blocked_ips()
    }
    /// <p>The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, For more information on how to configure IP addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts">Configure session timeouts</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
    #[deprecated(
        note = "PeriodicSessionDuration is deprecated. Use SessionInactivityDuration instead.",
        since = "10/31/2025"
    )]
    pub fn periodic_session_duration(mut self, input: i32) -> Self {
        self.inner = self.inner.periodic_session_duration(input);
        self
    }
    /// <p>The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, For more information on how to configure IP addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts">Configure session timeouts</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
    #[deprecated(
        note = "PeriodicSessionDuration is deprecated. Use SessionInactivityDuration instead.",
        since = "10/31/2025"
    )]
    pub fn set_periodic_session_duration(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_periodic_session_duration(input);
        self
    }
    /// <p>The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, For more information on how to configure IP addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts">Configure session timeouts</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
    #[deprecated(
        note = "PeriodicSessionDuration is deprecated. Use SessionInactivityDuration instead.",
        since = "10/31/2025"
    )]
    pub fn get_periodic_session_duration(&self) -> &::std::option::Option<i32> {
        self.inner.get_periodic_session_duration()
    }
    /// <p>The period, in minutes, before an agent is automatically signed out of the contact center when they go inactive.</p>
    pub fn session_inactivity_duration(mut self, input: i32) -> Self {
        self.inner = self.inner.session_inactivity_duration(input);
        self
    }
    /// <p>The period, in minutes, before an agent is automatically signed out of the contact center when they go inactive.</p>
    pub fn set_session_inactivity_duration(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_session_inactivity_duration(input);
        self
    }
    /// <p>The period, in minutes, before an agent is automatically signed out of the contact center when they go inactive.</p>
    pub fn get_session_inactivity_duration(&self) -> &::std::option::Option<i32> {
        self.inner.get_session_inactivity_duration()
    }
    /// <p>Determines if automatic logout on user inactivity is enabled.</p>
    pub fn session_inactivity_handling_enabled(mut self, input: bool) -> Self {
        self.inner = self.inner.session_inactivity_handling_enabled(input);
        self
    }
    /// <p>Determines if automatic logout on user inactivity is enabled.</p>
    pub fn set_session_inactivity_handling_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
        self.inner = self.inner.set_session_inactivity_handling_enabled(input);
        self
    }
    /// <p>Determines if automatic logout on user inactivity is enabled.</p>
    pub fn get_session_inactivity_handling_enabled(&self) -> &::std::option::Option<bool> {
        self.inner.get_session_inactivity_handling_enabled()
    }
}