:doc:`TaxSettings <../../taxsettings>` / Paginator / ListTaxExemptions

*****************
ListTaxExemptions
*****************



.. py:class:: TaxSettings.Paginator.ListTaxExemptions

  ::

    
    paginator = client.get_paginator('list_tax_exemptions')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`TaxSettings.Client.list_tax_exemptions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/taxsettings-2018-05-10/ListTaxExemptions>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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**

      
      ::

        {
            'taxExemptionDetailsMap': {
                'string': {
                    'heritageObtainedDetails': True|False,
                    'heritageObtainedParentEntity': 'string',
                    'heritageObtainedReason': 'string',
                    'taxExemptions': [
                        {
                            'authority': {
                                'country': 'string',
                                'state': 'string'
                            },
                            'effectiveDate': datetime(2015, 1, 1),
                            'expirationDate': datetime(2015, 1, 1),
                            'status': 'None'|'Valid'|'Expired'|'Pending',
                            'systemEffectiveDate': datetime(2015, 1, 1),
                            'taxExemptionType': {
                                'applicableJurisdictions': [
                                    {
                                        'country': 'string',
                                        'state': 'string'
                                    },
                                ],
                                'description': 'string',
                                'displayName': 'string'
                            }
                        },
                    ]
                }
            },
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **taxExemptionDetailsMap** *(dict) --* 

          The tax exemption details map of ``accountId`` and tax exemption details.

          
          

          - *(string) --* 
            

            - *(dict) --* 

              The tax exemption details.

              
              

              - **heritageObtainedDetails** *(boolean) --* 

                The indicator if the tax exemption is inherited from the consolidated billing family management account.

                
              

              - **heritageObtainedParentEntity** *(string) --* 

                The consolidated billing family management account the tax exemption inherited from.

                
              

              - **heritageObtainedReason** *(string) --* 

                The reason of the heritage inheritance.

                
              

              - **taxExemptions** *(list) --* 

                Tax exemptions.

                
                

                - *(dict) --* 

                  The tax exemption.

                  
                  

                  - **authority** *(dict) --* 

                    The address domain associate with tax exemption.

                    
                    

                    - **country** *(string) --* 

                      The country code for the country that the address is in.

                      
                    

                    - **state** *(string) --* 

                      The state that the address is located.

                      
                
                  

                  - **effectiveDate** *(datetime) --* 

                    The tax exemption effective date.

                    
                  

                  - **expirationDate** *(datetime) --* 

                    The tax exemption expiration date.

                    
                  

                  - **status** *(string) --* 

                    The tax exemption status.

                    
                  

                  - **systemEffectiveDate** *(datetime) --* 

                    The tax exemption recording time in the ``TaxSettings`` system.

                    
                  

                  - **taxExemptionType** *(dict) --* 

                    The tax exemption type.

                    
                    

                    - **applicableJurisdictions** *(list) --* 

                      The tax exemption's applicable jurisdictions.

                      
                      

                      - *(dict) --* 

                        The address domain associate with the tax information.

                        
                        

                        - **country** *(string) --* 

                          The country code for the country that the address is in.

                          
                        

                        - **state** *(string) --* 

                          The state that the address is located.

                          
                    
                  
                    

                    - **description** *(string) --* 

                      The tax exemption's type description.

                      
                    

                    - **displayName** *(string) --* 

                      The tax exemption's type display name.

                      
                
              
            
          
      
    
        

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

          A token to resume pagination.

          
    