CreateAssetRevisionCommand

Creates a revision of the asset.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataZoneClient, CreateAssetRevisionCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, CreateAssetRevisionCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // CreateAssetRevisionInput
  name: "STRING_VALUE", // required
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
  typeRevision: "STRING_VALUE",
  description: "STRING_VALUE",
  glossaryTerms: [ // GlossaryTerms
    "STRING_VALUE",
  ],
  formsInput: [ // FormInputList
    { // FormInput
      formName: "STRING_VALUE", // required
      typeIdentifier: "STRING_VALUE",
      typeRevision: "STRING_VALUE",
      content: "STRING_VALUE",
    },
  ],
  predictionConfiguration: { // PredictionConfiguration
    businessNameGeneration: { // BusinessNameGenerationConfiguration
      enabled: true || false,
    },
  },
  clientToken: "STRING_VALUE",
};
const command = new CreateAssetRevisionCommand(input);
const response = await client.send(command);
// { // CreateAssetRevisionOutput
//   id: "STRING_VALUE", // required
//   name: "STRING_VALUE", // required
//   typeIdentifier: "STRING_VALUE", // required
//   typeRevision: "STRING_VALUE", // required
//   externalIdentifier: "STRING_VALUE",
//   revision: "STRING_VALUE", // required
//   description: "STRING_VALUE",
//   createdAt: new Date("TIMESTAMP"),
//   createdBy: "STRING_VALUE",
//   firstRevisionCreatedAt: new Date("TIMESTAMP"),
//   firstRevisionCreatedBy: "STRING_VALUE",
//   glossaryTerms: [ // GlossaryTerms
//     "STRING_VALUE",
//   ],
//   owningProjectId: "STRING_VALUE", // required
//   domainId: "STRING_VALUE", // required
//   listing: { // AssetListingDetails
//     listingId: "STRING_VALUE", // required
//     listingStatus: "CREATING" || "ACTIVE" || "INACTIVE", // required
//   },
//   formsOutput: [ // FormOutputList // required
//     { // FormOutput
//       formName: "STRING_VALUE", // required
//       typeName: "STRING_VALUE",
//       typeRevision: "STRING_VALUE",
//       content: "STRING_VALUE",
//     },
//   ],
//   readOnlyFormsOutput: [
//     {
//       formName: "STRING_VALUE", // required
//       typeName: "STRING_VALUE",
//       typeRevision: "STRING_VALUE",
//       content: "STRING_VALUE",
//     },
//   ],
//   latestTimeSeriesDataPointFormsOutput: [ // TimeSeriesDataPointSummaryFormOutputList
//     { // TimeSeriesDataPointSummaryFormOutput
//       formName: "STRING_VALUE", // required
//       typeIdentifier: "STRING_VALUE", // required
//       typeRevision: "STRING_VALUE",
//       timestamp: new Date("TIMESTAMP"), // required
//       contentSummary: "STRING_VALUE",
//       id: "STRING_VALUE",
//     },
//   ],
//   predictionConfiguration: { // PredictionConfiguration
//     businessNameGeneration: { // BusinessNameGenerationConfiguration
//       enabled: true || false,
//     },
//   },
// };

CreateAssetRevisionCommand Input

See CreateAssetRevisionCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The unique identifier of the domain where the asset is being revised.

identifier
Required
string | undefined

The identifier of the asset.

name
Required
string | undefined

Te revised name of the asset.

clientToken
string | undefined

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

description
string | undefined

The revised description of the asset.

formsInput
FormInput[] | undefined

The metadata forms to be attached to the asset as part of asset revision.

glossaryTerms
string[] | undefined

The glossary terms to be attached to the asset as part of asset revision.

predictionConfiguration
PredictionConfiguration | undefined

The configuration of the automatically generated business-friendly metadata for the asset.

typeRevision
string | undefined

The revision type of the asset.

CreateAssetRevisionCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
domainId
Required
string | undefined

The unique identifier of the Amazon DataZone domain where the asset was revised.

formsOutput
Required
FormOutput[] | undefined

The metadata forms that were attached to the asset as part of the asset revision.

id
Required
string | undefined

The unique identifier of the asset revision.

name
Required
string | undefined

The revised name of the asset.

owningProjectId
Required
string | undefined

The unique identifier of the revised project that owns the asset.

revision
Required
string | undefined

The revision of the asset.

typeIdentifier
Required
string | undefined

The identifier of the revision type.

typeRevision
Required
string | undefined

The revision type of the asset.

createdAt
Date | undefined

The timestamp of when the asset revision occured.

createdBy
string | undefined

The Amazon DataZone user who performed the asset revision.

description
string | undefined

The revised asset description.

externalIdentifier
string | undefined

The external identifier of the asset.

firstRevisionCreatedAt
Date | undefined

The timestamp of when the first asset revision occured.

firstRevisionCreatedBy
string | undefined

The Amazon DataZone user who performed the first asset revision.

glossaryTerms
string[] | undefined

The glossary terms that were attached to the asset as part of asset revision.

latestTimeSeriesDataPointFormsOutput
TimeSeriesDataPointSummaryFormOutput[] | undefined

The latest data point that was imported into the time series form for the asset.

listing
AssetListingDetails | undefined

The details of an asset published in an Amazon DataZone catalog.

predictionConfiguration
PredictionConfiguration | undefined

The configuration of the automatically generated business-friendly metadata for the asset.

readOnlyFormsOutput
FormOutput[] | undefined

The read-only metadata forms that were attached to the asset as part of the asset revision.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

There is a conflict while performing this action.

InternalServerException
server

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The specified resource cannot be found.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException
client

You do not have permission to perform this action.

DataZoneServiceException
Base exception class for all service exceptions from DataZone service.