[ aws . glue ]

get-schema-versions-diff

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-schema-versions-diff
--schema-id <value>
--first-schema-version-number <value>
--second-schema-version-number <value>
--schema-diff-type <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--schema-id (structure)

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 SchemaArn or SchemaName has to be provided.

  • SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName has to be provided.

SchemaArn -> (string)

The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.

SchemaName -> (string)

The name of the schema. One of SchemaArn or SchemaName has to be provided.

RegistryName -> (string)

The name of the schema registry that contains the schema.

Shorthand Syntax:

SchemaArn=string,SchemaName=string,RegistryName=string

JSON Syntax:

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

--first-schema-version-number (structure)

The first of the two schema versions to be compared.

LatestVersion -> (boolean)

The latest version available for the schema.

VersionNumber -> (long)

The version number of the schema.

Shorthand Syntax:

LatestVersion=boolean,VersionNumber=long

JSON Syntax:

{
  "LatestVersion": true|false,
  "VersionNumber": long
}

--second-schema-version-number (structure)

The second of the two schema versions to be compared.

LatestVersion -> (boolean)

The latest version available for the schema.

VersionNumber -> (long)

The version number of the schema.

Shorthand Syntax:

LatestVersion=boolean,VersionNumber=long

JSON Syntax:

{
  "LatestVersion": true|false,
  "VersionNumber": long
}

--schema-diff-type (string)

Refers to SYNTAX_DIFF , which is the currently supported diff type.

Possible values:

  • SYNTAX_DIFF

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Diff -> (string)

The difference between schemas as a string in JsonPatch format.