Route53GlobalResolver / Client / list_hosted_zone_associations

list_hosted_zone_associations

Route53GlobalResolver.Client.list_hosted_zone_associations(**kwargs)

Lists hosted zone associations with pagination support. Specify a DNS view through the resourceArn parameter to list the hosted zone associations for that DNS view, or omit it to list all hosted zone associations in your Amazon Web Services account.

Warning

Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.

See also: AWS API Documentation

Request Syntax

response = client.list_hosted_zone_associations(
    maxResults=123,
    nextToken='string',
    resourceArn='string'
)
Parameters:
  • maxResults (integer) – The maximum number of results to retrieve in a single call.

  • nextToken (string) – A pagination token used for large sets of results that can’t be returned in a single response.

  • resourceArn (string) – The Amazon Resource Name (ARN) of the DNS view to list hosted zone associations for. This parameter is optional; if you omit it, all hosted zone associations in your Amazon Web Services account are returned.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'hostedZoneAssociations': [
        {
            'id': 'string',
            'resourceArn': 'string',
            'hostedZoneId': 'string',
            'hostedZoneName': 'string',
            'name': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'status': 'CREATING'|'OPERATIONAL'|'DELETING'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      A pagination token used for large sets of results that can’t be returned in a single response. Provide this token in the next call to get the results not returned in this call.

    • hostedZoneAssociations (list) –

      List of the private hosted zone associations.

      • (dict) –

        Summary information about a hosted zone association.

        • id (string) –

          The unique identifier of the hosted zone association.

        • resourceArn (string) –

          The Amazon Resource Name (ARN) of the resource associated with the hosted zone.

        • hostedZoneId (string) –

          The ID of the hosted zone.

        • hostedZoneName (string) –

          The name of the hosted zone.

        • name (string) –

          The name of the hosted zone association.

        • createdAt (datetime) –

          The date and time when the hosted zone association was created.

        • updatedAt (datetime) –

          The date and time when the hosted zone association was last updated.

        • status (string) –

          The current status of the hosted zone association.

Exceptions

  • Route53GlobalResolver.Client.exceptions.InternalServerException

  • Route53GlobalResolver.Client.exceptions.ValidationException

  • Route53GlobalResolver.Client.exceptions.AccessDeniedException

  • Route53GlobalResolver.Client.exceptions.ThrottlingException

  • Route53GlobalResolver.Client.exceptions.ResourceNotFoundException