Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DeleteSchemaVersions

Remove versions from the specified schema. A version number or range may be supplied. If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned. Calling the GetSchemaVersions API after this call will list the status of the deleted versions.

When the range of version numbers contain check pointed version, the API will return a 409 conflict and will not proceed with the deletion. You have to remove the checkpoint first using the DeleteSchemaCheckpoint API before using this API.

You cannot use the DeleteSchemaVersions API to delete the first schema version in the schema set. The first schema version can only be deleted by the DeleteSchema API. This operation will also delete the attached SchemaVersionMetadata under the schema versions. Hard deletes will be enforced on the database.

If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned.

Request Syntax


{
   "SchemaId": { 
      "RegistryName": "string",
      "SchemaArn": "string",
      "SchemaName": "string"
   },
   "Versions": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

SchemaId

This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).

Type: SchemaId object

Required: Yes

Versions

A version range may be supplied which may be of the format:

a single version number, 5
a range, 5-8 : deletes versions 5, 6, 7, 8

Type: String

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

Pattern: [1-9][0-9]*|[1-9][0-9]*-[1-9][0-9]*

Required: Yes

Response Syntax


{
   "SchemaVersionErrors": [ 
      { 
         "ErrorDetails": { 
            "ErrorCode": "string",
            "ErrorMessage": "string"
         },
         "VersionNumber": number
      }
   ]
}

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.

SchemaVersionErrors

A list of SchemaVersionErrorItem objects, each containing an error and schema version.

Type: Array of SchemaVersionErrorItem objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access to a resource was denied.

HTTP Status Code: 400

ConcurrentModificationException

Two processes are trying to modify a resource simultaneously.

HTTP Status Code: 400

EntityNotFoundException

A specified entity does not exist

HTTP Status Code: 400

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400