GetSchemaVersionsDiff
Fetches the schema version difference in the specified difference type between two stored schema versions in the Schema Registry.
This API allows you to compare two schema versions between two schema definitions under the same schema.
Request Syntax
{
"FirstSchemaVersionNumber": {
"LatestVersion": boolean,
"VersionNumber": number
},
"SchemaDiffType": "string",
"SchemaId": {
"RegistryName": "string",
"SchemaArn": "string",
"SchemaName": "string"
},
"SecondSchemaVersionNumber": {
"LatestVersion": boolean,
"VersionNumber": number
}
}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.
- FirstSchemaVersionNumber
-
The first of the two schema versions to be compared.
Type: SchemaVersionNumber object
Required: Yes
- SchemaDiffType
-
Refers to
SYNTAX_DIFF, which is the currently supported diff type.Type: String
Valid Values:
SYNTAX_DIFFRequired: Yes
- SchemaId
-
This is a wrapper structure to contain schema identity fields. The structure contains:
-
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of
SchemaArnorSchemaNamehas to be provided. -
SchemaId$SchemaName: The name of the schema. One of
SchemaArnorSchemaNamehas to be provided.
Type: SchemaId object
Required: Yes
-
- SecondSchemaVersionNumber
-
The second of the two schema versions to be compared.
Type: SchemaVersionNumber object
Required: Yes
Response Syntax
{
"Diff": "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.
- Diff
-
The difference between schemas as a string in JsonPatch format.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 340000.
Pattern:
.*\S.*
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
- EntityNotFoundException
-
A specified entity does not exist
HTTP Status Code: 400
- InternalServiceException
-
An internal service error occurred.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
