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

ListDomainUnitsForParent

Lists child domain units for the specified parent domain unit.

Request Syntax


GET /v2/domains/domainIdentifier/domain-units?maxResults=maxResults&nextToken=nextToken&parentDomainUnitIdentifier=parentDomainUnitIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the domain in which you want to list domain units for a parent domain unit.

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Required: Yes

maxResults

The maximum number of domain units to return in a single call to ListDomainUnitsForParent. When the number of domain units to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDomainUnitsForParent to list the next set of domain units.

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

nextToken

When the number of domain units is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of domain units, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set of domain units.

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

parentDomainUnitIdentifier

The ID of the parent domain unit.

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

Pattern: ^[a-z0-9_\-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "id": "string",
         "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.

items

The results returned by this action.

Type: Array of DomainUnitSummary objects

nextToken

Type: String

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

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

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400