StartAnnotationImportJob
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.
Starts an annotation import job.
Request Syntax
POST /import/annotation HTTP/1.1
Content-type: application/json
{
"annotationFields": {
"string" : "string"
},
"destinationName": "string",
"formatOptions": { ... },
"items": [
{
"source": "string"
}
],
"roleArn": "string",
"runLeftNormalization": boolean,
"versionName": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- annotationFields
-
The annotation schema generated by the parsed annotation data.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 21.
Value Length Constraints: Minimum length of 1. Maximum length of 21.
Required: No
- destinationName
-
A destination annotation store for the job.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern:
([a-z]){1}([a-z0-9_]){2,254}Required: Yes
- formatOptions
-
Formatting options for the annotation file.
Type: FormatOptions object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- items
-
Items to import.
Type: Array of AnnotationImportItemSource objects
Array Members: Minimum number of 1 item.
Required: Yes
- roleArn
-
A service role for the job.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)Required: Yes
- runLeftNormalization
-
The job's left normalization setting.
Type: Boolean
Required: No
- versionName
-
The name of the annotation store version.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern:
([a-z]){1}([a-z0-9_]){2,254}Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"jobId": "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.
- jobId
-
The job's ID.
Type: String
Pattern:
[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}
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
- ServiceQuotaExceededException
-
The request exceeds a service quota.
HTTP Status Code: 402
- 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:
