Describe Traffic Sources

autoscaling_describe_traffic_sources

R Documentation

Gets information about the traffic sources for the specified Auto Scaling group¶

Description¶

Gets information about the traffic sources for the specified Auto Scaling group.

You can optionally provide a traffic source type. If you provide a traffic source type, then the results only include that traffic source type.

If you do not provide a traffic source type, then the results include all the traffic sources for the specified Auto Scaling group.

Usage¶

autoscaling_describe_traffic_sources(AutoScalingGroupName,
  TrafficSourceType, NextToken, MaxRecords)

Arguments¶

AutoScalingGroupName

[required] The name of the Auto Scaling group.

TrafficSourceType

The traffic source type that you want to describe.

The following lists the valid values:

elb if the traffic source is a Classic Load Balancer.
elbv2 if the traffic source is a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer.
vpc-lattice if the traffic source is VPC Lattice.

NextToken

The token for the next set of items to return. (You received this token from a previous call.)

MaxRecords

The maximum number of items to return with this call. The maximum value is 50.

Value¶

A list with the following syntax:

list(
  TrafficSources = list(
    list(
      TrafficSource = "string",
      State = "string",
      Identifier = "string",
      Type = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_traffic_sources(
  AutoScalingGroupName = "string",
  TrafficSourceType = "string",
  NextToken = "string",
  MaxRecords = 123
)

Examples¶

## Not run: 
# This example describes the target groups attached to the specified Auto
# Scaling group.
svc$describe_traffic_sources(
  AutoScalingGroupName = "my-auto-scaling-group"
)

## End(Not run)