ListEntityOwnersCommand

Suggest an Edit

Lists the entity (domain units) owners.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataZoneClient, ListEntityOwnersCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListEntityOwnersCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListEntityOwnersInput
  domainIdentifier: "STRING_VALUE", // required
  entityType: "DOMAIN_UNIT", // required
  entityIdentifier: "STRING_VALUE", // required
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListEntityOwnersCommand(input);
const response = await client.send(command);
// { // ListEntityOwnersOutput
//   owners: [ // EntityOwners // required
//     { // OwnerPropertiesOutput Union: only one key present
//       user: { // OwnerUserPropertiesOutput
//         userId: "STRING_VALUE",
//       },
//       group: { // OwnerGroupPropertiesOutput
//         groupId: "STRING_VALUE",
//       },
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListEntityOwnersCommand Input

See ListEntityOwnersCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the domain where you want to list entity owners.

entityIdentifier
Required
string | undefined

The ID of the entity that you want to list.

entityType
Required
DataZoneEntityType | undefined

The type of the entity that you want to list.

maxResults
number | undefined

The maximum number of entities to return in a single call to ListEntityOwners. When the number of entities 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 ListEntityOwners to list the next set of entities.

nextToken
string | undefined

When the number of entities 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 entities, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEntityOwners to list the next set of entities.

ListEntityOwnersCommand Output

See ListEntityOwnersCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
owners
Required
OwnerPropertiesOutput[] | undefined

The owners of the entity.

nextToken
string | undefined

When the number of entities 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 entities, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEntityOwners to list the next set of entities.

Throws

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.