Schema registry

• RegistryId structure

• RegistryListItem structure

• MetadataInfo structure

• OtherMetadataValueListItem structure

• SchemaListItem structure

• SchemaVersionListItem structure

• MetadataKeyValuePair structure

• SchemaVersionErrorItem structure

• ErrorDetails structure

• SchemaVersionNumber structure

• SchemaId structure

Fields

• RegistryName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  Name of the registry. Used only for lookup. One of RegistryArn or RegistryName has to be provided.

• RegistryArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

  Arn of the registry to be updated. One of RegistryArn or RegistryName has to be provided.

Fields

• RegistryName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  The name of the registry.

• RegistryArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

  The Amazon Resource Name (ARN) of the registry.

• Description – Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern.

  A description of the registry.

• Status – UTF-8 string (valid values: AVAILABLE | DELETING).

  The status of the registry.

• CreatedTime – UTF-8 string.

  The data the registry was created.

• UpdatedTime – UTF-8 string.

  The date the registry was updated.

Fields

• MetadataValue – UTF-8 string, not less than 1 or more than 256 bytes long, matching the Custom string pattern #34.

  The metadata key's corresponding value.

• CreatedTime – UTF-8 string.

  The time at which the entry was created.

• OtherMetadataValueList – An array of OtherMetadataValueListItem objects.

  Other metadata belonging to the same metadata key.

Fields

• MetadataValue – UTF-8 string, not less than 1 or more than 256 bytes long, matching the Custom string pattern #34.

  The metadata key's corresponding value for the other metadata belonging to the same metadata key.

• CreatedTime – UTF-8 string.

  The time at which the entry was created.

Fields

• RegistryName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  the name of the registry where the schema resides.

• SchemaName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  The name of the schema.

• SchemaArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

  The Amazon Resource Name (ARN) for the schema.

• Description – Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern.

  A description for the schema.

• SchemaStatus – UTF-8 string (valid values: AVAILABLE | PENDING | DELETING).

  The status of the schema.

• CreatedTime – UTF-8 string.

  The date and time that a schema was created.

• UpdatedTime – UTF-8 string.

  The date and time that a schema was updated.

Fields

• SchemaArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

  The Amazon Resource Name (ARN) of the schema.

• SchemaVersionId – UTF-8 string, not less than 36 or more than 36 bytes long, matching the Custom string pattern #17.

  The unique identifier of the schema version.

• VersionNumber – Number (long), not less than 1 or more than 100000.

  The version number of the schema.

• Status – UTF-8 string (valid values: AVAILABLE | PENDING | FAILURE | DELETING).

  The status of the schema version.

• CreatedTime – UTF-8 string.

  The date and time the schema version was created.

Fields

• MetadataKey – UTF-8 string, not less than 1 or more than 128 bytes long, matching the Custom string pattern #34.

  A metadata key.

• MetadataValue – UTF-8 string, not less than 1 or more than 256 bytes long, matching the Custom string pattern #34.

  A metadata key's corresponding value.

Fields

• VersionNumber – Number (long), not less than 1 or more than 100000.

  The version number of the schema.

• ErrorDetails – An ErrorDetails object.

  The details of the error for the schema version.

Fields

• ErrorCode – UTF-8 string.

  The error code for an error.

• ErrorMessage – UTF-8 string.

  The error message for an error.

Fields

• LatestVersion – Boolean.

  The latest version available for the schema.

• VersionNumber – Number (long), not less than 1 or more than 100000.

  The version number of the schema.

Fields

• SchemaArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

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

• SchemaName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

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

• RegistryName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  The name of the schema registry that contains the schema.

• CreateRegistry action (Python: create_registry)

• CreateSchema action (Python: create_schema)

• GetSchema action (Python: get_schema)

• ListSchemaVersions action (Python: list_schema_versions)

• GetSchemaVersion action (Python: get_schema_version)

• GetSchemaVersionsDiff action (Python: get_schema_versions_diff)

• ListRegistries action (Python: list_registries)

• ListSchemas action (Python: list_schemas)

• RegisterSchemaVersion action (Python: register_schema_version)

• UpdateSchema action (Python: update_schema)

• CheckSchemaVersionValidity action (Python: check_schema_version_validity)

• UpdateRegistry action (Python: update_registry)

• GetSchemaByDefinition action (Python: get_schema_by_definition)

• GetRegistry action (Python: get_registry)

• PutSchemaVersionMetadata action (Python: put_schema_version_metadata)

• QuerySchemaVersionMetadata action (Python: query_schema_version_metadata)

• RemoveSchemaVersionMetadata action (Python: remove_schema_version_metadata)

• DeleteRegistry action (Python: delete_registry)

• DeleteSchema action (Python: delete_schema)

• DeleteSchemaVersions action (Python: delete_schema_versions)

Request

• RegistryName – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  Name of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.

• Description – Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern.

  A description of the registry. If description is not provided, there will not be any default value for this.

• Tags – A map array of key-value pairs, not more than 50 pairs.

  Each key is a UTF-8 string, not less than 1 or more than 128 bytes long.

  Each value is a UTF-8 string, not more than 256 bytes long.

  AWS tags that contain a key value pair and may be searched by console, command line, or API.

Response

• RegistryArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

  The Amazon Resource Name (ARN) of the newly created registry.

• RegistryName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  The name of the registry.

• Description – Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern.

  A description of the registry.

• Tags – A map array of key-value pairs, not more than 50 pairs.

  Each key is a UTF-8 string, not less than 1 or more than 128 bytes long.

  Each value is a UTF-8 string, not more than 256 bytes long.

  The tags for the registry.

Errors

• InvalidInputException

• AccessDeniedException

• AlreadyExistsException

• ResourceNumberLimitExceededException

• ConcurrentModificationException

• InternalServiceException

Request

• RegistryId – A RegistryId object.

  This is a wrapper shape to contain the registry identity fields. If this is not provided, the default registry will be used. The ARN format for the same will be: arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id.

• SchemaName – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  Name of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.

• DataFormat – Required: UTF-8 string (valid values: AVRO | JSON | PROTOBUF).

  The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

• Compatibility – UTF-8 string (valid values: NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL).

  The compatibility mode of the schema. The possible values are:

  • NONE: No compatibility mode applies. You can use this choice in development scenarios or if you do not know the compatibility mode that you want to apply to schemas. Any new version added will be accepted without undergoing a compatibility check.

  • DISABLED: This compatibility choice prevents versioning for a particular schema. You can use this choice to prevent future versioning of a schema.

  • BACKWARD: This compatibility choice is recommended as it allows data receivers to read both the current and one previous schema version. This means that for instance, a new schema version cannot drop data fields or change the type of these fields, so they can't be read by readers using the previous version.

  • BACKWARD_ALL: This compatibility choice allows data receivers to read both the current and all previous schema versions. You can use this choice when you need to delete fields or add optional fields, and check compatibility against all previous schema versions.

  • FORWARD: This compatibility choice allows data receivers to read both the current and one next schema version, but not necessarily later versions. You can use this choice when you need to add fields or delete optional fields, but only check compatibility against the last schema version.

  • FORWARD_ALL: This compatibility choice allows data receivers to read written by producers of any new registered schema. You can use this choice when you need to add fields or delete optional fields, and check compatibility against all previous schema versions.

  • FULL: This compatibility choice allows data receivers to read data written by producers using the previous or next version of the schema, but not necessarily earlier or later versions. You can use this choice when you need to add or remove optional fields, but only check compatibility against the last schema version.

  • FULL_ALL: This compatibility choice allows data receivers to read data written by producers using all previous schema versions. You can use this choice when you need to add or remove optional fields, and check compatibility against all previous schema versions.

• Description – Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern.

  An optional description of the schema. If description is not provided, there will not be any automatic default value for this.

