AppRunner / Client / describe_custom_domains

describe_custom_domains#

AppRunner.Client.describe_custom_domains(**kwargs)#

Return a description of custom domain names that are associated with an App Runner service.

See also: AWS API Documentation

Request Syntax

response = client.describe_custom_domains(
    ServiceArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • ServiceArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.

  • NextToken (string) –

    A token from a previous result page. It’s used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

    If you don’t specify NextToken, the request retrieves the first result page.

  • MaxResults (integer) –

    The maximum number of results that each response (result page) can include. It’s used for a paginated request.

    If you don’t specify MaxResults, the request retrieves all available results in a single response.

Return type:

dict

Returns:

Response Syntax

{
    'DNSTarget': 'string',
    'ServiceArn': 'string',
    'CustomDomains': [
        {
            'DomainName': 'string',
            'EnableWWWSubdomain': True|False,
            'CertificateValidationRecords': [
                {
                    'Name': 'string',
                    'Type': 'string',
                    'Value': 'string',
                    'Status': 'PENDING_VALIDATION'|'SUCCESS'|'FAILED'
                },
            ],
            'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETE_FAILED'|'PENDING_CERTIFICATE_DNS_VALIDATION'|'BINDING_CERTIFICATE'
        },
    ],
    'VpcDNSTargets': [
        {
            'VpcIngressConnectionArn': 'string',
            'VpcId': 'string',
            'DomainName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • DNSTarget (string) –

      The App Runner subdomain of the App Runner service. The associated custom domain names are mapped to this target name.

    • ServiceArn (string) –

      The Amazon Resource Name (ARN) of the App Runner service whose associated custom domain names you want to describe.

    • CustomDomains (list) –

      A list of descriptions of custom domain names that are associated with the service. In a paginated request, the request returns up to MaxResults records per call.

      • (dict) –

        Describes a custom domain that’s associated with an App Runner service.

        • DomainName (string) –

          An associated custom domain endpoint. It can be a root domain (for example, example.com), a subdomain (for example, login.example.com or admin.login.example.com), or a wildcard (for example, *.example.com).

        • EnableWWWSubdomain (boolean) –

          When true, the subdomain www.DomainName is associated with the App Runner service in addition to the base domain.

        • CertificateValidationRecords (list) –

          A list of certificate CNAME records that’s used for this domain name.

          • (dict) –

            Describes a certificate CNAME record to add to your DNS. For more information, see AssociateCustomDomain.

            • Name (string) –

              The certificate CNAME record name.

            • Type (string) –

              The record type, always CNAME.

            • Value (string) –

              The certificate CNAME record value.

            • Status (string) –

              The current state of the certificate CNAME record validation. It should change to SUCCESS after App Runner completes validation with your DNS.

        • Status (string) –

          The current state of the domain name association.

    • VpcDNSTargets (list) –

      DNS Target records for the custom domains of this Amazon VPC.

      • (dict) –

        DNS Target record for a custom domain of this Amazon VPC.

        • VpcIngressConnectionArn (string) –

          The Amazon Resource Name (ARN) of the VPC Ingress Connection that is associated with your service.

        • VpcId (string) –

          The ID of the Amazon VPC that is associated with the custom domain name of the target DNS.

        • DomainName (string) –

          The domain name of your target DNS that is associated with the Amazon VPC.

    • NextToken (string) –

      The token that you can pass in a subsequent request to get the next result page. It’s returned in a paginated request.

Exceptions