CancelMetadataGenerationRunCommand

Suggest an Edit

Cancels the metadata generation run.

Example Syntax

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

import { DataZoneClient, CancelMetadataGenerationRunCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, CancelMetadataGenerationRunCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // CancelMetadataGenerationRunInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
};
const command = new CancelMetadataGenerationRunCommand(input);
const response = await client.send(command);
// {};

CancelMetadataGenerationRunCommand Input

See CancelMetadataGenerationRunCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain in which the metadata generation run is to be cancelled.

identifier
Required
string | undefined

The ID of the metadata generation run.

CancelMetadataGenerationRunCommand Output

See CancelMetadataGenerationRunCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

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.

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.