GetDataProductCommand

Gets the data product.

Example Syntax

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

import { DataZoneClient, GetDataProductCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetDataProductCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetDataProductInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
  revision: "STRING_VALUE",
};
const command = new GetDataProductCommand(input);
const response = await client.send(command);
// { // GetDataProductOutput
//   domainId: "STRING_VALUE", // required
//   id: "STRING_VALUE", // required
//   revision: "STRING_VALUE", // required
//   owningProjectId: "STRING_VALUE", // required
//   name: "STRING_VALUE", // required
//   status: "CREATED" || "CREATING" || "CREATE_FAILED", // required
//   description: "STRING_VALUE",
//   glossaryTerms: [ // GlossaryTerms
//     "STRING_VALUE",
//   ],
//   items: [ // DataProductItems
//     { // DataProductItem
//       itemType: "ASSET", // required
//       identifier: "STRING_VALUE", // required
//       revision: "STRING_VALUE",
//       glossaryTerms: [ // ItemGlossaryTerms
//         "STRING_VALUE",
//       ],
//     },
//   ],
//   formsOutput: [ // FormOutputList
//     { // FormOutput
//       formName: "STRING_VALUE", // required
//       typeName: "STRING_VALUE",
//       typeRevision: "STRING_VALUE",
//       content: "STRING_VALUE",
//     },
//   ],
//   createdAt: new Date("TIMESTAMP"),
//   createdBy: "STRING_VALUE",
//   firstRevisionCreatedAt: new Date("TIMESTAMP"),
//   firstRevisionCreatedBy: "STRING_VALUE",
// };

GetDataProductCommand Input

See GetDataProductCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the domain where the data product lives.

identifier
Required
string | undefined

The ID of the data product.

revision
string | undefined

The revision of the data product.

GetDataProductCommand Output

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

The ID of the domain where the data product lives.

id
Required
string | undefined

The ID of the data product.

name
Required
string | undefined

The name of the data product.

owningProjectId
Required
string | undefined

The ID of the owning project of the data product.

revision
Required
string | undefined

The revision of the data product.

status
Required
DataProductStatus | undefined

The status of the data product.

createdAt
Date | undefined

The timestamp at which the data product is created.

createdBy
string | undefined

The user who created the data product.

description
string | undefined

The description of the data product.

firstRevisionCreatedAt
Date | undefined

The timestamp at which the first revision of the data product is created.

firstRevisionCreatedBy
string | undefined

The user who created the first revision of the data product.

formsOutput
FormOutput[] | undefined

The metadata forms of the data product.

glossaryTerms
string[] | undefined

The glossary terms of the data product.

items
DataProductItem[] | undefined

The data assets of the data product.

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.