CreateAssetRevision
Creates a revision of the asset.
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.
- domainIdentifier
-
The unique identifier of the domain where the asset is being revised.
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$Required: Yes
- identifier
-
The identifier of the asset.
Pattern:
^[a-zA-Z0-9_-]{1,36}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- clientToken
-
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[\x21-\x7E]+$Required: No
- description
-
The revised description of the asset.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
- formsInput
-
The metadata forms to be attached to the asset as part of asset revision.
Type: Array of FormInput objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
- glossaryTerms
-
The glossary terms to be attached to the asset as part of asset revision.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Pattern:
^[a-zA-Z0-9_-]{1,36}$Required: No
- name
-
Te revised name of the asset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
- predictionConfiguration
-
The configuration of the automatically generated business-friendly metadata for the asset.
Type: PredictionConfiguration object
Required: No
- typeRevision
-
The revision type of the asset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
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" ],
"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.
- createdAt
-
The timestamp of when the asset revision occured.
Type: Timestamp
- createdBy
-
The Amazon DataZone user who performed the asset revision.
Type: String
- description
-
The revised asset description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
- domainId
-
The unique identifier of the Amazon DataZone domain where the asset was revised.
Type: String
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$ - externalIdentifier
-
The external identifier of the asset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
- firstRevisionCreatedAt
-
The timestamp of when the first asset revision occured.
Type: Timestamp
- firstRevisionCreatedBy
-
The Amazon DataZone user who performed the first asset revision.
Type: String
- formsOutput
-
The metadata forms that were attached to the asset as part of the asset revision.
Type: Array of FormOutput objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
- glossaryTerms
-
The glossary terms that were attached to the asset as part of asset revision.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Pattern:
^[a-zA-Z0-9_-]{1,36}$ - id
-
The unique identifier of the asset revision.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$ - latestTimeSeriesDataPointFormsOutput
-
The latest data point that was imported into the time series form for the asset.
Type: Array of TimeSeriesDataPointSummaryFormOutput objects
- listing
-
The details of an asset published in an Amazon DataZone catalog.
Type: AssetListingDetails object
- name
-
The revised name of the asset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
- owningProjectId
-
The unique identifier of the revised project that owns the asset.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$ - predictionConfiguration
-
The configuration of the automatically generated business-friendly metadata for the asset.
Type: PredictionConfiguration object
- readOnlyFormsOutput
-
The read-only metadata forms that were attached to the asset as part of the asset revision.
Type: Array of FormOutput objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
- revision
-
The revision of the asset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
- typeIdentifier
-
The identifier of the revision type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 513.
Pattern:
^(?!\.)[\w\.]*\w$ - typeRevision
-
The revision type of the asset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
There is a conflict while performing this action.
HTTP Status Code: 409
- InternalServerException
-
The request has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource cannot be found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- UnauthorizedException
-
You do not have permission to perform this action.
HTTP Status Code: 401
- ValidationException
-
The input fails to satisfy the constraints specified by the AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
