- 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.
StartMetadataGenerationRunCommand
Starts the metadata generation run.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataZoneClient, StartMetadataGenerationRunCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, StartMetadataGenerationRunCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // StartMetadataGenerationRunInput
domainIdentifier: "STRING_VALUE", // required
type: "BUSINESS_DESCRIPTIONS", // required
target: { // MetadataGenerationRunTarget
type: "ASSET", // required
identifier: "STRING_VALUE", // required
revision: "STRING_VALUE",
},
clientToken: "STRING_VALUE",
owningProjectIdentifier: "STRING_VALUE", // required
};
const command = new StartMetadataGenerationRunCommand(input);
const response = await client.send(command);
// { // StartMetadataGenerationRunOutput
// domainId: "STRING_VALUE", // required
// id: "STRING_VALUE", // required
// status: "SUBMITTED" || "IN_PROGRESS" || "CANCELED" || "SUCCEEDED" || "FAILED",
// type: "BUSINESS_DESCRIPTIONS",
// createdAt: new Date("TIMESTAMP"),
// createdBy: "STRING_VALUE",
// owningProjectId: "STRING_VALUE",
// };
StartMetadataGenerationRunCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
domainIdentifier Required | string | undefined | The ID of the Amazon DataZone domain where you want to start a metadata generation run. |
owningProjectIdentifier Required | string | undefined | The ID of the project that owns the asset for which you want to start a metadata generation run. |
target Required | MetadataGenerationRunTarget | undefined | The asset for which you want to start a metadata generation run. |
type Required | MetadataGenerationRunType | undefined | The type of the metadata generation run. |
clientToken | string | undefined | A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided. |
StartMetadataGenerationRunCommand Output
Parameter | Type | Description |
---|
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 metadata generation run was started. |
id Required | string | undefined | The ID of the metadata generation run. |
createdAt | Date | undefined | The timestamp at which the metadata generation run was started. |
createdBy | string | undefined | The ID of the user who started the metadata generation run. |
owningProjectId | string | undefined | The ID of the project that owns the asset for which the metadata generation run was started. |
status | MetadataGenerationRunStatus | undefined | The status of the metadata generation run. |
type | MetadataGenerationRunType | undefined | The type of the metadata generation run. |
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. |