DeleteReferenceCommand

Deletes a genome reference.

Example Syntax

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

import { OmicsClient, DeleteReferenceCommand } from "@aws-sdk/client-omics"; // ES Modules import
// const { OmicsClient, DeleteReferenceCommand } = require("@aws-sdk/client-omics"); // CommonJS import
const client = new OmicsClient(config);
const input = { // DeleteReferenceRequest
  id: "STRING_VALUE", // required
  referenceStoreId: "STRING_VALUE", // required
};
const command = new DeleteReferenceCommand(input);
const response = await client.send(command);
// {};

DeleteReferenceCommand Input

See DeleteReferenceCommandInput for more details

Parameter
Type
Description
id
Required
string | undefined

The reference's ID.

referenceStoreId
Required
string | undefined

The reference's store ID.

DeleteReferenceCommand Output

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

The request cannot be applied to the target resource in its current state.

InternalServerException
server

An unexpected error occurred. Try the request again.

RequestTimeoutException
client

The request timed out.

ResourceNotFoundException
client

The target resource was not found in the current Region.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by an AWS service.

OmicsServiceException
Base exception class for all service exceptions from Omics service.