AutoScaling / Client / describe_traffic_sources

describe_traffic_sources#

AutoScaling.Client.describe_traffic_sources(**kwargs)#

Reserved for use with Amazon VPC Lattice, which is in preview and subject to change. Do not use this API for production workloads. This API is also subject to change.

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

See also: AWS API Documentation

Request Syntax

response = client.describe_traffic_sources(
    AutoScalingGroupName='string',
    TrafficSourceType='string',
    NextToken='string',
    MaxRecords=123
)
Parameters:

  • AutoScalingGroupName (string) –

    [REQUIRED]

    The name of the Auto Scaling group.

  • TrafficSourceType (string) –

    [REQUIRED]

    The type of traffic source you are describing. Currently, the only valid value is vpc-lattice.

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

  • MaxRecords (integer) – The maximum number of items to return with this call. The maximum value is 50.

Return type:

dict

Returns:

Response Syntax

{
    'TrafficSources': [
        {
            'TrafficSource': 'string',
            'State': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • TrafficSources (list) –

      Information about the traffic sources.

      • (dict) –

        Describes the state of a traffic source.

        • TrafficSource (string) –

          The unique identifier of the traffic source. Currently, this is the Amazon Resource Name (ARN) for a VPC Lattice target group.

        • State (string) –

          The following are the possible states for a VPC Lattice target group:

          • Adding - The Auto Scaling instances are being registered with the target group.

          • Added - All Auto Scaling instances are registered with the target group.

          • InService - At least one Auto Scaling instance passed the VPC_LATTICE health check.

          • Removing - The Auto Scaling instances are being deregistered from the target group. If connection draining is enabled, VPC Lattice waits for in-flight requests to complete before deregistering the instances.

          • Removed - All Auto Scaling instances are deregistered from the target group.

    • NextToken (string) –

      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.

Exceptions

  • AutoScaling.Client.exceptions.ResourceContentionFault

  • AutoScaling.Client.exceptions.InvalidNextToken