Describe Traffic Distribution Group

connect_describe_traffic_distribution_group

R Documentation

Gets details and status of a traffic distribution group¶

Description¶

Gets details and status of a traffic distribution group.

Usage¶

connect_describe_traffic_distribution_group(TrafficDistributionGroupId)

Arguments¶

TrafficDistributionGroupId: [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(
  TrafficDistributionGroup = list(
    Id = "string",
    Arn = "string",
    Name = "string",
    Description = "string",
    InstanceArn = "string",
    Status = "CREATION_IN_PROGRESS"|"ACTIVE"|"CREATION_FAILED"|"PENDING_DELETION"|"DELETION_FAILED"|"UPDATE_IN_PROGRESS",
    Tags = list(
      "string"
    ),
    IsDefault = TRUE|FALSE
  )
)

Request syntax¶

svc$describe_traffic_distribution_group(
  TrafficDistributionGroupId = "string"
)