Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

DescribeTrafficSourcesCommand

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AutoScalingClient, DescribeTrafficSourcesCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import
// const { AutoScalingClient, DescribeTrafficSourcesCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import
const client = new AutoScalingClient(config);
const input = { // DescribeTrafficSourcesRequest
  AutoScalingGroupName: "STRING_VALUE", // required
  TrafficSourceType: "STRING_VALUE",
  NextToken: "STRING_VALUE",
  MaxRecords: Number("int"),
};
const command = new DescribeTrafficSourcesCommand(input);
const response = await client.send(command);
// { // DescribeTrafficSourcesResponse
//   TrafficSources: [ // TrafficSourceStates
//     { // TrafficSourceState
//       TrafficSource: "STRING_VALUE",
//       State: "STRING_VALUE",
//       Identifier: "STRING_VALUE",
//       Type: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

Example Usage

Loading code editor

DescribeTrafficSourcesCommand Input

See DescribeTrafficSourcesCommandInput for more details

Parameter	Type	Description
`AutoScalingGroupName` Required	`string \| undefined`	The name of the Auto Scaling group.
`MaxRecords`	`number \| undefined`	The maximum number of items to return with this call. The maximum value is `50`.
`NextToken`	`string \| undefined`	The token for the next set of items to return. (You received this token from a previous call.)
`TrafficSourceType`	`string \| undefined`	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.

DescribeTrafficSourcesCommand Output

See DescribeTrafficSourcesCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`NextToken`	`string \| undefined`	This string indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the `NextToken` value when requesting the next set of items. This value is null when there are no more items to return.
`TrafficSources`	`TrafficSourceState[] \| undefined`	Information about the traffic sources.

Throws

Name	Fault	Details
InvalidNextToken	client	The `NextToken` value is not valid.
ResourceContentionFault	server	You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).
AutoScalingServiceException		Base exception class for all service exceptions from AutoScaling service.

Getting Started

References