GetAnnotationStoreCommand

Gets information about an annotation store.

Example Syntax

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

import { OmicsClient, GetAnnotationStoreCommand } from "@aws-sdk/client-omics"; // ES Modules import
// const { OmicsClient, GetAnnotationStoreCommand } = require("@aws-sdk/client-omics"); // CommonJS import
const client = new OmicsClient(config);
const input = { // GetAnnotationStoreRequest
  name: "STRING_VALUE", // required
};
const command = new GetAnnotationStoreCommand(input);
const response = await client.send(command);
// { // GetAnnotationStoreResponse
//   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
//   description: "STRING_VALUE", // required
//   sseConfig: { // SseConfig
//     type: "STRING_VALUE", // required
//     keyArn: "STRING_VALUE",
//   },
//   creationTime: new Date("TIMESTAMP"), // required
//   updateTime: new Date("TIMESTAMP"), // required
//   tags: { // TagMap // required
//     "<keys>": "STRING_VALUE",
//   },
//   storeOptions: { // StoreOptions Union: only one key present
//     tsvStoreOptions: { // TsvStoreOptions
//       annotationType: "STRING_VALUE",
//       formatToHeader: { // FormatToHeader
//         "<keys>": "STRING_VALUE",
//       },
//       schema: [ // Schema
//         { // SchemaItem
//           "<keys>": "STRING_VALUE",
//         },
//       ],
//     },
//   },
//   storeFormat: "STRING_VALUE",
//   statusMessage: "STRING_VALUE", // required
//   storeSizeBytes: Number("long"), // required
//   numVersions: Number("int"), // required
// };

GetAnnotationStoreCommand Input

See GetAnnotationStoreCommandInput for more details

Parameter
Type
Description
name
Required
string | undefined

The store's name.

GetAnnotationStoreCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
creationTime
Required
Date | undefined

When the store was created.

description
Required
string | undefined

The store's description.

id
Required
string | undefined

The store's ID.

name
Required
string | undefined

The store's name.

numVersions
Required
number | undefined

An integer indicating how many versions of an annotation store exist.

reference
Required
ReferenceItem | undefined

The store's genome reference.

sseConfig
Required
SseConfig | undefined

The store's server-side encryption (SSE) settings.

status
Required
StoreStatus | undefined

The store's status.

statusMessage
Required
string | undefined

A status message.

storeArn
Required
string | undefined

The store's ARN.

storeSizeBytes
Required
number | undefined

The store's size in bytes.

tags
Required
Record<string, string> | undefined

The store's tags.

updateTime
Required
Date | undefined

When the store was updated.

storeFormat
StoreFormat | undefined

The store's annotation file format.

storeOptions
StoreOptions | undefined

The store's parsing options.

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.