ListReadSetUploadPartsCommand

This operation will list all parts in a requested multipart upload for a sequence store.

Example Syntax

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

import { OmicsClient, ListReadSetUploadPartsCommand } from "@aws-sdk/client-omics"; // ES Modules import
// const { OmicsClient, ListReadSetUploadPartsCommand } = require("@aws-sdk/client-omics"); // CommonJS import
const client = new OmicsClient(config);
const input = { // ListReadSetUploadPartsRequest
  sequenceStoreId: "STRING_VALUE", // required
  uploadId: "STRING_VALUE", // required
  partSource: "STRING_VALUE", // required
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
  filter: { // ReadSetUploadPartListFilter
    createdAfter: new Date("TIMESTAMP"),
    createdBefore: new Date("TIMESTAMP"),
  },
};
const command = new ListReadSetUploadPartsCommand(input);
const response = await client.send(command);
// { // ListReadSetUploadPartsResponse
//   nextToken: "STRING_VALUE",
//   parts: [ // ReadSetUploadPartList
//     { // ReadSetUploadPartListItem
//       partNumber: Number("int"), // required
//       partSize: Number("long"), // required
//       partSource: "STRING_VALUE", // required
//       checksum: "STRING_VALUE", // required
//       creationTime: new Date("TIMESTAMP"),
//       lastUpdatedTime: new Date("TIMESTAMP"),
//     },
//   ],
// };

ListReadSetUploadPartsCommand Input

Parameter
Type
Description
partSource
Required
ReadSetPartSource | undefined

The source file for the upload part.

sequenceStoreId
Required
string | undefined

The Sequence Store ID used for the multipart uploads.

uploadId
Required
string | undefined

The ID for the initiated multipart upload.

filter
ReadSetUploadPartListFilter | undefined

Attributes used to filter for a specific subset of read set part uploads.

maxResults
number | undefined

The maximum number of read set upload parts returned in a page.

nextToken
string | undefined

Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

ListReadSetUploadPartsCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
nextToken
string | undefined

Next token returned in the response of a previous ListReadSetUploadParts call. Used to get the next page of results.

parts
ReadSetUploadPartListItem[] | undefined

An array of upload parts.

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.

NotSupportedOperationException
client

The operation is not supported by Amazon Omics, or the API does not exist.

RequestTimeoutException
client

The request timed out.

ResourceNotFoundException
client

The target resource was not found in the current Region.

ServiceQuotaExceededException
client

The request exceeds a service quota.

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.