Amazon DataZone Datazone Revisions API
The Datazone Revisions API from Amazon DataZone — 2 operation(s) for datazone revisions.
The Datazone Revisions API from Amazon DataZone — 2 operation(s) for datazone revisions.
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-revisions-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 Revisions 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: Revisions
paths:
/v2/domains/{domainIdentifier}/assets/{identifier}/revisions:
get:
operationId: ListAssetRevisions
summary: List Asset Revisions
description: 'Lists the revisions for the asset. Prerequisites: The asset must exist in the domain. There must be at least one revision of the asset (which happens automatically after creation). The domain must be valid and active. User must have permissions on the asset and domain.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListAssetRevisionsOutput'
'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/ListAssetRevisionsInput'
tags:
- Revisions
post:
operationId: CreateAssetRevision
summary: Create Asset Revision
description: 'Creates a revision of the asset. Asset revisions represent new versions of existing assets, capturing changes to either the underlying data or its metadata. They maintain a historical record of how assets evolve over time, who made changes, and when those changes occurred. This versioning capability is crucial for governance and compliance, allowing organizations to track changes, understand their impact, and roll back if necessary. Prerequisites: Asset must already exist in the domain with identifier. formsInput is required when asset has the form type. typeRevision should be the latest version of form type. The form content must include all required fields (e.g., bucketArn for S3ObjectCollectionForm). The owning project of the original asset must still exist and be active. User must have write access to the project and domain.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAssetRevisionOutput'
'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/CreateAssetRevisionInput'
tags:
- Revisions
/v2/domains/{domainIdentifier}/data-products/{identifier}/revisions:
get:
operationId: ListDataProductRevisions
summary: List Data Product Revisions
description: 'Lists data product revisions. Prerequisites: The data product ID must exist within the domain. User must have view permissions on the data product. The domain must be in a valid and accessible state.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListDataProductRevisionsOutput'
'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/ListDataProductRevisionsInput'
tags:
- Revisions
post:
operationId: CreateDataProductRevision
summary: Create Data Product Revision
description: 'Creates a data product revision. Prerequisites: The original data product must exist in the given domain. User must have permissions on the data product. The domain must be valid and accessible. The new revision name must comply with naming constraints (if required).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDataProductRevisionOutput'
'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/CreateDataProductRevisionInput'
tags:
- Revisions
components:
schemas:
ListAssetRevisionsInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the domain.
identifier:
type: string
description: The identifier of the asset.
nextToken:
type: string
description: When the number of revisions 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 revisions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAssetRevisions to list the next set of revisions.
maxResults:
type: integer
description: The maximum number of revisions to return in a single call to ListAssetRevisions. When the number of revisions 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 ListAssetRevisions to list the next set of revisions.
required:
- domainIdentifier
- identifier
ValidationException:
type: object
properties:
message:
type: string
required:
- message
ListAssetRevisionsOutput:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/AssetRevision'
description: The results of the ListAssetRevisions action.
nextToken:
type: string
description: When the number of revisions 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 revisions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAssetRevisions to list the next set of revisions.
CreateDataProductRevisionOutput:
type: object
properties:
domainId:
type: string
description: The ID of the domain where data product revision is created.
id:
type: string
description: The ID of the data product revision.
revision:
type: string
description: The revision of the data product revision.
owningProjectId:
type: string
description: The ID of the owning project of the data product revision.
name:
type: string
description: The name of the data product revision.
status:
type: string
enum:
- CREATED
- CREATING
- CREATE_FAILED
description: The status of the data product revision.
description:
type: string
description: The description of the data product revision.
glossaryTerms:
type: array
items:
type: string
description: The glossary terms of the data product revision.
items:
type: array
items:
$ref: '#/components/schemas/DataProductItem'
description: The data assets of the data product revision.
formsOutput:
type: array
items:
$ref: '#/components/schemas/FormOutput'
description: The metadata forms of the data product revision.
createdAt:
type: string
format: date-time
description: The timestamp at which the data product revision is created.
createdBy:
type: string
description: The user who created the data product revision.
firstRevisionCreatedAt:
type: string
format: date-time
description: The timestamp at which the first revision of the data product is created.
firstRevisionCreatedBy:
type: string
description: The user who created the first revision of the data product.
required:
- domainId
- id
- revision
- owningProjectId
- name
- status
BusinessNameGenerationConfiguration:
type: object
properties:
enabled:
type: boolean
description: Specifies whether the business name generation is enabled.
CreateDataProductRevisionInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the domain where the data product revision is created.
identifier:
type: string
description: The ID of the data product revision.
name:
type: string
description: The name of the data product revision.
description:
type: string
description: The description of the data product revision.
glossaryTerms:
type: array
items:
type: string
description: The glossary terms of the data product revision.
items:
type: array
items:
$ref: '#/components/schemas/DataProductItem'
description: The data assets of the data product revision.
formsInput:
type: array
items:
$ref: '#/components/schemas/FormInput'
description: The metadata forms of the data product revision.
clientToken:
type: string
description: A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
required:
- domainIdentifier
- identifier
- name
FormInput:
type: object
properties:
formName:
type: string
description: The name of the metadata form.
typeIdentifier:
type: string
description: The ID of the metadata form type.
typeRevision:
type: string
description: The revision of the metadata form type.
content:
type: string
description: The content of the metadata form.
required:
- formName
AssetRevision:
type: object
properties:
domainId:
type: string
description: The Amazon DataZone user who created the inventory asset.
id:
type: string
description: The identifier of the inventory asset revision.
revision:
type: string
description: The revision details of the inventory asset.
createdBy:
type: string
description: The Amazon DataZone user who created the asset revision.
createdAt:
type: string
format: date-time
description: The timestamp of when an inventory asset revison was created.
UnauthorizedException:
type: object
properties:
message:
type: string
required:
- message
ThrottlingException:
type: object
properties:
message:
type: string
required:
- message
ListDataProductRevisionsOutput:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DataProductRevision'
description: The results of the ListDataProductRevisions action.
nextToken:
type: string
description: When the number of data product revisions 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 data product revisions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataProductRevisions to list the next set of data product revisions.
required:
- items
AssetListingDetails:
type: object
properties:
listingId:
type: string
description: The identifier of an asset published in an Amazon DataZone catalog.
listingStatus:
type: string
enum:
- CREATING
- ACTIVE
- INACTIVE
description: The status of an asset published in an Amazon DataZone catalog.
required:
- listingId
- listingStatus
CreateAssetRevisionInput:
type: object
properties:
name:
type: string
description: Te revised name of the asset.
domainIdentifier:
type: string
description: The unique identifier of the domain where the asset is being revised.
identifier:
type: string
description: The identifier of the asset.
typeRevision:
type: string
description: The revision type of the asset.
description:
type: string
description: The revised description of the asset.
glossaryTerms:
type: array
items:
type: string
description: The glossary terms to be attached to the asset as part of asset revision.
formsInput:
type: array
items:
$ref: '#/components/schemas/FormInput'
description: The metadata forms to be attached to the asset as part of asset revision.
predictionConfiguration:
$ref: '#/components/schemas/PredictionConfiguration'
clientToken:
type: string
description: A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
required:
- name
- domainIdentifier
- identifier
CreateAssetRevisionOutput:
type: object
properties:
id:
type: string
description: The unique identifier of the asset revision.
name:
type: string
description: The revised name of the asset.
typeIdentifier:
type: string
description: The identifier of the revision type.
typeRevision:
type: string
description: The revision type of the asset.
externalIdentifier:
type: string
description: The external identifier of the asset.
revision:
type: string
description: The revision of the asset.
description:
type: string
description: The revised asset description.
createdAt:
type: string
format: date-time
description: The timestamp of when the asset revision occured.
createdBy:
type: string
description: The Amazon DataZone user who performed the asset revision.
firstRevisionCreatedAt:
type: string
format: date-time
description: The timestamp of when the first asset revision occured.
firstRevisionCreatedBy:
type: string
description: The Amazon DataZone user who performed the first asset revision.
glossaryTerms:
type: array
items:
type: string
description: The glossary terms that were attached to the asset as part of asset revision.
governedGlossaryTerms:
type: array
items:
type: string
description: The glossary terms in a restricted glossary.
owningProjectId:
type: string
description: The unique identifier of the revised project that owns the asset.
domainId:
type: string
description: The unique identifier of the Amazon DataZone domain where the asset was revised.
listing:
$ref: '#/components/schemas/AssetListingDetails'
formsOutput:
type: array
items:
$ref: '#/components/schemas/FormOutput'
description: The metadata forms that were attached to the asset as part of the asset revision.
readOnlyFormsOutput:
type: array
items:
$ref: '#/components/schemas/FormOutput'
description: The read-only metadata forms that were attached to the asset as part of the asset revision.
latestTimeSeriesDataPointFormsOutput:
type: array
items:
$ref: '#/components/schemas/TimeSeriesDataPointSummaryFormOutput'
description: The latest data point that was imported into the time series form for the asset.
predictionConfiguration:
$ref: '#/components/schemas/PredictionConfiguration'
required:
- id
- name
- typeIdentifier
- typeRevision
- revision
- owningProjectId
- domainId
- formsOutput
ListDataProductRevisionsInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the domain of the data product revisions that you want to list.
identifier:
type: string
description: The ID of the data product revision.
maxResults:
type: integer
description: The maximum number of asset filters to return in a single call to ListDataProductRevisions. When the number of data product revisions 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 ListDataProductRevisions to list the next set of data product revisions.
nextToken:
type: string
description: When the number of data product revisions 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 data product revisions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataProductRevisions to list the next set of data product revisions.
required:
- domainIdentifier
- identifier
AccessDeniedException:
type: object
properties:
message:
type: string
required:
- message
DataProductItem:
type: object
properties:
itemType:
type: string
enum:
- ASSET
description: The type of the data product.
identifier:
type: string
description: The ID of the data product.
revision:
type: string
description: The revision of the data product.
glossaryTerms:
type: array
items:
type: string
description: The glossary terms of the data product.
required:
- itemType
- identifier
TimeSeriesDataPointSummaryFormOutput:
type: object
properties:
formName:
type: string
description: The name of the time series data points summary form.
typeIdentifier:
type: string
description: The type ID of the time series data points summary form.
typeRevision:
type: string
description: The type revision of the time series data points summary form.
timestamp:
type: string
description: The timestamp of the time series data points summary form.
contentSummary:
type: string
description: The content of the summary of the time series data points form.
id:
type: string
description: The ID of the time series data points summary form.
required:
- formName
- typeIdentifier
- timestamp
PredictionConfiguration:
type: object
properties:
businessNameGeneration:
$ref: '#/components/schemas/BusinessNameGenerationConfiguration'
FormOutput:
type: object
properties:
formName:
type: string
description: The name of the metadata form.
typeName:
type: string
description: The name of the metadata form type.
typeRevision:
type: string
description: The revision of the metadata form type.
content:
type: string
description: The content of the metadata form.
required:
- formName
InternalServerException:
type: object
properties:
message:
type: string
required:
- message
ResourceNotFoundException:
type: object
properties:
message:
type: string
required:
- message
ConflictException:
type: object
properties:
message:
type: string
required:
- message
DataProductRevision:
type: object
properties:
domainId:
type: string
description: The ID of the domain where the data product revision lives.
id:
type: string
description: The ID of the data product revision.
revision:
type: string
description: The data product revision.
createdAt:
type: string
format: date-time
description: The timestamp at which the data product revision was created.
createdBy:
type: string
description: The user who created the data product revision.
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)