DescribeCustomDomainsCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AppRunnerClient, DescribeCustomDomainsCommand } from "@aws-sdk/client-apprunner"; // ES Modules import
// const { AppRunnerClient, DescribeCustomDomainsCommand } = require("@aws-sdk/client-apprunner"); // CommonJS import
const client = new AppRunnerClient(config);
const input = { // DescribeCustomDomainsRequest
  ServiceArn: "STRING_VALUE", // required
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new DescribeCustomDomainsCommand(input);
const response = await client.send(command);
// { // DescribeCustomDomainsResponse
//   DNSTarget: "STRING_VALUE", // required
//   ServiceArn: "STRING_VALUE", // required
//   CustomDomains: [ // CustomDomainList // required
//     { // CustomDomain
//       DomainName: "STRING_VALUE", // required
//       EnableWWWSubdomain: true || false, // required
//       CertificateValidationRecords: [ // CertificateValidationRecordList
//         { // CertificateValidationRecord
//           Name: "STRING_VALUE",
//           Type: "STRING_VALUE",
//           Value: "STRING_VALUE",
//           Status: "PENDING_VALIDATION" || "SUCCESS" || "FAILED",
//         },
//       ],
//       Status: "CREATING" || "CREATE_FAILED" || "ACTIVE" || "DELETING" || "DELETE_FAILED" || "PENDING_CERTIFICATE_DNS_VALIDATION" || "BINDING_CERTIFICATE", // required
//     },
//   ],
//   VpcDNSTargets: [ // VpcDNSTargetList // required
//     { // VpcDNSTarget
//       VpcIngressConnectionArn: "STRING_VALUE",
//       VpcId: "STRING_VALUE",
//       DomainName: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeCustomDomainsCommand Input

See DescribeCustomDomainsCommandInput for more details

Parameter
Type
Description
ServiceArn
Required
string | undefined

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

MaxResults
number | undefined

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.

NextToken
string | undefined

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.

DescribeCustomDomainsCommand Output

See DescribeCustomDomainsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CustomDomains
Required
CustomDomain[] | undefined

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.

DNSTarget
Required
string | undefined

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

ServiceArn
Required
string | undefined

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

VpcDNSTargets
Required
VpcDNSTarget[] | undefined

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

NextToken
string | undefined

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

Throws

Name
Fault
Details
InternalServiceErrorException
server

An unexpected service exception occurred.

InvalidRequestException
client

One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.

ResourceNotFoundException
client

A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.

AppRunnerServiceException
Base exception class for all service exceptions from AppRunner service.