CreateAssetRevision

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:

Request Syntax

POST /v2/domains/domainIdentifier/assets/identifier/revisions HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "formsInput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ],
   "glossaryTerms": [ "string" ],
   "name": "string",
   "predictionConfiguration": { 
      "businessNameGeneration": { 
         "enabled": boolean
      }
   },
   "typeRevision": "string"
}

URI Request Parameters

The request uses the following URI parameters.

Request Body

The request accepts the following data in JSON format.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "externalIdentifier": "string",
   "firstRevisionCreatedAt": number,
   "firstRevisionCreatedBy": "string",
   "formsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "glossaryTerms": [ "string" ],
   "governedGlossaryTerms": [ "string" ],
   "id": "string",
   "latestTimeSeriesDataPointFormsOutput": [ 
      { 
         "contentSummary": "string",
         "formName": "string",
         "id": "string",
         "timestamp": number,
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ],
   "listing": { 
      "listingId": "string",
      "listingStatus": "string"
   },
   "name": "string",
   "owningProjectId": "string",
   "predictionConfiguration": { 
      "businessNameGeneration": { 
         "enabled": boolean
      }
   },
   "readOnlyFormsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "revision": "string",
   "typeIdentifier": "string",
   "typeRevision": "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.

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Example

This example illustrates one usage of CreateAssetRevision.

Sample Request

aws datazone create-asset-revision \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "ast7k9mpq2xvn4" \
--name "CustomerDataset-v2" \
--forms-input '[
    {
        "formName": "S3ObjectCollectionForm",
        "typeIdentifier": "amazon.datazone.S3ObjectCollectionFormType",
        "typeRevision": "7",
        "content": "{\"bucketArn\":\"arn:aws:s3:::customer-analytics-data\"}"
    }
]'
            

Sample Response

{
    "createdAt": 1752601021.227,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1752554243.917,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [{
        "content": "{\"bucketArn\":\"arn:aws:s3:::customer-analytics-data\"}",
        "formName": "S3ObjectCollectionForm",
        "typeName": "amazon.datazone.S3ObjectCollectionFormType",
        "typeRevision": "7"
    }],
    "id": "ast7k9mpq2xvn4",
    "name": "CustomerDataset-v2",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "2",
    "typeIdentifier": "amazon.datazone.S3ObjectCollectionAssetType",
    "typeRevision": "13"
}
            

Example

Failure case - invalid revision number for form input:

Sample Request

aws datazone create-asset-revision \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "ast7k9mpq2xvn4" \
--name "SalesTransactionsMart" \
--forms-input '[{
    "formName": "GlueTableForm",
    "typeIdentifier": "amazon.datazone.GlueTableFormType",
    "typeRevision": "12",
    "content": "{\"databaseName\":\"retail_analytics\",\"tableName\":\"sales_transactions\",\"catalogId\":\"\",\"region\":\"us-east-1\",\"tableArn\":\"arn:aws:glue:us-east-1:*:table/retail_analytics/sales_transactions\",\"columns\":[{\"columnName\":\"transaction_id\",\"dataType\":\"string\"},{\"columnName\":\"transaction_date\",\"dataType\":\"timestamp\"},{\"columnName\":\"product_id\",\"dataType\":\"string\"},{\"columnName\":\"quantity\",\"dataType\":\"int\"},{\"columnName\":\"total_amount\",\"dataType\":\"decimal\"}]}"
}]‘
            

Sample Response

An error occurred (ValidationException) when calling the CreateAsset operation: Form GlueTableForm expected form amazon.datazone#GlueTableFormType@13 but was provided amazon.datazone#GlueTableFormType@12
            

Example

Failure case - invalid or missing --domain-identifier:

Sample Request

aws datazone create-asset-revision \
--domain-identifier "invalid_domain" \
--identifier "ast7k9mpq2xvn4" \
--name "CustomerDataset-v2" \
--forms-input '[]'
            

Sample Response

An error occurred (ValidationException) when calling the CreateAssetRevision operation: 1 validation error detected: Value at 'domainIdentifier' failed to satisfy constraint: Member must satisfy regular expression pattern: dzd[-_][a-zA-Z0-9_-]{1,36}
            

Example

Failure case - unsupported form typeIdentifier or typeRevision:

Sample Request

aws datazone create-asset-revision \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "ast7k9mpq2xvn4" \
--name "CustomerDataset-v2" \
--forms-input 'INVALID_JSON'
            

Sample Response

Error parsing parameter '—forms-input': Expected: '=', received: 'EOF' for input:
{self._error_location()}
            

Example

Failure case - response does not exist:

Sample Request

aws datazone create-asset-revision \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "ast7k9mpq2xvn4" \
--name "CustomerDataset-v2" \
--forms-input '[
    {
        "formName": "InvalidForm",
        "typeIdentifier": "invalid.type.identifier",
        "typeRevision": "99",
        "content": "{}"
    }
]'
            

Sample Response

An error occurred (ResourceNotFoundException) when calling the CreateAssetRevision operation: The given Asset doesn't exist. Try creating Asset before accessing it.
            

Example

Failure case - missing required content field:

Sample Request

aws datazone create-asset-revision \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "ast7k9mpq2xvn4" \
--name "CustomerDataset-v2" \
--forms-input '[
    {
        "formName": "S3ObjectCollectionForm",
        "typeIdentifier": "amazon.datazone.S3ObjectCollectionFormType",
        "typeRevision": "7"
    }
]'
            

Sample Response

An error occurred (ValidationException) when calling the CreateAssetRevision operation: $.S3ObjectCollectionForm.bucketArn: is missing but it is required
            

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: