ListDomainNames - AWS AppSync

ListDomainNames

Lists multiple custom domain names.

Request Syntax

GET /v1/domainnames?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results that you want the request to return.

Valid Range: Minimum value of 0. Maximum value of 25.

nextToken

The API token.

Length Constraints: Minimum length of 1. Maximum length of 65536.

Pattern: [\\S]+

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "domainNameConfigs": [ { "appsyncDomainName": "string", "certificateArn": "string", "description": "string", "domainName": "string", "hostedZoneId": "string" } ], "nextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

domainNameConfigs

Lists configurations for multiple domain names.

Type: Array of DomainNameConfig objects

nextToken

The API token.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 65536.

Pattern: [\\S]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to perform this operation on this resource.

HTTP Status Code: 403

BadRequestException

The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

HTTP Status Code: 400

InternalFailureException

An internal AWS AppSync error occurred. Try your request again.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: