- 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.
GetDomainUnitCommand
Gets the details of the specified domain unit.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataZoneClient, GetDomainUnitCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetDomainUnitCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetDomainUnitInput
domainIdentifier: "STRING_VALUE", // required
identifier: "STRING_VALUE", // required
};
const command = new GetDomainUnitCommand(input);
const response = await client.send(command);
// { // GetDomainUnitOutput
// id: "STRING_VALUE", // required
// domainId: "STRING_VALUE", // required
// name: "STRING_VALUE", // required
// parentDomainUnitId: "STRING_VALUE",
// description: "STRING_VALUE",
// owners: [ // DomainUnitOwners // required
// { // DomainUnitOwnerProperties Union: only one key present
// user: { // DomainUnitUserProperties
// userId: "STRING_VALUE",
// },
// group: { // DomainUnitGroupProperties
// groupId: "STRING_VALUE",
// },
// },
// ],
// createdAt: new Date("TIMESTAMP"),
// lastUpdatedAt: new Date("TIMESTAMP"),
// createdBy: "STRING_VALUE",
// lastUpdatedBy: "STRING_VALUE",
// };
GetDomainUnitCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
domainIdentifier Required | string | undefined | The ID of the domain where you want to get a domain unit. |
identifier Required | string | undefined | The identifier of the domain unit that you want to get. |
GetDomainUnitCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
domainId Required | string | undefined | The ID of the domain in which the domain unit lives. |
id Required | string | undefined | The ID of the domain unit. |
name Required | string | undefined | The name of the domain unit. |
owners Required | DomainUnitOwnerProperties[] | undefined | The owners of the domain unit. |
createdAt | Date | undefined | The time stamp at which the domain unit was created. |
createdBy | string | undefined | The user who created the domain unit. |
description | string | undefined | The description of the domain unit. |
lastUpdatedAt | Date | undefined | The timestamp at which the domain unit was last updated. |
lastUpdatedBy | string | undefined | The user who last updated the domain unit. |
parentDomainUnitId | string | undefined | The ID of the parent domain unit. |
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. |
ResourceNotFoundException | client | The specified resource cannot be found. |
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. |