• Tags – A map array of key-value pairs, not more than 50 pairs.

  Each key is a UTF-8 string, not less than 1 or more than 128 bytes long.

  Each value is a UTF-8 string, not more than 256 bytes long.

  AWS tags that contain a key value pair and may be searched by console, command line, or API. If specified, follows the AWS tags-on-create pattern.

• SchemaDefinition – UTF-8 string, not less than 1 or more than 170000 bytes long, matching the Custom string pattern #33.

  The schema definition using the DataFormat setting for SchemaName.

Response

• RegistryName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  The name of the registry.

• RegistryArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

  The Amazon Resource Name (ARN) of the registry.

• SchemaName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  The name of the schema.

• SchemaArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

  The Amazon Resource Name (ARN) of the schema.

• Description – Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern.

  A description of the schema if specified when created.

• DataFormat – UTF-8 string (valid values: AVRO | JSON | PROTOBUF).

  The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

• Compatibility – UTF-8 string (valid values: NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL).

  The schema compatibility mode.

• SchemaCheckpoint – Number (long), not less than 1 or more than 100000.

  The version number of the checkpoint (the last time the compatibility mode was changed).

• LatestSchemaVersion – Number (long), not less than 1 or more than 100000.

  The latest version of the schema associated with the returned schema definition.

• NextSchemaVersion – Number (long), not less than 1 or more than 100000.

  The next version of the schema associated with the returned schema definition.

• SchemaStatus – UTF-8 string (valid values: AVAILABLE | PENDING | DELETING).

  The status of the schema.

• Tags – A map array of key-value pairs, not more than 50 pairs.

  Each key is a UTF-8 string, not less than 1 or more than 128 bytes long.

  Each value is a UTF-8 string, not more than 256 bytes long.

  The tags for the schema.

• SchemaVersionId – UTF-8 string, not less than 36 or more than 36 bytes long, matching the Custom string pattern #17.

  The unique identifier of the first schema version.

• SchemaVersionStatus – UTF-8 string (valid values: AVAILABLE | PENDING | FAILURE | DELETING).

  The status of the first schema version created.

Errors

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• AlreadyExistsException

• ResourceNumberLimitExceededException

• ConcurrentModificationException

• InternalServiceException

Request

• SchemaId – Required: A SchemaId object.

  This is a wrapper structure to contain schema identity fields. The structure contains:

  • SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.

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

Response

• RegistryName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  The name of the registry.

• RegistryArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

  The Amazon Resource Name (ARN) of the registry.

• SchemaName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  The name of the schema.

• SchemaArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

  The Amazon Resource Name (ARN) of the schema.

• Description – Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern.

  A description of schema if specified when created

• DataFormat – UTF-8 string (valid values: AVRO | JSON | PROTOBUF).

  The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

• Compatibility – UTF-8 string (valid values: NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL).

  The compatibility mode of the schema.

• SchemaCheckpoint – Number (long), not less than 1 or more than 100000.

  The version number of the checkpoint (the last time the compatibility mode was changed).

• LatestSchemaVersion – Number (long), not less than 1 or more than 100000.

  The latest version of the schema associated with the returned schema definition.

• NextSchemaVersion – Number (long), not less than 1 or more than 100000.

  The next version of the schema associated with the returned schema definition.

• SchemaStatus – UTF-8 string (valid values: AVAILABLE | PENDING | DELETING).

  The status of the schema.

• CreatedTime – UTF-8 string.

  The date and time the schema was created.

• UpdatedTime – UTF-8 string.

  The date and time the schema was updated.

Errors

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• InternalServiceException

Request

• SchemaId – Required: A SchemaId object.

  This is a wrapper structure to contain schema identity fields. The structure contains:

  • SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.

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

• MaxResults – Number (integer), not less than 1 or more than 100.

  Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.

• NextToken – UTF-8 string.

  A continuation token, if this is a continuation call.

Response

