- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListDomainUnitsForParentCommand
Lists child domain units for the specified parent domain unit.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataZoneClient, ListDomainUnitsForParentCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListDomainUnitsForParentCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListDomainUnitsForParentInput
domainIdentifier: "STRING_VALUE", // required
parentDomainUnitIdentifier: "STRING_VALUE", // required
maxResults: Number("int"),
nextToken: "STRING_VALUE",
};
const command = new ListDomainUnitsForParentCommand(input);
const response = await client.send(command);
// { // ListDomainUnitsForParentOutput
// items: [ // DomainUnitSummaries // required
// { // DomainUnitSummary
// name: "STRING_VALUE", // required
// id: "STRING_VALUE", // required
// },
// ],
// nextToken: "STRING_VALUE",
// };
ListDomainUnitsForParentCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
domainIdentifier Required | string | undefined | The ID of the domain in which you want to list domain units for a parent domain unit. |
parentDomainUnitIdentifier Required | string | undefined | The ID of the parent domain unit. |
maxResults | number | undefined | 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. |
nextToken | string | undefined | 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. |
ListDomainUnitsForParentCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
items Required | DomainUnitSummary[] | undefined | The results returned by this action. |
nextToken | string | undefined | 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. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
InternalServerException | server | The request has failed because of an unknown error, exception or failure. |
ThrottlingException | client | The request was denied due to request throttling. |
ValidationException | client | The input fails to satisfy the constraints specified by the Amazon Web Services service. |
UnauthorizedException | client | You do not have permission to perform this action. |
DataZoneServiceException | Base exception class for all service exceptions from DataZone service. |