Get Traffic Distribution

connect_get_traffic_distribution

R Documentation

Retrieves the current traffic distribution for a given traffic distribution group

Description

Retrieves the current traffic distribution for a given traffic distribution group.

Usage

connect_get_traffic_distribution(Id)

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.

Value

A list with the following syntax:

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

Request syntax

svc$get_traffic_distribution(
  Id = "string"
)