:doc:`ServiceCatalog <../../servicecatalog>` / Paginator / ListTagOptions

**************
ListTagOptions
**************



.. py:class:: ServiceCatalog.Paginator.ListTagOptions

  ::

    
    paginator = client.get_paginator('list_tag_options')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`ServiceCatalog.Client.list_tag_options`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ListTagOptions>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Filters={
              'Key': 'string',
              'Value': 'string',
              'Active': True|False
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Filters: dict
    :param Filters: 

      The search filters. If no search filters are specified, the output includes all TagOptions.

      

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

        The TagOption key.

        

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

        The TagOption value.

        

      
      - **Active** *(boolean) --* 

        The active state.

        

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

      
      ::

        {
            'TagOptionDetails': [
                {
                    'Key': 'string',
                    'Value': 'string',
                    'Active': True|False,
                    'Id': 'string',
                    'Owner': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **TagOptionDetails** *(list) --* 

          Information about the TagOptions.

          
          

          - *(dict) --* 

            Information about a TagOption.

            
            

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

              The TagOption key.

              
            

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

              The TagOption value.

              
            

            - **Active** *(boolean) --* 

              The TagOption active state.

              
            

            - **Id** *(string) --* 

              The TagOption identifier.

              
            

            - **Owner** *(string) --* 

              The Amazon Web Services account Id of the owner account that created the TagOption.

              
        
      
        

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

          A token to resume pagination.

          
    