GetAssetCommand

Gets an Amazon DataZone asset.

Example Syntax

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

import { DataZoneClient, GetAssetCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetAssetCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetAssetInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
  revision: "STRING_VALUE",
};
const command = new GetAssetCommand(input);
const response = await client.send(command);
// { // GetAssetOutput
//   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",
//     },
//   ],
// };

GetAssetCommand Input

See GetAssetCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain to which the asset belongs.

identifier
Required
string | undefined

The ID of the Amazon DataZone asset.

revision
string | undefined

The revision of the Amazon DataZone asset.

GetAssetCommand Output

See GetAssetCommandOutput for details

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

The ID of the Amazon DataZone domain to which the asset belongs.

formsOutput
Required
FormOutput[] | undefined

The metadata forms attached to the asset.

id
Required
string | undefined

The ID of the asset.

name
Required
string | undefined

The name of the asset.

owningProjectId
Required
string | undefined

The ID of the project that owns the asset.

revision
Required
string | undefined

The revision of the asset.

typeIdentifier
Required
string | undefined

The ID of the asset type.

typeRevision
Required
string | undefined

The revision of the asset type.

createdAt
Date | undefined

The timestamp of when the asset was created.

createdBy
string | undefined

The Amazon DataZone user who created the asset.

description
string | undefined

The description of the Amazon DataZone asset.

externalIdentifier
string | undefined

The external ID of the asset.

firstRevisionCreatedAt
Date | undefined

The timestamp of when the first revision of the asset was created.

firstRevisionCreatedBy
string | undefined

The Amazon DataZone user who created the first revision of the asset.

glossaryTerms
string[] | undefined

The business glossary terms attached to the asset.

latestTimeSeriesDataPointFormsOutput
TimeSeriesDataPointSummaryFormOutput[] | undefined

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

listing
AssetListingDetails | undefined

The listing of the asset.

readOnlyFormsOutput
FormOutput[] | undefined

The read-only metadata forms attached to the asset.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform 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.