- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateDataProductCommand
Creates a data product.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataZoneClient, CreateDataProductCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, CreateDataProductCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // CreateDataProductInput
domainIdentifier: "STRING_VALUE", // required
name: "STRING_VALUE", // required
owningProjectIdentifier: "STRING_VALUE", // required
description: "STRING_VALUE",
glossaryTerms: [ // GlossaryTerms
"STRING_VALUE",
],
formsInput: [ // FormInputList
{ // FormInput
formName: "STRING_VALUE", // required
typeIdentifier: "STRING_VALUE",
typeRevision: "STRING_VALUE",
content: "STRING_VALUE",
},
],
items: [ // DataProductItems
{ // DataProductItem
itemType: "ASSET", // required
identifier: "STRING_VALUE", // required
revision: "STRING_VALUE",
glossaryTerms: [ // ItemGlossaryTerms
"STRING_VALUE",
],
},
],
clientToken: "STRING_VALUE",
};
const command = new CreateDataProductCommand(input);
const response = await client.send(command);
// { // CreateDataProductOutput
// 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",
// };
CreateDataProductCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
domainIdentifier Required | string | undefined | The ID of the domain where the data product is created. |
name Required | string | undefined | The name of the data product. |
owningProjectIdentifier Required | string | undefined | The ID of the owning project of the data product. |
clientToken | string | undefined | A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. |
description | string | undefined | The description of the data product. |
formsInput | FormInput[] | 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. |
CreateDataProductCommand Output
Parameter | Type | Description |
---|
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 was 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 was 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 |
---|
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. |
ServiceQuotaExceededException | client | The request has exceeded the specified service quota. |
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. |