ListDomains - Amazon Connect Customer Profiles

ListDomains

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.

MaxResults

The maximum number of objects returned per page.

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

NextToken

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.

Items

The list of ListDomains instances.

Type: Array of ListDomainItem objects

NextToken

The pagination token from the previous ListDomains API call.

Type: String

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

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

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

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429

Examples

Example

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: