Amazon DataZone Datazone Domain Units API
The Datazone Domain Units API from Amazon DataZone — 2 operation(s) for datazone domain units.
The Datazone Domain Units API from Amazon DataZone — 2 operation(s) for datazone domain units.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-datazone:amazon-datazone-domain-units-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Amazon DataZone Domain Units API
version: '2018-05-10'
description: Generated from AWS's published Smithy model for Amazon DataZone. 5 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://datazone.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Domain Units
paths:
/v2/domains/{domainIdentifier}/domain-units:
post:
operationId: CreateDomainUnit
summary: Create Domain Unit
description: Creates a domain unit in Amazon DataZone.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDomainUnitOutput'
'403':
description: AccessDeniedException; AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'402':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'429':
description: ThrottlingException; ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDomainUnitInput'
tags:
- Domain Units
get:
operationId: ListDomainUnitsForParent
summary: List Domain Units For Parent
description: Lists child domain units for the specified parent domain unit.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListDomainUnitsForParentOutput'
'403':
description: AccessDeniedException; AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'429':
description: ThrottlingException; ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListDomainUnitsForParentInput'
tags:
- Domain Units
/v2/domains/{domainIdentifier}/domain-units/{identifier}:
get:
operationId: GetDomainUnit
summary: Get Domain Unit
description: Gets the details of the specified domain unit.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetDomainUnitOutput'
'403':
description: AccessDeniedException; AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException; ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetDomainUnitInput'
tags:
- Domain Units
put:
operationId: UpdateDomainUnit
summary: Update Domain Unit
description: Updates the domain unit.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDomainUnitOutput'
'403':
description: AccessDeniedException; AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException; ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDomainUnitInput'
tags:
- Domain Units
delete:
operationId: DeleteDomainUnit
summary: Delete Domain Unit
description: Deletes a domain unit.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteDomainUnitOutput'
'403':
description: AccessDeniedException; AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException; ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteDomainUnitInput'
tags:
- Domain Units
components:
schemas:
UpdateDomainUnitOutput:
type: object
properties:
id:
type: string
description: The ID of the domain unit that you want to update.
domainId:
type: string
description: The ID of the domain where you want to update the domain unit.
name:
type: string
description: The name of the domain unit that you want to update.
owners:
type: array
items:
$ref: '#/components/schemas/DomainUnitOwnerProperties'
description: The owners of the domain unit that you want to update.
description:
type: string
description: The description of the domain unit that you want to update.
parentDomainUnitId:
type: string
description: The ID of the parent domain unit.
createdAt:
type: string
format: date-time
description: The time stamp at which the domain unit that you want to update was created.
lastUpdatedAt:
type: string
format: date-time
description: The timestamp at which the domain unit was last updated.
createdBy:
type: string
description: The user who created the domain unit that you want to update.
lastUpdatedBy:
type: string
description: The user who last updated the domain unit.
required:
- id
- domainId
- name
- owners
CreateDomainUnitOutput:
type: object
properties:
id:
type: string
description: The ID of the domain unit.
domainId:
type: string
description: The ID of the domain where the domain unit was created.
name:
type: string
description: The name of the domain unit.
parentDomainUnitId:
type: string
description: The ID of the parent domain unit.
description:
type: string
description: The description of the domain unit.
owners:
type: array
items:
$ref: '#/components/schemas/DomainUnitOwnerProperties'
description: The owners of the domain unit.
ancestorDomainUnitIds:
type: array
items:
type: string
description: The IDs of the ancestor domain units.
createdAt:
type: string
format: date-time
description: The timestamp at which the domain unit was created.
createdBy:
type: string
description: The user who created the domain unit.
required:
- id
- domainId
- name
- owners
- ancestorDomainUnitIds
ValidationException:
type: object
properties:
message:
type: string
required:
- message
ListDomainUnitsForParentOutput:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DomainUnitSummary'
description: The results returned by this action.
nextToken:
type: string
description: When the number of domain units 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 domain units, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set of domain units.
required:
- items
DeleteDomainUnitInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the domain where you want to delete a domain unit.
identifier:
type: string
description: The ID of the domain unit that you want to delete.
required:
- domainIdentifier
- identifier
DomainUnitGroupProperties:
type: object
properties:
groupId:
type: string
description: The ID of the domain unit group.
DomainUnitOwnerProperties:
type: object
properties:
user:
$ref: '#/components/schemas/DomainUnitUserProperties'
group:
$ref: '#/components/schemas/DomainUnitGroupProperties'
description: Exactly one member is set.
GetDomainUnitInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the domain where you want to get a domain unit.
identifier:
type: string
description: The identifier of the domain unit that you want to get.
required:
- domainIdentifier
- identifier
DomainUnitSummary:
type: object
properties:
name:
type: string
description: The name of the domain unit summary.
id:
type: string
description: The ID of the domain unit summary.
required:
- name
- id
UpdateDomainUnitInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the domain where you want to update a domain unit.
identifier:
type: string
description: The ID of the domain unit that you want to update.
description:
type: string
description: The description of the domain unit that you want to update.
name:
type: string
description: The name of the domain unit that you want to update.
required:
- domainIdentifier
- identifier
UnauthorizedException:
type: object
properties:
message:
type: string
required:
- message
GetDomainUnitOutput:
type: object
properties:
id:
type: string
description: The ID of the domain unit.
domainId:
type: string
description: The ID of the domain in which the domain unit lives.
name:
type: string
description: The name of the domain unit.
parentDomainUnitId:
type: string
description: The ID of the parent domain unit.
description:
type: string
description: The description of the domain unit.
owners:
type: array
items:
$ref: '#/components/schemas/DomainUnitOwnerProperties'
description: The owners of the domain unit.
createdAt:
type: string
format: date-time
description: The time stamp at which the domain unit was created.
lastUpdatedAt:
type: string
format: date-time
description: The timestamp at which the domain unit was last updated.
createdBy:
type: string
description: The user who created the domain unit.
lastUpdatedBy:
type: string
description: The user who last updated the domain unit.
required:
- id
- domainId
- name
- owners
ThrottlingException:
type: object
properties:
message:
type: string
required:
- message
DeleteDomainUnitOutput:
type: object
properties: {}
AccessDeniedException:
type: object
properties:
message:
type: string
required:
- message
ListDomainUnitsForParentInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the domain in which you want to list domain units for a parent domain unit.
parentDomainUnitIdentifier:
type: string
description: The ID of the parent domain unit.
maxResults:
type: integer
description: The maximum number of domain units to return in a single call to ListDomainUnitsForParent. When the number of domain units 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 ListDomainUnitsForParent to list the next set of domain units.
nextToken:
type: string
description: When the number of domain units 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 domain units, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set of domain units.
required:
- domainIdentifier
- parentDomainUnitIdentifier
InternalServerException:
type: object
properties:
message:
type: string
required:
- message
ResourceNotFoundException:
type: object
properties:
message:
type: string
required:
- message
ServiceQuotaExceededException:
type: object
properties:
message:
type: string
required:
- message
CreateDomainUnitInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the domain where you want to crate a domain unit.
name:
type: string
description: The name of the domain unit.
parentDomainUnitIdentifier:
type: string
description: The ID of the parent domain unit.
description:
type: string
description: The description of the domain unit.
clientToken:
type: string
description: A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
required:
- domainIdentifier
- name
- parentDomainUnitIdentifier
ConflictException:
type: object
properties:
message:
type: string
required:
- message
DomainUnitUserProperties:
type: object
properties:
userId:
type: string
description: The ID of teh domain unit user.
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: datazone
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/datazone/service/2018-05-10/datazone-2018-05-10.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)