• Schemas – An array of SchemaVersionListItem objects.

  An array of SchemaVersionList objects containing details of each schema version.

• NextToken – UTF-8 string.

  A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

Errors

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• InternalServiceException

Request

• SchemaId – A SchemaId object.

  This is a wrapper structure to contain schema identity fields. The structure contains:

  • SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.

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

• SchemaVersionId – UTF-8 string, not less than 36 or more than 36 bytes long, matching the Custom string pattern #17.

  The SchemaVersionId of the schema version. This field is required for fetching by schema ID. Either this or the SchemaId wrapper has to be provided.

• SchemaVersionNumber – A SchemaVersionNumber object.

  The version number of the schema.

Response

• SchemaVersionId – UTF-8 string, not less than 36 or more than 36 bytes long, matching the Custom string pattern #17.

  The SchemaVersionId of the schema version.

• SchemaDefinition – UTF-8 string, not less than 1 or more than 170000 bytes long, matching the Custom string pattern #33.

  The schema definition for the schema ID.

• DataFormat – UTF-8 string (valid values: AVRO | JSON | PROTOBUF).

  The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

• SchemaArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

  The Amazon Resource Name (ARN) of the schema.

• VersionNumber – Number (long), not less than 1 or more than 100000.

  The version number of the schema.

• Status – UTF-8 string (valid values: AVAILABLE | PENDING | FAILURE | DELETING).

  The status of the schema version.

• CreatedTime – UTF-8 string.

  The date and time the schema version was created.

Errors

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• InternalServiceException

Request

• SchemaId – Required: A SchemaId object.

  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.

• FirstSchemaVersionNumber – Required: A SchemaVersionNumber object.

  The first of the two schema versions to be compared.

• SecondSchemaVersionNumber – Required: A SchemaVersionNumber object.

  The second of the two schema versions to be compared.

• SchemaDiffType – Required: UTF-8 string (valid values: SYNTAX_DIFF).

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

Response

• Diff – UTF-8 string, not less than 1 or more than 340000 bytes long, matching the Custom string pattern #33.

  The difference between schemas as a string in JsonPatch format.

Errors

• InvalidInputException

• EntityNotFoundException

• AccessDeniedException

• InternalServiceException

Request

• MaxResults – Number (integer), not less than 1 or more than 100.

  Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.

• NextToken – UTF-8 string.

  A continuation token, if this is a continuation call.

Response

• Registries – An array of RegistryListItem objects.

  An array of RegistryDetailedListItem objects containing minimal details of each registry.

• NextToken – UTF-8 string.

  A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

Errors

• InvalidInputException

• AccessDeniedException

• InternalServiceException

Request

• RegistryId – A RegistryId object.

  A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).

• MaxResults – Number (integer), not less than 1 or more than 100.

  Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.

• NextToken – UTF-8 string.

  A continuation token, if this is a continuation call.

Response

• Schemas – An array of SchemaListItem objects.

  An array of SchemaListItem objects containing details of each schema.

• NextToken – UTF-8 string.

  A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

Errors

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• InternalServiceException

Request

• SchemaId – Required: A SchemaId object.

  This is a wrapper structure to contain schema identity fields. The structure contains:

  • SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.

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

• SchemaDefinition – Required: UTF-8 string, not less than 1 or more than 170000 bytes long, matching the Custom string pattern #33.

  The schema definition using the DataFormat setting for the SchemaName.

Response

• SchemaVersionId – UTF-8 string, not less than 36 or more than 36 bytes long, matching the Custom string pattern #17.

  The unique ID that represents the version of this schema.

• VersionNumber – Number (long), not less than 1 or more than 100000.

  The version of this schema (for sync flow only, in case this is the first version).

• Status – UTF-8 string (valid values: AVAILABLE | PENDING | FAILURE | DELETING).

  The status of the schema version.

Errors

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• ResourceNumberLimitExceededException

• ConcurrentModificationException

• InternalServiceException

Request

