Amplify / Client / get_domain_association

get_domain_association#

Amplify.Client.get_domain_association(**kwargs)#

Returns the domain information for an Amplify app.

See also: AWS API Documentation

Request Syntax

response = client.get_domain_association(
    appId='string',
    domainName='string'
)
Parameters:
  • appId (string) –

    [REQUIRED]

    The unique id for an Amplify app.

  • domainName (string) –

    [REQUIRED]

    The name of the domain.

Return type:

dict

Returns:

Response Syntax

{
    'domainAssociation': {
        'domainAssociationArn': 'string',
        'domainName': 'string',
        'enableAutoSubDomain': True|False,
        'autoSubDomainCreationPatterns': [
            'string',
        ],
        'autoSubDomainIAMRole': 'string',
        'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
        'statusReason': 'string',
        'certificateVerificationDNSRecord': 'string',
        'subDomains': [
            {
                'subDomainSetting': {
                    'prefix': 'string',
                    'branchName': 'string'
                },
                'verified': True|False,
                'dnsRecord': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    The result structure for the get domain association request.

    • domainAssociation (dict) –

      Describes the structure of a domain association, which 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.

Exceptions

  • Amplify.Client.exceptions.BadRequestException

  • Amplify.Client.exceptions.UnauthorizedException

  • Amplify.Client.exceptions.NotFoundException

  • Amplify.Client.exceptions.InternalFailureException