:doc:`Route53 <../../route53>` / Client / update_hosted_zone_comment

**************************
update_hosted_zone_comment
**************************



.. py:method:: Route53.Client.update_hosted_zone_comment(**kwargs)

  

  Updates the comment for a specified hosted zone.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/UpdateHostedZoneComment>`_  


  **Request Syntax**
  ::

    response = client.update_hosted_zone_comment(
        Id='string',
        Comment='string'
    )
    
  :type Id: string
  :param Id: **[REQUIRED]** 

    The ID for the hosted zone that you want to update the comment for.

    

  
  :type Comment: string
  :param Comment: 

    The new comment for the hosted zone. If you don't specify a value for ``Comment``, Amazon Route 53 deletes the existing value of the ``Comment`` element, if any.

    

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

    
    ::

      {
          'HostedZone': {
              'Id': 'string',
              'Name': 'string',
              'CallerReference': 'string',
              'Config': {
                  'Comment': 'string',
                  'PrivateZone': True|False
              },
              'ResourceRecordSetCount': 123,
              'LinkedService': {
                  'ServicePrincipal': 'string',
                  'Description': 'string'
              },
              'Features': {
                  'AcceleratedRecoveryStatus': 'ENABLING'|'ENABLE_FAILED'|'ENABLING_HOSTED_ZONE_LOCKED'|'ENABLED'|'DISABLING'|'DISABLE_FAILED'|'DISABLED'|'DISABLING_HOSTED_ZONE_LOCKED',
                  'FailureReasons': {
                      'AcceleratedRecovery': 'string'
                  }
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      A complex type that contains the response to the ``UpdateHostedZoneComment`` request.

      
      

      - **HostedZone** *(dict) --* 

        A complex type that contains the response to the ``UpdateHostedZoneComment`` request.

        
        

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

          The ID that Amazon Route 53 assigned to the hosted zone when you created it.

          
        

        - **Name** *(string) --* 

          The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.

           

          For information about how to specify characters other than ``a-z``, ``0-9``, and ``-`` (hyphen) and how to specify internationalized domain names, see `CreateHostedZone <https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateHostedZone.html>`__.

          
        

        - **CallerReference** *(string) --* 

          The value that you specified for ``CallerReference`` when you created the hosted zone.

          
        

        - **Config** *(dict) --* 

          A complex type that includes the ``Comment`` and ``PrivateZone`` elements. If you omitted the ``HostedZoneConfig`` and ``Comment`` elements from the request, the ``Config`` and ``Comment`` elements don't appear in the response.

          
          

          - **Comment** *(string) --* 

            Any comments that you want to include about the hosted zone.

            
          

          - **PrivateZone** *(boolean) --* 

            A value that indicates whether this is a private hosted zone.

            
      
        

        - **ResourceRecordSetCount** *(integer) --* 

          The number of resource record sets in the hosted zone.

          
        

        - **LinkedService** *(dict) --* 

          If the hosted zone was created by another service, the service that created the hosted zone. When a hosted zone is created by another service, you can't edit or delete it using Route 53.

          
          

          - **ServicePrincipal** *(string) --* 

            If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.

            
          

          - **Description** *(string) --* 

            If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.

            
      
        

        - **Features** *(dict) --* 

          The features configuration for the hosted zone, including accelerated recovery settings and status information.

          
          

          - **AcceleratedRecoveryStatus** *(string) --* 

            The current status of accelerated recovery for the hosted zone.

            
          

          - **FailureReasons** *(dict) --* 

            Information about any failures that occurred when attempting to enable or configure features for the hosted zone.

            
            

            - **AcceleratedRecovery** *(string) --* 

              The reason why accelerated recovery failed to be enabled or disabled for the hosted zone, if applicable.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`Route53.Client.exceptions.NoSuchHostedZone`

  
  *   :py:class:`Route53.Client.exceptions.InvalidInput`

  
  *   :py:class:`Route53.Client.exceptions.PriorRequestNotComplete`

  