ListAnnotationStoreVersions - HealthOmics API Reference

ListAnnotationStoreVersions

Lists the versions of an annotation store.

Request Syntax

POST /annotationStore/name/versions?maxResults=maxResults&nextToken=nextToken HTTP/1.1 Content-type: application/json { "filter": { "status": "string" } }

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of annotation store versions to return in one page of results.

Valid Range: Minimum value of 1. Maximum value of 100.

name

The name of an annotation store.

Required: Yes

nextToken

Specifies the pagination token from a previous request to retrieve the next page of results.

Length Constraints: Minimum length of 1. Maximum length of 10000.

Request Body

The request accepts the following data in JSON format.

filter

A filter to apply to the list of annotation store versions.

Type: ListAnnotationStoreVersionsFilter object

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "annotationStoreVersions": [ { "creationTime": "string", "description": "string", "id": "string", "name": "string", "status": "string", "statusMessage": "string", "storeId": "string", "updateTime": "string", "versionArn": "string", "versionName": "string", "versionSizeBytes": number } ], "nextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

annotationStoreVersions

Lists all versions of an annotation store.

Type: Array of AnnotationStoreVersionItem objects

nextToken

Specifies the pagination token from a previous request to retrieve the next page of results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred. Try the request again.

HTTP Status Code: 500

ResourceNotFoundException

The target resource was not found in the current Region.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: