DescribeTrafficSources
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.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- AutoScalingGroupName
-
The name of the Auto Scaling group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: Yes
- MaxRecords
-
The maximum number of items to return with this call. The maximum value is
50.Type: Integer
Required: No
- NextToken
-
The token for the next set of items to return. (You received this token from a previous call.)
Type: String
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: No
- TrafficSourceType
-
The traffic source type that you want to describe.
The following lists the valid values:
-
elbif the traffic source is a Classic Load Balancer. -
elbv2if the traffic source is a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer. -
vpc-latticeif the traffic source is VPC Lattice.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: No
-
Response Elements
The following elements are returned by the service.
- NextToken
-
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
NextTokenvalue when requesting the next set of items. This value is null when there are no more items to return.Type: String
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]* - TrafficSources.member.N
-
Information about the traffic sources.
Type: Array of TrafficSourceState objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidNextToken
-
The
NextTokenvalue is not valid.HTTP Status Code: 400
- ResourceContention
-
You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of DescribeTrafficSources.
Sample Request
https://autoscaling.amazonaws.com/?Action=DescribeTrafficSources
&AutoScalingGroupName=my-asg
&Version=2011-01-01
&AUTHPARAMS Sample Response
<DescribeTrafficSourcesResponse xmlns="https://autoscaling.amazonaws.com/doc/2011-01-01/">
<DescribeTrafficSourcesResult>
<TrafficSources>
<Identifier>arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-0e2f2665eEXAMPLE</Identifier>
<State>InService</State>
<Type>vpc-lattice</Type>
</TrafficSources>
</DescribeTrafficSourcesResult>
<ResponseMetadata>
<RequestId>9351b5ea-b4c0-4a88-b873-c51e4EXAMPLE</RequestId>
</ResponseMetadata>
</DescribeTrafficSourcesResponse> See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
