Skip to content

UpdateAuthenticationProfileRequest

Source code in docs_src/capo_connect/types/update_authentication_profile_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
class UpdateAuthenticationProfileRequest(TypedDict, closed=True):
    authentication_profile_id: (
        "capo_connect.types.authentication_profile_id.AuthenticationProfileId"
    )
    """<p>A unique identifier for the authentication profile. </p>"""
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of the Connect Customer 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>"""
    name: NotRequired[
        "capo_connect.types.authentication_profile_name.AuthenticationProfileName"
    ]
    """<p>The name for the authentication profile.</p>"""
    description: NotRequired[
        "capo_connect.types.authentication_profile_description.AuthenticationProfileDescription"
    ]
    """<p>The description for the authentication profile.</p>"""
    allowed_ips: NotRequired["capo_connect.types.ip_cidr_list.IpCidrList"]
    """<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>Connect Customer Administrator Guide</i>.</p>"""
    blocked_ips: NotRequired["capo_connect.types.ip_cidr_list.IpCidrList"]
    """<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>Connect Customer Administrator Guide</i>. </p>"""
    periodic_session_duration: NotRequired[
        "capo_connect.types.access_token_duration.AccessTokenDuration"
    ]
    """<p>The short lived session duration configuration for users logged in to Connect Customer, 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>Connect Customer Administrator Guide</i>. </p>"""
    session_inactivity_duration: NotRequired[
        "capo_connect.types.inactivity_duration.InactivityDuration"
    ]
    """<p>The period, in minutes, before an agent is automatically signed out of the contact center when they go inactive.</p>"""
    session_inactivity_handling_enabled: NotRequired[
        "capo_connect.types.boolean.Boolean"
    ]
    """<p>Determines if automatic logout on user inactivity is enabled.</p>"""

allowed_ips instance-attribute 

allowed_ips: NotRequired[IpCidrList]

A list of IP address range strings that are allowed to access the instance. For more information on how to configure IP addresses, seeConfigure session timeouts in the Connect Customer Administrator Guide.

authentication_profile_id instance-attribute 

authentication_profile_id: AuthenticationProfileId

A unique identifier for the authentication profile.

blocked_ips instance-attribute 

blocked_ips: NotRequired[IpCidrList]

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 Configure IP-based access control in the Connect Customer Administrator Guide.

description instance-attribute 

description: NotRequired[AuthenticationProfileDescription]

The description for the authentication profile.

instance_id instance-attribute 

instance_id: InstanceId

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

name instance-attribute 

name: NotRequired[AuthenticationProfileName]

The name for the authentication profile.

periodic_session_duration instance-attribute 

periodic_session_duration: NotRequired[AccessTokenDuration]

The short lived session duration configuration for users logged in to Connect Customer, 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 Configure session timeouts in the Connect Customer Administrator Guide.

session_inactivity_duration instance-attribute 

session_inactivity_duration: NotRequired[InactivityDuration]

The period, in minutes, before an agent is automatically signed out of the contact center when they go inactive.

session_inactivity_handling_enabled instance-attribute 

session_inactivity_handling_enabled: NotRequired[Boolean]

Determines if automatic logout on user inactivity is enabled.