Updates the description of an annotation store version.
Request Syntax
POST /annotationStore/name/version/versionName HTTP/1.1
Content-type: application/json
{
"description": "string"
}URI Request Parameters
The request uses the following URI parameters.
- name
-
The name of an annotation store.
Required: Yes
- versionName
-
The name of an annotation store version.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- description
-
The description of an annotation store.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"creationTime": "string",
"description": "string",
"id": "string",
"name": "string",
"status": "string",
"storeId": "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.
- creationTime
-
The time stamp for when an annotation store version was created.
Type: Timestamp
- description
-
The description of an annotation store version.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
- id
-
The annotation store version ID.
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 of an annotation store.
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 an annotation store version.
Type: String
Valid Values:
CREATING | UPDATING | DELETING | ACTIVE | FAILED - storeId
-
The annotation store ID.
Type: String
Pattern:
[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} - updateTime
-
The time stamp for when an annotation store version was updated.
Type: Timestamp
- versionName
-
The name of an 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:
