v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141891,2951.1 MB

Creates an asset in Amazon DataZone catalog.

Before creating assets, make sure that the following requirements are met:

  • --domain-identifier must refer to an existing domain.

  • --owning-project-identifier must be a valid project within the domain.

  • Asset type must be created beforehand using create-asset-type, or be a supported system-defined type. For more information, see create-asset-type.

  • --type-revision (if used) must match a valid revision of the asset type.

  • formsInput is required when it is associated as required in the asset-type. For more information, see create-form-type.

  • Form content must include all required fields as per the form schema (e.g., bucketArn).

You must invoke the following pre-requisite commands before invoking this API:

post/v2/domains/{domainIdentifier}/assets

Path parameters

domainIdentifierstring required

Amazon DataZone domain where the asset is created.

Request body

namestring password required

Asset name.

externalIdentifierstring
<p>The external identifier of the asset.</p> <p>If the value for the <code>externalIdentifier</code> parameter is specified, it must be a unique value.</p>
typeIdentifierstring required

The unique identifier of this asset's type.

typeRevisionstring

The revision of this asset's type.

descriptionstring password

Asset description.

glossaryTermsGlossaryTermId[]

Glossary terms attached to the asset.

owningProjectIdentifierstring required

The unique identifier of the project that owns this asset.

clientTokenstring

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

Response

Success

idstring required

The unique identifier of the created asset.

namestring password required

The name of the created asset.

typeIdentifierstring required

The identifier of the created asset type.

typeRevisionstring required

The revision type of the asset.

externalIdentifierstring

The external identifier of the asset.

revisionstring required

The revision of the asset.

descriptionstring password

The description of the created asset.

createdAtstring date-time

The timestamp of when the asset was created.

createdBystring

The Amazon DataZone user that created this asset in the catalog.

firstRevisionCreatedAtstring date-time

The timestamp of when the first revision of the asset took place.

firstRevisionCreatedBystring

The Amazon DataZone user that made the first revision of the asset.

glossaryTermsGlossaryTermId[]

The glossary terms that are attached to the created asset.

governedGlossaryTermsGlossaryTermId[]

The glossary terms in a restricted glossary.

owningProjectIdstring required

The ID of the Amazon DataZone project that owns the created asset.

domainIdstring required

The ID of the Amazon DataZone domain in which the asset was created.