GetDomainUnit
Gets the details of the specified domain unit.
Request Syntax
GET /v2/domains/domainIdentifier/domain-units/identifier HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- domainIdentifier
-
The ID of the domain where you want to get a domain unit.
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$Required: Yes
- identifier
-
The identifier of the domain unit that you want to get.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[a-z0-9_\-]+$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"createdAt": number,
"createdBy": "string",
"description": "string",
"domainId": "string",
"id": "string",
"lastUpdatedAt": number,
"lastUpdatedBy": "string",
"name": "string",
"owners": [
{ ... }
],
"parentDomainUnitId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- createdAt
-
The time stamp at which the domain unit was created.
Type: Timestamp
- createdBy
-
The user who created the domain unit.
Type: String
- description
-
The description of the domain unit.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
- domainId
-
The ID of the domain in which the domain unit lives.
Type: String
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$ - id
-
The ID of the domain unit.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[a-z0-9_\-]+$ - lastUpdatedAt
-
The timestamp at which the domain unit was last updated.
Type: Timestamp
- lastUpdatedBy
-
The user who last updated the domain unit.
Type: String
- name
-
The name of the domain unit.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[\w -]+$ - owners
-
The owners of the domain unit.
Type: Array of DomainUnitOwnerProperties objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
- parentDomainUnitId
-
The ID of the parent domain unit.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[a-z0-9_\-]+$
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
- 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
- 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:
