:doc:`ECS <../../ecs>` / Paginator / ListAttributes

**************
ListAttributes
**************



.. py:class:: ECS.Paginator.ListAttributes

  ::

    
    paginator = client.get_paginator('list_attributes')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`ECS.Client.list_attributes`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListAttributes>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          cluster='string',
          targetType='container-instance',
          attributeName='string',
          attributeValue='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type cluster: string
    :param cluster: 

      The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

      

    
    :type targetType: string
    :param targetType: **[REQUIRED]** 

      The type of the target to list attributes with.

      

    
    :type attributeName: string
    :param attributeName: 

      The name of the attribute to filter the results with.

      

    
    :type attributeValue: string
    :param attributeValue: 

      The value of the attribute to filter results with. You must also specify an attribute name to use this parameter.

      

    
    :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**

      
      ::

        {
            'attributes': [
                {
                    'name': 'string',
                    'value': 'string',
                    'targetType': 'container-instance',
                    'targetId': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **attributes** *(list) --* 

          A list of attribute objects that meet the criteria of the request.

          
          

          - *(dict) --* 

            An attribute is a name-value pair that's associated with an Amazon ECS object. Use attributes to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see `Attributes <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes>`__ in the *Amazon Elastic Container Service Developer Guide*.

            
            

            - **name** *(string) --* 

              The name of the attribute. The ``name`` must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (\), or periods (.).

              
            

            - **value** *(string) --* 

              The value of the attribute. The ``value`` must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (\), colons (:), or spaces. The value can't start or end with a space.

              
            

            - **targetType** *(string) --* 

              The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.

              
            

            - **targetId** *(string) --* 

              The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    