• SchemaId – Required: A SchemaId object.

  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.

• SchemaVersionNumber – A SchemaVersionNumber object.

  Version number required for check pointing. One of VersionNumber or Compatibility has to be provided.

• Compatibility – UTF-8 string (valid values: NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL).

  The new compatibility setting for the schema.

• Description – Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern.

  The new description for the schema.

Response

• SchemaArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

  The Amazon Resource Name (ARN) of the schema.

• SchemaName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  The name of the schema.

• RegistryName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  The name of the registry that contains the schema.

Errors

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• ConcurrentModificationException

• InternalServiceException

Request

• DataFormat – Required: UTF-8 string (valid values: AVRO | JSON | PROTOBUF).

  The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

• SchemaDefinition – Required: UTF-8 string, not less than 1 or more than 170000 bytes long, matching the Custom string pattern #33.

  The definition of the schema that has to be validated.

Response

• Valid – Boolean.

  Return true, if the schema is valid and false otherwise.

• Error – UTF-8 string, not less than 1 or more than 5000 bytes long.

  A validation failure error message.

Errors

• InvalidInputException

• AccessDeniedException

• InternalServiceException

Request

• RegistryId – Required: A RegistryId object.

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

• Description – Required: Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern.

  A description of the registry. If description is not provided, this field will not be updated.

Response

• RegistryName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  The name of the updated registry.

• RegistryArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

  The Amazon Resource name (ARN) of the updated registry.

Errors

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• ConcurrentModificationException

• InternalServiceException

Request

• SchemaId – Required: A SchemaId object.

  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.

• SchemaDefinition – Required: UTF-8 string, not less than 1 or more than 170000 bytes long, matching the Custom string pattern #33.

  The definition of the schema for which schema details are required.

Response

• SchemaVersionId – UTF-8 string, not less than 36 or more than 36 bytes long, matching the Custom string pattern #17.

  The schema ID of the schema version.

• SchemaArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

  The Amazon Resource Name (ARN) of the schema.

• DataFormat – UTF-8 string (valid values: AVRO | JSON | PROTOBUF).

  The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

• Status – UTF-8 string (valid values: AVAILABLE | PENDING | FAILURE | DELETING).

  The status of the schema version.

• CreatedTime – UTF-8 string.

  The date and time the schema was created.

Errors

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• InternalServiceException

Request

• RegistryId – Required: A RegistryId object.

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

Response

• RegistryName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  The name of the registry.

• RegistryArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

  The Amazon Resource Name (ARN) of the registry.

• Description – Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern.

  A description of the registry.

• Status – UTF-8 string (valid values: AVAILABLE | DELETING).

  The status of the registry.

• CreatedTime – UTF-8 string.

  The date and time the registry was created.

• UpdatedTime – UTF-8 string.

  The date and time the registry was updated.

Errors

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• InternalServiceException

Request

• SchemaId – A SchemaId object.

  The unique ID for the schema.

• SchemaVersionNumber – A SchemaVersionNumber object.

  The version number of the schema.

• SchemaVersionId – UTF-8 string, not less than 36 or more than 36 bytes long, matching the Custom string pattern #17.

  The unique version ID of the schema version.

• MetadataKeyValue – Required: A MetadataKeyValuePair object.

  The metadata key's corresponding value.

Response

• SchemaArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

  The Amazon Resource Name (ARN) for the schema.

• SchemaName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  The name for the schema.

• RegistryName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  The name for the registry.

• LatestVersion – Boolean.

  The latest version of the schema.

• VersionNumber – Number (long), not less than 1 or more than 100000.

  The version number of the schema.

• SchemaVersionId – UTF-8 string, not less than 36 or more than 36 bytes long, matching the Custom string pattern #17.

  The unique version ID of the schema version.

• MetadataKey – UTF-8 string, not less than 1 or more than 128 bytes long, matching the Custom string pattern #34.

  The metadata key.

