Route53 / Client / update_hosted_zone_comment

update_hosted_zone_comment

Route53.Client.update_hosted_zone_comment(**kwargs)

Updates the comment for a specified hosted zone.

See also: AWS API Documentation

Request Syntax

response = client.update_hosted_zone_comment(
    Id='string',
    Comment='string'
)
Parameters:

  • Id (string) –

    [REQUIRED]

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

  • Comment (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'HostedZone': {
        'Id': 'string',
        'Name': 'string',
        'CallerReference': 'string',
        'Config': {
            'Comment': 'string',
            'PrivateZone': True|False
        },
        'ResourceRecordSetCount': 123,
        'LinkedService': {
            'ServicePrincipal': 'string',
            'Description': '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.

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

Exceptions