Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

ListDomains

Returns a paginated list of domains from the AWS Control Catalog.

Request Syntax


POST /domains?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results on a page or for an API request call.

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

NextToken

The pagination token that's used to fetch the next set of results.

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Domains": [ 
      { 
         "Arn": "string",
         "CreateTime": number,
         "Description": "string",
         "LastUpdateTime": number,
         "Name": "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.

Domains

The list of domains that the ListDomains API returns.

Type: Array of DomainSummary objects

NextToken

The pagination token that's used to fetch the next set of results.

Type: String

Length Constraints: Minimum length of 0. 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

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Examples

Returning a list of domains

Use this operation to see a paginated list of all domains that are currently available in the AWS Control Catalog.

Sample Request


aws controlcatalog list-domains