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

CreateAnnotationStoreVersion

Creates a new version of an annotation store.

Request Syntax


POST /annotationStore/name/version HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "tags": { 
      "string" : "string" 
   },
   "versionName": "string",
   "versionOptions": { ... }
}

URI Request Parameters

The request uses the following URI parameters.

name

The name of an annotation store version from which versions are being created.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

description

The description of an annotation store version.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

tags

Any tags added to annotation store version.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

versionName

The name given to an annotation store version to distinguish it from other versions.

Type: String

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

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

Required: Yes

versionOptions

The options for an annotation store version.

Type: VersionOptions object

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "id": "string",
   "name": "string",
   "status": "string",
   "storeId": "string",
   "versionName": "string",
   "versionOptions": { ... }
}

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.

creationTime

The time stamp for the creation of an annotation store version.

Type: Timestamp

id

A generated ID for the annotation store

Type: String

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

name

The name given to an annotation store version to distinguish it from other versions.

Type: String

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

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

status

The status of a annotation store version.

Type: String

Valid Values: CREATING | UPDATING | DELETING | ACTIVE | FAILED

storeId

The ID for the annotation store from which new versions are being created.

Type: String

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

versionName

The name given to an annotation store version to distinguish it from other versions.

Type: String

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

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

versionOptions

The options for an annotation store version.

Type: VersionOptions object

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

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

ConflictException

The request cannot be applied to the target resource in its current state.

HTTP Status Code: 409

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