ListAnnotationStoresCommand

Retrieves a list of annotation stores.

Example Syntax

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

import { OmicsClient, ListAnnotationStoresCommand } from "@aws-sdk/client-omics"; // ES Modules import
// const { OmicsClient, ListAnnotationStoresCommand } = require("@aws-sdk/client-omics"); // CommonJS import
const client = new OmicsClient(config);
const input = { // ListAnnotationStoresRequest
  ids: [ // IdList
    "STRING_VALUE",
  ],
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
  filter: { // ListAnnotationStoresFilter
    status: "STRING_VALUE",
  },
};
const command = new ListAnnotationStoresCommand(input);
const response = await client.send(command);
// { // ListAnnotationStoresResponse
//   annotationStores: [ // AnnotationStoreItems
//     { // AnnotationStoreItem
//       id: "STRING_VALUE", // required
//       reference: { // ReferenceItem Union: only one key present
//         referenceArn: "STRING_VALUE",
//       },
//       status: "STRING_VALUE", // required
//       storeArn: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       storeFormat: "STRING_VALUE", // required
//       description: "STRING_VALUE", // required
//       sseConfig: { // SseConfig
//         type: "STRING_VALUE", // required
//         keyArn: "STRING_VALUE",
//       },
//       creationTime: new Date("TIMESTAMP"), // required
//       updateTime: new Date("TIMESTAMP"), // required
//       statusMessage: "STRING_VALUE", // required
//       storeSizeBytes: Number("long"), // required
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListAnnotationStoresCommand Input

Parameter
Type
Description
filter
ListAnnotationStoresFilter | undefined

A filter to apply to the list.

ids
string[] | undefined

IDs of stores to 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.

ListAnnotationStoresCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
annotationStores
AnnotationStoreItem[] | undefined

A list of stores.

nextToken
string | undefined

A pagination token that's included if more results are available.

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.