- 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.
ListReferenceStoresCommand
Retrieves a list of reference stores.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { OmicsClient, ListReferenceStoresCommand } from "@aws-sdk/client-omics"; // ES Modules import
// const { OmicsClient, ListReferenceStoresCommand } = require("@aws-sdk/client-omics"); // CommonJS import
const client = new OmicsClient(config);
const input = { // ListReferenceStoresRequest
maxResults: Number("int"),
nextToken: "STRING_VALUE",
filter: { // ReferenceStoreFilter
name: "STRING_VALUE",
createdAfter: new Date("TIMESTAMP"),
createdBefore: new Date("TIMESTAMP"),
},
};
const command = new ListReferenceStoresCommand(input);
const response = await client.send(command);
// { // ListReferenceStoresResponse
// nextToken: "STRING_VALUE",
// referenceStores: [ // ReferenceStoreDetailList // required
// { // ReferenceStoreDetail
// arn: "STRING_VALUE", // required
// id: "STRING_VALUE", // required
// name: "STRING_VALUE",
// description: "STRING_VALUE",
// sseConfig: { // SseConfig
// type: "STRING_VALUE", // required
// keyArn: "STRING_VALUE",
// },
// creationTime: new Date("TIMESTAMP"), // required
// },
// ],
// };
ListReferenceStoresCommand Input
See ListReferenceStoresCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
filter | ReferenceStoreFilter | undefined | A filter to apply to the list. |
maxResults | number | undefined | The maximum number of stores to return in one page of results. |
nextToken | string | undefined | Specify the pagination token from a previous request to retrieve the next page of results. |
ListReferenceStoresCommand Output
See ListReferenceStoresCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
referenceStores Required | ReferenceStoreDetail[] | undefined | A list of reference stores. |
nextToken | string | undefined | A pagination token that's included if more results are available. |
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. |
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. |