:doc:`AppSync <../../appsync>` / Client / list_domain_names

*****************
list_domain_names
*****************



.. py:method:: AppSync.Client.list_domain_names(**kwargs)

  

  Lists multiple custom domain names.

  

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


  **Request Syntax**
  ::

    response = client.list_domain_names(
        nextToken='string',
        maxResults=123
    )
    
  :type nextToken: string
  :param nextToken: 

    An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results that you want the request to return.

    

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

        An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

        
  
  **Exceptions**
  
  *   :py:class:`AppSync.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`AppSync.Client.exceptions.BadRequestException`

  
  *   :py:class:`AppSync.Client.exceptions.InternalFailureException`

  