Amplify / Paginator / ListDomainAssociations


class Amplify.Paginator.ListDomainAssociations#
paginator = client.get_paginator('list_domain_associations')

Creates an iterator that will paginate through responses from Amplify.Client.list_domain_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • appId (string) –


    The unique ID for an Amplify app.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'domainAssociations': [
            'domainAssociationArn': 'string',
            'domainName': 'string',
            'enableAutoSubDomain': True|False,
            'autoSubDomainCreationPatterns': [
            'autoSubDomainIAMRole': 'string',
            'statusReason': 'string',
            'certificateVerificationDNSRecord': 'string',
            'subDomains': [
                    'subDomainSetting': {
                        'prefix': 'string',
                        'branchName': 'string'
                    'verified': True|False,
                    'dnsRecord': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    The result structure for the list domain association request.

    • domainAssociations (list) –

      A list of domain associations.

      • (dict) –

        Describes a domain association that associates a custom domain with an Amplify app.

        • domainAssociationArn (string) –

          The Amazon Resource Name (ARN) for the domain association.

        • domainName (string) –

          The name of the domain.

        • enableAutoSubDomain (boolean) –

          Enables the automated creation of subdomains for branches.

        • autoSubDomainCreationPatterns (list) –

          Sets branch patterns for automatic subdomain creation.

          • (string) –

        • autoSubDomainIAMRole (string) –

          The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

        • domainStatus (string) –

          The current status of the domain association.

        • statusReason (string) –

          The reason for the current status of the domain association.

        • certificateVerificationDNSRecord (string) –

          The DNS record for certificate verification.

        • subDomains (list) –

          The subdomains for the domain association.

          • (dict) –

            The subdomain for the domain association.

            • subDomainSetting (dict) –

              Describes the settings for the subdomain.

              • prefix (string) –

                The prefix setting for the subdomain.

              • branchName (string) –

                The branch name setting for the subdomain.

            • verified (boolean) –

              The verified status of the subdomain

            • dnsRecord (string) –

              The DNS record for the subdomain.

    • NextToken (string) –

      A token to resume pagination.