AddEntityOwner
Adds the owner of an entity (a domain unit).
Request Syntax
POST /v2/domains/domainIdentifier
/entities/entityType
/entityIdentifier
/addOwner HTTP/1.1
Content-type: application/json
{
"clientToken": "string
",
"owner": { ... }
}
URI Request Parameters
The request uses the following URI parameters.
- domainIdentifier
-
The ID of the domain in which you want to add the entity owner.
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$
Required: Yes
- entityIdentifier
-
The ID of the entity to which you want to add an owner.
Required: Yes
- entityType
-
The type of an entity.
Valid Values:
DOMAIN_UNIT
Required: Yes
Request Body
The request accepts the following data in JSON format.
- clientToken
-
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[\x21-\x7E]+$
Required: No
- owner
-
The owner that you want to add to the entity.
Type: OwnerProperties object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
Response Syntax
HTTP/1.1 201
Response Elements
If the action is successful, the service sends back an HTTP 201 response with an empty HTTP body.
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
- ConflictException
-
There is a conflict while performing this action.
HTTP Status Code: 409
- InternalServerException
-
The request has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource cannot be found.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The request has exceeded the specified service quota.
HTTP Status Code: 402
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: