GetReadSetCommand

Gets a file from a read set.

Example Syntax

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

import { OmicsClient, GetReadSetCommand } from "@aws-sdk/client-omics"; // ES Modules import
// const { OmicsClient, GetReadSetCommand } = require("@aws-sdk/client-omics"); // CommonJS import
const client = new OmicsClient(config);
const input = { // GetReadSetRequest
  id: "STRING_VALUE", // required
  sequenceStoreId: "STRING_VALUE", // required
  file: "STRING_VALUE",
  partNumber: Number("int"), // required
};
const command = new GetReadSetCommand(input);
const response = await client.send(command);
// { // GetReadSetResponse
//   payload: "<SdkStream>", // see \@smithy/types -> StreamingBlobPayloadOutputTypes
// };

GetReadSetCommand Input

See GetReadSetCommandInput for more details

Parameter
Type
Description
id
Required
string | undefined

The read set's ID.

partNumber
Required
number | undefined

The part number to retrieve.

sequenceStoreId
Required
string | undefined

The read set's sequence store ID.

file
ReadSetFile | undefined

The file to retrieve.

GetReadSetCommand Output

See GetReadSetCommandOutput for details

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

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.

RangeNotSatisfiableException
client

The ranges specified in the request are not valid.

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.