:doc:`AutoScaling <../../autoscaling>` / Paginator / DescribeTags

************
DescribeTags
************



.. py:class:: AutoScaling.Paginator.DescribeTags

  ::

    
    paginator = client.get_paginator('describe_tags')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`AutoScaling.Client.describe_tags`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeTags>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Filters: list
    :param Filters: 

      One or more filters to scope the tags to return. The maximum number of filters per filter type (for example, ``auto-scaling-group``) is 1000.

      

    
      - *(dict) --* 

        Describes a filter that is used to return a more specific list of results from a describe operation.

         

        If you specify multiple filters, the filters are automatically logically joined with an ``AND``, and the request returns only the results that match all of the specified filters.

         

        For more information, see `Tag Auto Scaling groups and instances <https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html>`__ in the *Amazon EC2 Auto Scaling User Guide*.

        

      
        - **Name** *(string) --* 

          The name of the filter.

           

          The valid values for ``Name`` depend on which API operation you're using with the filter.

           

          `DescribeAutoScalingGroups <https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAutoScalingGroups.html>`__

           

          Valid values for ``Name`` include the following:

           

          
          * ``tag-key`` - Accepts tag keys. The results only include information about the Auto Scaling groups associated with these tag keys.
           
          * ``tag-value`` - Accepts tag values. The results only include information about the Auto Scaling groups associated with these tag values.
           
          * ``tag:<key>`` - Accepts the key/value combination of the tag. Use the tag key in the filter name and the tag value as the filter value. The results only include information about the Auto Scaling groups associated with the specified key/value combination.
          

           

          `DescribeTags <https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeTags.html>`__

           

          Valid values for ``Name`` include the following:

           

          
          * ``auto-scaling-group`` - Accepts the names of Auto Scaling groups. The results only include information about the tags associated with these Auto Scaling groups.
           
          * ``key`` - Accepts tag keys. The results only include information about the tags associated with these tag keys.
           
          * ``value`` - Accepts tag values. The results only include information about the tags associated with these tag values.
           
          * ``propagate-at-launch`` - Accepts a Boolean value, which specifies whether tags propagate to instances at launch. The results only include information about the tags associated with the specified Boolean value.
          

           

          `DescribeScalingActivities <https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeScalingActivities.html>`__

           

          Valid values for ``Name`` include the following:

           

          
          * ``StartTimeLowerBound`` - The earliest scaling activities to return based on the activity start time. Scaling activities with a start time earlier than this value are not included in the results. Only activities started within the last six weeks can be returned regardless of the value specified.
           
          * ``StartTimeUpperBound`` - The latest scaling activities to return based on the activity start time. Scaling activities with a start time later than this value are not included in the results. Only activities started within the last six weeks can be returned regardless of the value specified.
           
          * ``Status`` - The ``StatusCode`` value of the scaling activity. This filter can only be used in combination with the ``AutoScalingGroupName`` parameter. For valid ``StatusCode`` values, see `Activity <https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_Activity.html>`__ in the *Amazon EC2 Auto Scaling API Reference*.
          

          

        
        - **Values** *(list) --* 

          One or more filter values. Filter values are case-sensitive.

           

          If you specify multiple values for a filter, the values are automatically logically joined with an ``OR``, and the request returns all results that match any of the specified values.

           

          **DescribeAutoScalingGroups example:** Specify "tag:environment" for the filter name and "production,development" for the filter values to find Auto Scaling groups with the tag "environment=production" or "environment=development".

           

          **DescribeScalingActivities example:** Specify "Status" for the filter name and "Successful,Failed" for the filter values to find scaling activities with a status of either "Successful" or "Failed".

          

        
          - *(string) --* 

          
      
      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'Tags': [
                {
                    'ResourceId': 'string',
                    'ResourceType': 'string',
                    'Key': 'string',
                    'Value': 'string',
                    'PropagateAtLaunch': True|False
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Tags** *(list) --* 

          One or more tags.

          
          

          - *(dict) --* 

            Describes a tag for an Auto Scaling group.

            
            

            - **ResourceId** *(string) --* 

              The name of the group.

              
            

            - **ResourceType** *(string) --* 

              The type of resource. The only supported value is ``auto-scaling-group``.

              
            

            - **Key** *(string) --* 

              The tag key.

              
            

            - **Value** *(string) --* 

              The tag value.

              
            

            - **PropagateAtLaunch** *(boolean) --* 

              Determines whether the tag is added to new instances as they are launched in the group.

              
        
      
    