Connect / Client / update_authentication_profile

update_authentication_profile#

Connect.Client.update_authentication_profile(**kwargs)#

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.

Updates the selected authentication profile.

See also: AWS API Documentation

Request Syntax

response = client.update_authentication_profile(
    AuthenticationProfileId='string',
    InstanceId='string',
    Name='string',
    Description='string',
    AllowedIps=[
        'string',
    ],
    BlockedIps=[
        'string',
    ],
    PeriodicSessionDuration=123
)
Parameters:

  • AuthenticationProfileId (string) –

    [REQUIRED]

    A unique identifier for the authentication profile.

  • InstanceId (string) –

    [REQUIRED]

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

  • Name (string) – The name for the authentication profile.

  • Description (string) – The description for the authentication profile.

  • AllowedIps (list) –

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

    • (string) –

  • BlockedIps (list) –

    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 Amazon Connect Administrator Guide.

    • (string) –

  • PeriodicSessionDuration (integer) – 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 Configure session timeouts in the Amazon Connect Administrator Guide.

Returns:

None

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException