GetAnnotationImportJob - HealthOmics API Reference

GetAnnotationImportJob

Gets information about an annotation import job.

Request Syntax

GET /import/annotation/jobId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

jobId

The job's ID.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "annotationFields": { "string" : "string" }, "completionTime": "string", "creationTime": "string", "destinationName": "string", "formatOptions": { ... }, "id": "string", "items": [ { "jobStatus": "string", "source": "string" } ], "roleArn": "string", "runLeftNormalization": boolean, "status": "string", "statusMessage": "string", "updateTime": "string", "versionName": "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.

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.

completionTime

When the job completed.

Type: Timestamp

creationTime

When the job was created.

Type: Timestamp

destinationName

The job's destination annotation store.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Pattern: ([a-z]){1}([a-z0-9_]){2,254}

formatOptions

Formatting options for a file.

Type: FormatOptions object

Note: This object is a Union. Only one member of this object can be specified or returned.

id

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}

items

The job's imported items.

Type: Array of AnnotationImportItemDetail objects

Array Members: Fixed number of 1 item.

roleArn

The job's service role ARN.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)

runLeftNormalization

The job's left normalization setting.

Type: Boolean

status

The job's status.

Type: String

Valid Values: SUBMITTED | IN_PROGRESS | CANCELLED | COMPLETED | FAILED | COMPLETED_WITH_FAILURES

statusMessage

The job's status message.

Type: String

updateTime

When the job was updated.

Type: Timestamp

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}

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: