Amplify / Client / list_domain_associations



Returns the domain associations for an Amplify app.

See also: AWS API Documentation

Request Syntax

response = client.list_domain_associations(
  • appId (string) –


    The unique ID for an Amplify app.

  • nextToken (string) – A pagination token. Set to null to start listing apps from the start. If non-null, a pagination token is returned in a result. Pass its value in here to list more projects.

  • maxResults (integer) – The maximum number of records to list in a single 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 pagination token. If non-null, a pagination token is returned in a result. Pass its value in another request to retrieve more entries.


  • Amplify.Client.exceptions.BadRequestException

  • Amplify.Client.exceptions.UnauthorizedException

  • Amplify.Client.exceptions.InternalFailureException