aws_sdk_connect/client/
update_authentication_profile.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateAuthenticationProfile`](crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`authentication_profile_id(impl Into<String>)`](crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileFluentBuilder::authentication_profile_id) / [`set_authentication_profile_id(Option<String>)`](crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileFluentBuilder::set_authentication_profile_id):<br>required: **true**<br><p>A unique identifier for the authentication profile.</p><br>
    ///   - [`instance_id(impl Into<String>)`](crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileFluentBuilder::set_instance_id):<br>required: **true**<br><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><br>
    ///   - [`name(impl Into<String>)`](crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileFluentBuilder::set_name):<br>required: **false**<br><p>The name for the authentication profile.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileFluentBuilder::set_description):<br>required: **false**<br><p>The description for the authentication profile.</p><br>
    ///   - [`allowed_ips(impl Into<String>)`](crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileFluentBuilder::allowed_ips) / [`set_allowed_ips(Option<Vec::<String>>)`](crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileFluentBuilder::set_allowed_ips):<br>required: **false**<br><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><br>
    ///   - [`blocked_ips(impl Into<String>)`](crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileFluentBuilder::blocked_ips) / [`set_blocked_ips(Option<Vec::<String>>)`](crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileFluentBuilder::set_blocked_ips):<br>required: **false**<br><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><br>
    ///   - [`periodic_session_duration(i32)`](crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileFluentBuilder::periodic_session_duration) / [`set_periodic_session_duration(Option<i32>)`](crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileFluentBuilder::set_periodic_session_duration):<br>required: **false**<br><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><br>
    /// - On success, responds with [`UpdateAuthenticationProfileOutput`](crate::operation::update_authentication_profile::UpdateAuthenticationProfileOutput)
    /// - On failure, responds with [`SdkError<UpdateAuthenticationProfileError>`](crate::operation::update_authentication_profile::UpdateAuthenticationProfileError)
    pub fn update_authentication_profile(
        &self,
    ) -> crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileFluentBuilder {
        crate::operation::update_authentication_profile::builders::UpdateAuthenticationProfileFluentBuilder::new(self.handle.clone())
    }
}