- 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.
GetReadSetExportJobCommand
Gets information about a read set export job.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { OmicsClient, GetReadSetExportJobCommand } from "@aws-sdk/client-omics"; // ES Modules import
// const { OmicsClient, GetReadSetExportJobCommand } = require("@aws-sdk/client-omics"); // CommonJS import
const client = new OmicsClient(config);
const input = { // GetReadSetExportJobRequest
sequenceStoreId: "STRING_VALUE", // required
id: "STRING_VALUE", // required
};
const command = new GetReadSetExportJobCommand(input);
const response = await client.send(command);
// { // GetReadSetExportJobResponse
// id: "STRING_VALUE", // required
// sequenceStoreId: "STRING_VALUE", // required
// destination: "STRING_VALUE", // required
// status: "STRING_VALUE", // required
// statusMessage: "STRING_VALUE",
// creationTime: new Date("TIMESTAMP"), // required
// completionTime: new Date("TIMESTAMP"),
// readSets: [ // ExportReadSetDetailList
// { // ExportReadSetDetail
// id: "STRING_VALUE", // required
// status: "STRING_VALUE", // required
// statusMessage: "STRING_VALUE",
// },
// ],
// };
GetReadSetExportJobCommand Input
See GetReadSetExportJobCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
id Required | string | undefined | The job's ID. |
sequenceStoreId Required | string | undefined | The job's sequence store ID. |
GetReadSetExportJobCommand Output
See GetReadSetExportJobCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
creationTime Required | Date | undefined | When the job was created. |
destination Required | string | undefined | The job's destination in Amazon S3. |
id Required | string | undefined | The job's ID. |
sequenceStoreId Required | string | undefined | The job's sequence store ID. |
status Required | ReadSetExportJobStatus | undefined | The job's status. |
completionTime | Date | undefined | When the job completed. |
readSets | ExportReadSetDetail[] | undefined | The job's read sets. |
statusMessage | string | undefined | The job's status message. |
Throws
Name | Fault | Details |
---|
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. |
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. |