GetMetadataGenerationRunCommand

Gets a metadata generation run in Amazon DataZone.

Example Syntax

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

import { DataZoneClient, GetMetadataGenerationRunCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetMetadataGenerationRunCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetMetadataGenerationRunInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
};
const command = new GetMetadataGenerationRunCommand(input);
const response = await client.send(command);
// { // GetMetadataGenerationRunOutput
//   domainId: "STRING_VALUE", // required
//   id: "STRING_VALUE", // required
//   target: { // MetadataGenerationRunTarget
//     type: "ASSET", // required
//     identifier: "STRING_VALUE", // required
//     revision: "STRING_VALUE",
//   },
//   status: "SUBMITTED" || "IN_PROGRESS" || "CANCELED" || "SUCCEEDED" || "FAILED",
//   type: "BUSINESS_DESCRIPTIONS",
//   createdAt: new Date("TIMESTAMP"),
//   createdBy: "STRING_VALUE",
//   owningProjectId: "STRING_VALUE", // required
// };

GetMetadataGenerationRunCommand Input

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain the metadata generation run of which you want to get.

identifier
Required
string | undefined

The identifier of the metadata generation run.

GetMetadataGenerationRunCommand Output

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

The ID of the Amazon DataZone domain the metadata generation run of which you want to get.

id
Required
string | undefined

The ID of the metadata generation run.

owningProjectId
Required
string | undefined

The ID of the project that owns the assets for which you're running metadata generation.

createdAt
Date | undefined

The timestamp of when the metadata generation run was start.

createdBy
string | undefined

The Amazon DataZone user who started the metadata generation run.

status
MetadataGenerationRunStatus | undefined

The status of the metadata generation run.

target
MetadataGenerationRunTarget | undefined

The asset for which you're generating metadata.

type
MetadataGenerationRunType | undefined

The type of metadata generation run.

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.