Skip to content

This API is in preview release for Connect Customer and is subject to change

Description

This API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support.

Updates the selected authentication profile.

Usage

connect_update_authentication_profile(AuthenticationProfileId,
  InstanceId, Name, Description, AllowedIps, BlockedIps,
  PeriodicSessionDuration, SessionInactivityDuration,
  SessionInactivityHandlingEnabled)

Arguments

  • AuthenticationProfileId

    [required] A unique identifier for the authentication profile.

  • InstanceId

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

  • Name

    The name for the authentication profile.

  • Description

    The description for the authentication profile.

  • AllowedIps

    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.

  • BlockedIps

    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.

  • PeriodicSessionDuration

    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.

  • SessionInactivityDuration

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

  • SessionInactivityHandlingEnabled

    Determines if automatic logout on user inactivity is enabled.

Value

An empty list.

Request syntax

svc$update_authentication_profile(
  AuthenticationProfileId = "string",
  InstanceId = "string",
  Name = "string",
  Description = "string",
  AllowedIps = list(
    "string"
  ),
  BlockedIps = list(
    "string"
  ),
  PeriodicSessionDuration = 123,
  SessionInactivityDuration = 123,
  SessionInactivityHandlingEnabled = TRUE|FALSE
)