ListDomains - Amazon Connect


Returns a list of all the domains for an AWS account that have been created.

Request Syntax

GET /domains?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The maximum number of objects returned per page.

Valid Range: Minimum value of 1. Maximum value of 100.


The pagination token from the previous ListDomain API call.

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Items": [ { "CreatedAt": number, "DomainName": "string", "LastUpdatedAt": number, "Tags": { "string" : "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.


The list of ListDomains instances.

Type: Array of ListDomainItem objects


The pagination token from the previous ListDomains API call.

Type: String

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


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


You do not have sufficient access to perform this action.

HTTP Status Code: 403


The input you provided is invalid.

HTTP Status Code: 400


An internal service error occurred.

HTTP Status Code: 500


The requested resource does not exist, or access was denied.

HTTP Status Code: 404


You exceeded the maximum number of requests.

HTTP Status Code: 429



This example illustrates one usage of ListDomains.

Sample Request

GET /v1/domains?max-results={MaxResults} //First call

Sample Request

GET /v1/domains?next-token={NextToken};max-results={MaxResults} //Subsequent calls

Sample Response

Content-type: application/json { "NextToken": "fcc66dce-8356-4ddb-9f20-911c0EXAMPLE", "Items": [ { "CreatedAt": 1479249799770, "LastUpdatedAt": 1479249799770, "Name": "ExampleDomain1" }, { "CreatedAt": 1479249799770, "LastUpdatedAt": 1479249799770, "Name": "ExampleDomain2" } ] }

See Also

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