:doc:`AppSync <../../appsync>` / Paginator / ListDomainNames

***************
ListDomainNames
***************



.. py:class:: AppSync.Paginator.ListDomainNames

  ::

    
    paginator = client.get_paginator('list_domain_names')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`AppSync.Client.list_domain_names`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListDomainNames>`_    


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

      
      ::

        {
            'domainNameConfigs': [
                {
                    'domainName': 'string',
                    'description': 'string',
                    'certificateArn': 'string',
                    'appsyncDomainName': 'string',
                    'hostedZoneId': 'string',
                    'tags': {
                        'string': 'string'
                    },
                    'domainNameArn': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **domainNameConfigs** *(list) --* 

          Lists configurations for multiple domain names.

          
          

          - *(dict) --* 

            Describes a configuration for a custom domain.

            
            

            - **domainName** *(string) --* 

              The domain name.

              
            

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

              A description of the ``DomainName`` configuration.

              
            

            - **certificateArn** *(string) --* 

              The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.

              
            

            - **appsyncDomainName** *(string) --* 

              The domain name that AppSync provides.

              
            

            - **hostedZoneId** *(string) --* 

              The ID of your Amazon Route 53 hosted zone.

              
            

            - **tags** *(dict) --* 

              A map with keys of ``TagKey`` objects and values of ``TagValue`` objects.

              
              

              - *(string) --* 

                The key for the tag.

                
                

                - *(string) --* 

                  The value for the tag.

                  
          
        
            

            - **domainNameArn** *(string) --* 

              The Amazon Resource Name (ARN) of the domain name.

              
        
      
        

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

          A token to resume pagination.

          
    