GetAssetTypeCommand

Gets an Amazon DataZone asset type.

Example Syntax

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

import { DataZoneClient, GetAssetTypeCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetAssetTypeCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetAssetTypeInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
  revision: "STRING_VALUE",
};
const command = new GetAssetTypeCommand(input);
const response = await client.send(command);
// { // GetAssetTypeOutput
//   domainId: "STRING_VALUE", // required
//   name: "STRING_VALUE", // required
//   revision: "STRING_VALUE", // required
//   description: "STRING_VALUE",
//   formsOutput: { // FormsOutputMap // required
//     "<keys>": { // FormEntryOutput
//       typeName: "STRING_VALUE", // required
//       typeRevision: "STRING_VALUE", // required
//       required: true || false,
//     },
//   },
//   owningProjectId: "STRING_VALUE", // required
//   originDomainId: "STRING_VALUE",
//   originProjectId: "STRING_VALUE",
//   createdAt: new Date("TIMESTAMP"),
//   createdBy: "STRING_VALUE",
//   updatedAt: new Date("TIMESTAMP"),
//   updatedBy: "STRING_VALUE",
// };

GetAssetTypeCommand Input

See GetAssetTypeCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain in which the asset type exists.

identifier
Required
string | undefined

The ID of the asset type.

revision
string | undefined

The revision of the asset type.

GetAssetTypeCommand Output

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

The ID of the Amazon DataZone domain in which the asset type exists.

formsOutput
Required
Record<string, FormEntryOutput> | undefined

The metadata forms attached to the asset type.

name
Required
string | undefined

The name of the asset type.

owningProjectId
Required
string | undefined

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

revision
Required
string | undefined

The revision of the asset type.

createdAt
Date | undefined

The timestamp of when the asset type was created.

createdBy
string | undefined

The Amazon DataZone user who created the asset type.

description
string | undefined

The description of the asset type.

originDomainId
string | undefined

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

originProjectId
string | undefined

The ID of the Amazon DataZone project in which the asset type was originally created.

updatedAt
Date | undefined

The timestamp of when the asset type was updated.

updatedBy
string | undefined

The Amazon DataZone user that updated the asset type.

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.