GetVariantImportJobCommand

Gets information about a variant import job.

Example Syntax

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

import { OmicsClient, GetVariantImportJobCommand } from "@aws-sdk/client-omics"; // ES Modules import
// const { OmicsClient, GetVariantImportJobCommand } = require("@aws-sdk/client-omics"); // CommonJS import
const client = new OmicsClient(config);
const input = { // GetVariantImportRequest
  jobId: "STRING_VALUE", // required
};
const command = new GetVariantImportJobCommand(input);
const response = await client.send(command);
// { // GetVariantImportResponse
//   id: "STRING_VALUE", // required
//   destinationName: "STRING_VALUE", // required
//   roleArn: "STRING_VALUE", // required
//   status: "STRING_VALUE", // required
//   statusMessage: "STRING_VALUE", // required
//   creationTime: new Date("TIMESTAMP"), // required
//   updateTime: new Date("TIMESTAMP"), // required
//   completionTime: new Date("TIMESTAMP"),
//   items: [ // VariantImportItemDetails // required
//     { // VariantImportItemDetail
//       source: "STRING_VALUE", // required
//       jobStatus: "STRING_VALUE", // required
//       statusMessage: "STRING_VALUE",
//     },
//   ],
//   runLeftNormalization: true || false, // required
//   annotationFields: { // AnnotationFieldMap
//     "<keys>": "STRING_VALUE",
//   },
// };

GetVariantImportJobCommand Input

See GetVariantImportJobCommandInput for more details

Parameter
Type
Description
jobId
Required
string | undefined

The job's ID.

GetVariantImportJobCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
creationTime
Required
Date | undefined

When the job was created.

destinationName
Required
string | undefined

The job's destination variant store.

id
Required
string | undefined

The job's ID.

items
Required
VariantImportItemDetail[] | undefined

The job's items.

roleArn
Required
string | undefined

The job's service role ARN.

runLeftNormalization
Required
boolean | undefined

The job's left normalization setting.

status
Required
JobStatus | undefined

The job's status.

statusMessage
Required
string | undefined

The job's status message.

updateTime
Required
Date | undefined

When the job was updated.

annotationFields
Record<string, string> | undefined

The annotation schema generated by the parsed annotation data.

completionTime
Date | undefined

When the job completed.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

An unexpected error occurred. Try the request again.

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.