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

******************
update_domain_name
******************



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

  

  Updates a custom ``DomainName`` object.

  

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


  **Request Syntax**
  ::

    response = client.update_domain_name(
        domainName='string',
        description='string'
    )
    
  :type domainName: string
  :param domainName: **[REQUIRED]** 

    The domain name.

    

  
  :type description: string
  :param description: 

    A description of the ``DomainName``.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'domainNameConfig': {
              'domainName': 'string',
              'description': 'string',
              'certificateArn': 'string',
              'appsyncDomainName': 'string',
              'hostedZoneId': 'string',
              'tags': {
                  'string': 'string'
              },
              'domainNameArn': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **domainNameConfig** *(dict) --* 

        The configuration for the ``DomainName``.

        
        

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

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

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

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

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

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

  