Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListAnnotationImportJobs

Important

AWS HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS HealthOmics variant store and annotation store availability change.

Retrieves a list of annotation import jobs.

Request Syntax


POST /import/annotations?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "status": "string",
      "storeName": "string"
   },
   "ids": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of jobs to return in one page of results.

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

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.

Type: ListAnnotationImportJobsFilter object

Required: No

ids

IDs of annotation import jobs to retrieve.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 20 items.

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "annotationImportJobs": [ 
      { 
         "annotationFields": { 
            "string" : "string" 
         },
         "completionTime": "string",
         "creationTime": "string",
         "destinationName": "string",
         "id": "string",
         "roleArn": "string",
         "runLeftNormalization": boolean,
         "status": "string",
         "updateTime": "string",
         "versionName": "string"
      }
   ],
   "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.

annotationImportJobs

A list of jobs.

Type: Array of AnnotationImportJobItem 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