Update Traffic Distribution

connect_update_traffic_distribution

R Documentation

Updates the traffic distribution for a given traffic distribution group

Description

Updates the traffic distribution for a given traffic distribution group.

The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call update_traffic_distribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.

Usage

connect_update_traffic_distribution(Id, TelephonyConfig, SignInConfig,
  AgentConfig)

Arguments

Id

[required] The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

TelephonyConfig

The distribution of traffic between the instance and its replica(s).

SignInConfig

The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).

AgentConfig

The distribution of agents between the instance and its replica(s).

Value

An empty list.

Request syntax

svc$update_traffic_distribution(
  Id = "string",
  TelephonyConfig = list(
    Distributions = list(
      list(
        Region = "string",
        Percentage = 123
      )
    )
  ),
  SignInConfig = list(
    Distributions = list(
      list(
        Region = "string",
        Enabled = TRUE|FALSE
      )
    )
  ),
  AgentConfig = list(
    Distributions = list(
      list(
        Region = "string",
        Percentage = 123
      )
    )
  )
)