AddEntityOwnerCommand

Adds the owner of an entity (a domain unit).

Example Syntax

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

import { DataZoneClient, AddEntityOwnerCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, AddEntityOwnerCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // AddEntityOwnerInput
  domainIdentifier: "STRING_VALUE", // required
  entityType: "DOMAIN_UNIT", // required
  entityIdentifier: "STRING_VALUE", // required
  owner: { // OwnerProperties Union: only one key present
    user: { // OwnerUserProperties
      userIdentifier: "STRING_VALUE", // required
    },
    group: { // OwnerGroupProperties
      groupIdentifier: "STRING_VALUE", // required
    },
  },
  clientToken: "STRING_VALUE",
};
const command = new AddEntityOwnerCommand(input);
const response = await client.send(command);
// {};

AddEntityOwnerCommand Input

See AddEntityOwnerCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the domain in which you want to add the entity owner.

entityIdentifier
Required
string | undefined

The ID of the entity to which you want to add an owner.

entityType
Required
DataZoneEntityType | undefined

The type of an entity.

owner
Required
OwnerProperties | undefined

The owner that you want to add to the entity.

clientToken
string | undefined

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

AddEntityOwnerCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

There is a conflict while performing this action.

InternalServerException
server

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

ResourceNotFoundException
client

The specified resource cannot be found.

ServiceQuotaExceededException
client

The request has exceeded the specified service quota.

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.