Amazon DataZone Datazone Glossaries API
The Datazone Glossaries API from Amazon DataZone — 2 operation(s) for datazone glossaries.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-datazone:amazon-datazone-glossaries-api"
All apis
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.
Get an API 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 Specification
openapi: 3.2.0
info:
title: Amazon DataZone Glossaries API
version: '2018-05-10'
description: Generated from AWS's published Smithy model for Amazon DataZone. 4 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: Glossaries
paths:
/v2/domains/{domainIdentifier}/glossaries:
post:
operationId: CreateGlossary
summary: Create Glossary
description: 'Creates an Amazon DataZone business glossary. Specifies that this is a create glossary policy. A glossary serves as the central repository for business terminology and definitions within an organization. It helps establish and maintain a common language across different departments and teams, reducing miscommunication and ensuring consistent interpretation of business concepts. Glossaries can include hierarchical relationships between terms, cross-references, and links to actual data assets, making them invaluable for both business users and technical teams trying to understand and use data correctly. Prerequisites: Domain must exist and be in an active state. Owning project must exist and be accessible by the caller. The glossary name must be unique within the domain.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateGlossaryOutput'
'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/CreateGlossaryInput'
tags:
- Glossaries
/v2/domains/{domainIdentifier}/glossaries/{identifier}:
get:
operationId: GetGlossary
summary: Get Glossary
description: 'Gets a business glossary in Amazon DataZone. Prerequisites: The specified glossary ID must exist and be associated with the given domain. The caller must have the datazone:GetGlossary permission on the domain.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetGlossaryOutput'
'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/GetGlossaryInput'
tags:
- Glossaries
patch:
operationId: UpdateGlossary
summary: Update Glossary
description: 'Updates the business glossary in Amazon DataZone. Prerequisites: The glossary must exist in the given domain. The caller must have the datazone:UpdateGlossary permission to update it. When updating the name, the new name must be unique within the domain. The glossary must not be deleted or in a terminal state.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateGlossaryOutput'
'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/UpdateGlossaryInput'
tags:
- Glossaries
delete:
operationId: DeleteGlossary
summary: Delete Glossary
description: 'Deletes a business glossary in Amazon DataZone. Prerequisites: The glossary must be in DISABLED state. The glossary must not have any glossary terms associated with it. The glossary must exist in the specified domain. The caller must have the datazone:DeleteGlossary permission in the domain and glossary. Glossary should not be linked to any active metadata forms.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteGlossaryOutput'
'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/DeleteGlossaryInput'
tags:
- Glossaries
components:
schemas:
CreateGlossaryOutput:
type: object
properties:
domainId:
type: string
description: The ID of the Amazon DataZone domain in which this business glossary is created.
id:
type: string
description: The ID of this business glossary.
name:
type: string
description: The name of this business glossary.
owningProjectId:
type: string
description: The ID of the project that currently owns this business glossary.
description:
type: string
description: The description of this business glossary.
status:
type: string
enum:
- DISABLED
- ENABLED
description: The status of this business glossary.
usageRestrictions:
type: array
items:
type: string
enum:
- ASSET_GOVERNED_TERMS
description: The usage restriction of the restricted glossary.
required:
- domainId
- id
- name
- owningProjectId
DeleteGlossaryOutput:
type: object
properties: {}
ValidationException:
type: object
properties:
message:
type: string
required:
- message
UpdateGlossaryOutput:
type: object
properties:
domainId:
type: string
description: The identifier of the Amazon DataZone domain in which a business glossary is to be updated.
id:
type: string
description: The identifier of the business glossary that is to be updated.
name:
type: string
description: The name to be updated as part of the UpdateGlossary action.
owningProjectId:
type: string
description: The identifier of the project in which to update a business glossary.
description:
type: string
description: The description to be updated as part of the UpdateGlossary action.
status:
type: string
enum:
- DISABLED
- ENABLED
description: The status to be updated as part of the UpdateGlossary action.
usageRestrictions:
type: array
items:
type: string
enum:
- ASSET_GOVERNED_TERMS
description: The usage restriction of the restricted glossary.
required:
- domainId
- id
- name
- owningProjectId
GetGlossaryOutput:
type: object
properties:
domainId:
type: string
description: The ID of the Amazon DataZone domain in which this business glossary exists.
id:
type: string
description: The ID of the business glossary.
owningProjectId:
type: string
description: The ID of the project that owns this business glossary.
name:
type: string
description: The name of the business glossary.
description:
type: string
description: The description of the business glossary.
status:
type: string
enum:
- DISABLED
- ENABLED
description: The status of the business glossary.
createdAt:
type: string
format: date-time
description: The timestamp of when this business glossary was created.
createdBy:
type: string
description: The Amazon DataZone user who created this business glossary.
updatedAt:
type: string
format: date-time
description: The timestamp of when the business glossary was updated.
updatedBy:
type: string
description: The Amazon DataZone user who updated the business glossary.
usageRestrictions:
type: array
items:
type: string
enum:
- ASSET_GOVERNED_TERMS
description: The usage restriction of the restricted glossary.
required:
- domainId
- id
- owningProjectId
- name
- status
UnauthorizedException:
type: object
properties:
message:
type: string
required:
- message
CreateGlossaryInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the Amazon DataZone domain in which this business glossary is created.
name:
type: string
description: The name of this business glossary.
owningProjectIdentifier:
type: string
description: The ID of the project that currently owns business glossary.
description:
type: string
description: The description of this business glossary.
status:
type: string
enum:
- DISABLED
- ENABLED
description: The status of this business glossary.
usageRestrictions:
type: array
items:
type: string
enum:
- ASSET_GOVERNED_TERMS
description: The usage restriction of the restricted glossary.
clientToken:
type: string
description: A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
required:
- domainIdentifier
- name
- owningProjectIdentifier
InternalServerException:
type: object
properties:
message:
type: string
required:
- message
UpdateGlossaryInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon DataZone domain in which a business glossary is to be updated.
identifier:
type: string
description: The identifier of the business glossary to be updated.
name:
type: string
description: The name to be updated as part of the UpdateGlossary action.
description:
type: string
description: The description to be updated as part of the UpdateGlossary action.
status:
type: string
enum:
- DISABLED
- ENABLED
description: The status to be updated as part of the UpdateGlossary action.
clientToken:
type: string
description: A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
required:
- domainIdentifier
- identifier
ResourceNotFoundException:
type: object
properties:
message:
type: string
required:
- message
ServiceQuotaExceededException:
type: object
properties:
message:
type: string
required:
- message
ThrottlingException:
type: object
properties:
message:
type: string
required:
- message
ConflictException:
type: object
properties:
message:
type: string
required:
- message
GetGlossaryInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the Amazon DataZone domain in which this business glossary exists.
identifier:
type: string
description: The ID of the business glossary.
required:
- domainIdentifier
- identifier
AccessDeniedException:
type: object
properties:
message:
type: string
required:
- message
DeleteGlossaryInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the Amazon DataZone domain in which the business glossary is deleted.
identifier:
type: string
description: The ID of the business glossary that is deleted.
required:
- domainIdentifier
- identifier
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)