• MetadataValue – UTF-8 string, not less than 1 or more than 256 bytes long, matching the Custom string pattern #34.

  The value of the metadata key.

Errors

• InvalidInputException

• AccessDeniedException

• AlreadyExistsException

• EntityNotFoundException

• ResourceNumberLimitExceededException

Request

• SchemaId – A SchemaId object.

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

• SchemaVersionNumber – A SchemaVersionNumber object.

  The version number of the schema.

• SchemaVersionId – UTF-8 string, not less than 36 or more than 36 bytes long, matching the Custom string pattern #17.

  The unique version ID of the schema version.

• MetadataList – An array of MetadataKeyValuePair objects.

  Search key-value pairs for metadata, if they are not provided all the metadata information will be fetched.

• MaxResults – Number (integer), not less than 1 or more than 50.

  Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.

• NextToken – UTF-8 string.

  A continuation token, if this is a continuation call.

Response

• MetadataInfoMap – A map array of key-value pairs.

  Each key is a UTF-8 string, not less than 1 or more than 128 bytes long, matching the Custom string pattern #34.

  Each value is a A MetadataInfo object.

  A map of a metadata key and associated values.

• SchemaVersionId – UTF-8 string, not less than 36 or more than 36 bytes long, matching the Custom string pattern #17.

  The unique version ID of the schema version.

• NextToken – UTF-8 string.

  A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

Errors

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

Request

• SchemaId – A SchemaId object.

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

• SchemaVersionNumber – A SchemaVersionNumber object.

  The version number of the schema.

• SchemaVersionId – UTF-8 string, not less than 36 or more than 36 bytes long, matching the Custom string pattern #17.

  The unique version ID of the schema version.

• MetadataKeyValue – Required: A MetadataKeyValuePair object.

  The value of the metadata key.

Response

• SchemaArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

  The Amazon Resource Name (ARN) of the schema.

• SchemaName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  The name of the schema.

• RegistryName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  The name of the registry.

• LatestVersion – Boolean.

  The latest version of the schema.

• VersionNumber – Number (long), not less than 1 or more than 100000.

  The version number of the schema.

• SchemaVersionId – UTF-8 string, not less than 36 or more than 36 bytes long, matching the Custom string pattern #17.

  The version ID for the schema version.

• MetadataKey – UTF-8 string, not less than 1 or more than 128 bytes long, matching the Custom string pattern #34.

  The metadata key.

• MetadataValue – UTF-8 string, not less than 1 or more than 256 bytes long, matching the Custom string pattern #34.

  The value of the metadata key.

Errors

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

Request

• RegistryId – Required: A RegistryId object.

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

Response

• RegistryName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  The name of the registry being deleted.

• RegistryArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

  The Amazon Resource Name (ARN) of the registry being deleted.

• Status – UTF-8 string (valid values: AVAILABLE | DELETING).

  The status of the registry. A successful operation will return the Deleting status.

Errors

• InvalidInputException

• EntityNotFoundException

• AccessDeniedException

• ConcurrentModificationException

Request

• SchemaId – Required: A SchemaId object.

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

Response

• SchemaArn – UTF-8 string, not less than 1 or more than 10240 bytes long, matching the Custom string pattern #22.

  The Amazon Resource Name (ARN) of the schema being deleted.

• SchemaName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Custom string pattern #18.

  The name of the schema being deleted.

• Status – UTF-8 string (valid values: AVAILABLE | PENDING | DELETING).

  The status of the schema.

Errors

• InvalidInputException

• EntityNotFoundException

• AccessDeniedException

• ConcurrentModificationException

Request

• SchemaId – Required: A SchemaId object.

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

• Versions – Required: UTF-8 string, not less than 1 or more than 100000 bytes long, matching the Custom string pattern #35.

  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

Response

• SchemaVersionErrors – An array of SchemaVersionErrorItem objects.

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

Errors

• InvalidInputException

• EntityNotFoundException

• AccessDeniedException

• ConcurrentModificationException