# Registro de esquemas
A API de registro de esquemas descreve os tipos de dados e a API relacionada ao trabalho com esquemas no AWS Glue.
## Tipos de dados
+ [Estrutura RegistryId](#aws-glue-api-schema-registry-api-RegistryId)
+ [Estrutura RegistryListItem](#aws-glue-api-schema-registry-api-RegistryListItem)
+ [Estrutura MetadataInfo](#aws-glue-api-schema-registry-api-MetadataInfo)
+ [Estrutura OtherMetadataValueListItem](#aws-glue-api-schema-registry-api-OtherMetadataValueListItem)
+ [Estrutura SchemaListItem](#aws-glue-api-schema-registry-api-SchemaListItem)
+ [Estrutura SchemaVersionListItem](#aws-glue-api-schema-registry-api-SchemaVersionListItem)
+ [Estrutura MetadataKeyValuePair](#aws-glue-api-schema-registry-api-MetadataKeyValuePair)
+ [Estrutura SchemaVersionErrorItem](#aws-glue-api-schema-registry-api-SchemaVersionErrorItem)
+ [Estrutura ErrorDetails](#aws-glue-api-schema-registry-api-ErrorDetails)
+ [Estrutura SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber)
+ [Estrutura SchemaId](#aws-glue-api-schema-registry-api-SchemaId)
## Estrutura RegistryId
Uma estrutura de wrapper que pode conter o nome de registro e o nome do recurso da Amazon (ARN).
**Campos**
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
Nome do registro. Usado apenas para pesquisa. Um de `RegistryArn` ou `RegistryName` tem de ser fornecido.
+ `RegistryArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
ARN do registro a ser atualizado. Um de `RegistryArn` ou `RegistryName` tem de ser fornecido.
## Estrutura RegistryListItem
Uma estrutura que contém os detalhes de um registro.
**Campos**
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do registro.
+ `RegistryArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
O nome de recurso da Amazon (ARN) do registro.
+ `Description` – string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Uma descrição do registro.
+ `Status` – string UTF-8 (valores válidos: `AVAILABLE` \$1 `DELETING`).
O status do registro.
+ `CreatedTime` – String UTF-8.
A data em que o registro foi criado.
+ `UpdatedTime` – String UTF-8.
A data em que o registro foi atualizado.
## Estrutura MetadataInfo
Uma estrutura que contém informações de metadados para uma versão do esquema.
**Campos**
+ `MetadataValue` – string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a [Custom string pattern #14](aws-glue-api-common.md#regex_14).
O valor correspondente da chave de metadados.
+ `CreatedTime` – String UTF-8.
A hora em que a entrada foi criada.
+ `OtherMetadataValueList`: um array de objetos [OtherMetadataValueListItem](#aws-glue-api-schema-registry-api-OtherMetadataValueListItem).
Outros metadados pertencentes à mesma chave de metadados.
## Estrutura OtherMetadataValueListItem
Uma estrutura que contém outros metadados para uma versão do esquema pertencente à mesma chave de metadados.
**Campos**
+ `MetadataValue` – string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a [Custom string pattern #14](aws-glue-api-common.md#regex_14).
O valor correspondente da chave de metadados para os outros metadados pertencentes à mesma chave de metadados.
+ `CreatedTime` – String UTF-8.
A hora em que a entrada foi criada.
## Estrutura SchemaListItem
Um objeto que contém detalhes mínimos para um esquema.
**Campos**
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do registro em que o esquema reside.
+ `SchemaName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do esquema.
+ `SchemaArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
O nome do recurso da Amazon (ARN) do esquema.
+ `Description` – string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Uma descrição para o esquema.
+ `SchemaStatus` – string UTF-8 (valores válidos: `AVAILABLE` \$1 `PENDING` \$1 `DELETING`).
O status do esquema.
+ `CreatedTime` – String UTF-8.
A data e a hora em que o esquema foi criado.
+ `UpdatedTime` – String UTF-8.
A data e a hora em que o esquema foi atualizado.
## Estrutura SchemaVersionListItem
Um objeto que contém os detalhes sobre uma versão do esquema.
**Campos**
+ `SchemaArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
O nome de recurso da Amazon (ARN) do esquema.
+ `SchemaVersionId` – string UTF-8, não menos do que 36 ou superior a 36 bytes de comprimento, correspondente a [Custom string pattern #45](aws-glue-api-common.md#regex_45).
O identificador exclusivo da versão do esquema.
+ `VersionNumber`: número (inteiro longo), não menos do que 1 ou superior a 100.000.
O número da versão do esquema.
+ `Status` – String UTF-8 (valores válidos: `AVAILABLE` \$1 `PENDING` \$1 `FAILURE` \$1 `DELETING`).
O status da versão do esquema.
+ `CreatedTime` – String UTF-8.
A data e hora em que a versão do esquema foi criada.
## Estrutura MetadataKeyValuePair
Uma estrutura que contém um par de chave-valor para metadados.
**Campos**
+ `MetadataKey` – string UTF-8, não menos do que 1 ou superior a 128 bytes de comprimento, correspondente a [Custom string pattern #14](aws-glue-api-common.md#regex_14).
Uma chave de metadados.
+ `MetadataValue` – string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a [Custom string pattern #14](aws-glue-api-common.md#regex_14).
O valor correspondente de uma chave de metadados.
## Estrutura SchemaVersionErrorItem
Um objeto que contém os detalhes de erro de uma operação em uma versão do esquema.
**Campos**
+ `VersionNumber`: número (inteiro longo), não menos do que 1 ou superior a 100.000.
O número da versão do esquema.
+ `ErrorDetails` – Um objeto [ErrorDetails](#aws-glue-api-schema-registry-api-ErrorDetails).
Os detalhes do erro para a versão do esquema.
## Estrutura ErrorDetails
Um objeto que contém detalhes do erro.
**Campos**
+ `ErrorCode` – String UTF-8.
O código de erro para um erro.
+ `ErrorMessage` – String UTF-8.
A mensagem de erro para um erro.
## Estrutura SchemaVersionNumber
Uma estrutura que contém as informações da versão do esquema.
**Campos**
+ `LatestVersion` – Booleano.
A versão mais recente disponível para o esquema.
+ `VersionNumber`: número (inteiro longo), não menos do que 1 ou superior a 100.000.
O número da versão do esquema.
## Estrutura SchemaId
O ID exclusivo do esquema no registro de esquemas do AWS Glue.
**Campos**
+ `SchemaArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
O nome de recurso da Amazon (ARN) do esquema. Um de `SchemaArn` ou `SchemaName` tem de ser fornecido.
+ `SchemaName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do esquema. Um de `SchemaArn` ou `SchemaName` tem de ser fornecido.
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do registro do esquema que contém o esquema.
## Operações
+ [Ação CreateRegistry (Python: create\$1registry)](#aws-glue-api-schema-registry-api-CreateRegistry)
+ [Ação CreateSchema (Python: create\$1esquema)](#aws-glue-api-schema-registry-api-CreateSchema)
+ [Ação GetSchema (Python: get\$1schema)](#aws-glue-api-schema-registry-api-GetSchema)
+ [Ação ListSchemaVersions (Python: list\$1schema\$1versions)](#aws-glue-api-schema-registry-api-ListSchemaVersions)
+ [Ação GetSchemaVersion (Python: get\$1schema\$1version)](#aws-glue-api-schema-registry-api-GetSchemaVersion)
+ [Ação GetSchemaVersionsDiff (Python: get\$1schema\$1versions\$1diff)](#aws-glue-api-schema-registry-api-GetSchemaVersionsDiff)
+ [Ação ListRegistries (Python: list\$1registries)](#aws-glue-api-schema-registry-api-ListRegistries)
+ [Ação ListSchemas (Python: list\$1schemas)](#aws-glue-api-schema-registry-api-ListSchemas)
+ [Ação RegisterSchemaVersion (Python: register\$1schema\$1version)](#aws-glue-api-schema-registry-api-RegisterSchemaVersion)
+ [Ação UpdateSchema (Python: update\$1schema)](#aws-glue-api-schema-registry-api-UpdateSchema)
+ [Ação CheckSchemaVersionValidity (Python: check\$1schema\$1version\$1validity)](#aws-glue-api-schema-registry-api-CheckSchemaVersionValidity)
+ [Ação UpdateRegistry (Python: update\$1registry)](#aws-glue-api-schema-registry-api-UpdateRegistry)
+ [Ação GetSchemaByDefinition (Python: get\$1schema\$1by\$1definition)](#aws-glue-api-schema-registry-api-GetSchemaByDefinition)
+ [Ação GetRegistry (Python: get\$1registry)](#aws-glue-api-schema-registry-api-GetRegistry)
+ [Ação PutSchemaVersionMetadata (Python: put\$1schema\$1version\$1metadata)](#aws-glue-api-schema-registry-api-PutSchemaVersionMetadata)
+ [Ação QuerySchemaVersionMetadata (Python: query\$1schema\$1version\$1metadata)](#aws-glue-api-schema-registry-api-QuerySchemaVersionMetadata)
+ [Ação RemoveSchemaVersionMetadata (Python: remove\$1schema\$1version\$1metadata)](#aws-glue-api-schema-registry-api-RemoveSchemaVersionMetadata)
+ [Ação DeleteRegistry (Python: delete\$1registry)](#aws-glue-api-schema-registry-api-DeleteRegistry)
+ [Ação DeleteSchema (Python: delete\$1schema)](#aws-glue-api-schema-registry-api-DeleteSchema)
+ [Ação DeleteSchemaVersions (Python: delete\$1schema\$1versions)](#aws-glue-api-schema-registry-api-DeleteSchemaVersions)
## Ação CreateRegistry (Python: create\$1registry)
Cria um novo registro que pode ser usado para armazenar uma coleção de esquemas.
**Solicitação**
+ `RegistryName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
Nome do esquema a ser criado com comprimento máximo de 255 e que só pode conter letras, números, hífen, sublinhado, sinal de dólar ou cerquilha. Sem espaço em branco
+ `Description` – string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Uma descrição do registro. Se a descrição não for fornecida, não haverá nenhum valor padrão para esse campo.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do que 50 pares.
Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes.
Cada valor é uma string UTF-8, inferior a 256 bytes de comprimento.
AWSTags da que contêm um par de chave-valor e podem ser pesquisadas por console, linha de comando ou API.
**Resposta**
+ `RegistryArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
O nome do recurso da Amazon (ARN) do registro recém-criado.
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do registro.
+ `Description` – string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Uma descrição do registro.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do que 50 pares.
Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes.
Cada valor é uma string UTF-8, inferior a 256 bytes de comprimento.
As tags do registro.
**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentModificationException`
+ `ThrottlingException`
+ `InternalServiceException`
## Ação CreateSchema (Python: create\$1esquema)
Cria um novo conjunto de esquemas e registra a definição do esquema. Retorna um erro se o conjunto de esquemas já existir sem realmente registrar a versão.
Quando o conjunto de esquemas é criado, um ponto de verificação de versão é definido para a primeira versão. O modo de compatibilidade “DISABLED” (Desabilitado) restringe a adição de versões adicionais do esquema após a primeira versão. Para todos os outros modos de compatibilidade, a validação das configurações de compatibilidade será aplicada somente a partir da segunda versão em diante, quando a API do `RegisterSchemaVersion` for usada.
Quando esta API é chamada sem um `RegistryId`, isso cria uma entrada para um “default-registry” (registro padrão) nas tabelas de banco de dados do registro, se ela ainda não estiver presente.
**Solicitação**
+ `RegistryId` – Um objeto [RegistryId](#aws-glue-api-schema-registry-api-RegistryId).
Esta é uma forma de wrapper para conter os campos de identidade do registro. Se essa propriedade não for definida, o registro padrão será usado. O formato do ARN para a mesma propriedade será: `arn:aws:glue:us-east-2::registry/default-registry:random-5-letter-id`.
+ `SchemaName`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
Nome do esquema a ser criado com comprimento máximo de 255, e só pode conter letras, números, hífen, sublinhado, sinal de dólar ou marca de hash. Sem espaço em branco
+ `DataFormat` – *Obrigatório:* string UTF-8 (valores válidos: `AVRO` \$1 `JSON` \$1 `PROTOBUF`).
O formato de dados da definição do esquema. No momento, há suporte a `AVRO`, `JSON` e `PROTOBUF`.
+ `Compatibility` – string UTF-8 (valores válidos: `NONE` \$1 `DISABLED` \$1 `BACKWARD` \$1 `BACKWARD_ALL` \$1 `FORWARD` \$1 `FORWARD_ALL` \$1 `FULL` \$1 `FULL_ALL`).
O modo de compatibilidade do esquema. Os valores possíveis são:
+ *NONE* (Nenhum): nenhum modo de compatibilidade se aplica. Você pode usar essa opção em cenários de desenvolvimento ou se você não souber o modo de compatibilidade que deseja aplicar aos esquemas. Qualquer nova versão adicionada será aceita sem ser submetida a uma verificação de compatibilidade.
+ *DISABLED* (Desabilitado): esta opção de compatibilidade impede o versionamento de um esquema específico. Você pode usar essa opção para evitar versionamentos futuros de um esquema.
+ *BACKWARD* (Anterior): esta opção de compatibilidade é recomendada, pois permite que os receptores de dados leiam a versão atual e uma anterior do esquema. Isso significa que, por exemplo, uma nova versão do esquema não pode descartar campos de dados ou alterar o tipo desses campos, portanto, eles não podem ser lidos pelos leitores usando a versão anterior.
+ *BACKWARD\$1ALL* (Todas as anteriores): esta opção de compatibilidade é recomendada, pois permite que os receptores de dados leiam a versão atual e todas as anteriores do esquema. Você pode usar essa opção quando precisar excluir campos ou adicionar campos opcionais e verificar a compatibilidade com todas as versões anteriores do esquema.
+ *FORWARD* (Próxima): esta opção de compatibilidade permite que os receptores de dados leiam a versão atual e uma próxima do esquema, mas não necessariamente versões posteriores. Você pode usar essa opção quando precisar adicionar campos ou excluir campos opcionais, mas apenas verificar a compatibilidade com a última versão do esquema.
+ *FORWARD\$1ALL* (Todas as próximas): esta opção de compatibilidade permite que os receptores de dados leiam dados gravados pelos produtores de qualquer novo esquema registrado. Você pode usar essa opção quando precisar adicionar campos ou excluir campos opcionais e verificar a compatibilidade com todas as versões anteriores do esquema.
+ *FULL* (Completo): esta opção de compatibilidade permite que os receptores de dados leiam dados gravados por produtores usando a versão anterior ou seguinte do esquema, mas não necessariamente versões anteriores ou posteriores. Você pode usar essa opção quando precisar adicionar ou remover campos opcionais, mas apenas verificar a compatibilidade com a última versão do esquema.
+ *FULL\$1ALL* (Completo total): esta opção de compatibilidade permite que os receptores de dados leiam dados gravados por produtores usando todas as versões de esquema anteriores. Você pode usar essa opção quando precisar adicionar ou remover campos opcionais e verificar a compatibilidade com todas as versões anteriores do esquema.
+ `Description` – string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Uma descrição opcional do esquema. Se a descrição não for fornecida, não haverá nenhum valor padrão automático para esse campo.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do que 50 pares.
Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes.
Cada valor é uma string UTF-8, inferior a 256 bytes de comprimento.
AWSTags da que contêm um par de chave-valor e podem ser pesquisadas por console, linha de comando ou API. Se especificado, segue o padrão tags-on-create da AWS.
+ `SchemaDefinition` – string UTF-8, não menos do que 1 ou superior a 170.000 bytes de comprimento, correspondente a [Custom string pattern #13](aws-glue-api-common.md#regex_13).
A definição do esquema usando a configuração `DataFormat` para `SchemaName`.
**Resposta**
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do registro.
+ `RegistryArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
O nome de recurso da Amazon (ARN) do registro.
+ `SchemaName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do esquema.
+ `SchemaArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
O nome de recurso da Amazon (ARN) do esquema.
+ `Description` – string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Uma descrição do esquema, se especificado quando criado.
+ `DataFormat` – string UTF-8 (valores válidos: `AVRO` \$1 `JSON` \$1 `PROTOBUF`).
O formato de dados da definição do esquema. No momento, há suporte a `AVRO`, `JSON` e `PROTOBUF`.
+ `Compatibility` – string UTF-8 (valores válidos: `NONE` \$1 `DISABLED` \$1 `BACKWARD` \$1 `BACKWARD_ALL` \$1 `FORWARD` \$1 `FORWARD_ALL` \$1 `FULL` \$1 `FULL_ALL`).
O modo de compatibilidade do esquema.
+ `SchemaCheckpoint`: número (inteiro longo), não menos do que 1 ou superior a 100.000.
O número da versão do ponto de verificação (a última vez que o modo de compatibilidade foi alterado).
+ `LatestSchemaVersion`: número (inteiro longo), não menos do que 1 ou superior a 100.000.
A versão mais recente do esquema associado à definição do esquema retornado.
+ `NextSchemaVersion`: número (inteiro longo), não menos do que 1 ou superior a 100.000.
A próxima versão do esquema associado à definição do esquema retornado.
+ `SchemaStatus` – string UTF-8 (valores válidos: `AVAILABLE` \$1 `PENDING` \$1 `DELETING`).
O status do esquema.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais do que 50 pares.
Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes.
Cada valor é uma string UTF-8, inferior a 256 bytes de comprimento.
As tags do esquema.
+ `SchemaVersionId` – string UTF-8, não menos do que 36 ou superior a 36 bytes de comprimento, correspondente a [Custom string pattern #45](aws-glue-api-common.md#regex_45).
O identificador exclusivo da primeira versão do esquema.
+ `SchemaVersionStatus` – String UTF-8 (valores válidos: `AVAILABLE` \$1 `PENDING` \$1 `FAILURE` \$1 `DELETING`).
O status da primeira versão do esquema criada.
**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentModificationException`
+ `ThrottlingException`
+ `InternalServiceException`
## Ação GetSchema (Python: get\$1schema)
Descreve o esquema especificado em detalhes.
**Solicitação**
+ `SchemaId` – *Obrigatório:* um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).
É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
+ SchemaId\$1SchemaArno: o nome do recurso da Amazon (ARN) do esquema. `SchemaArn` ou `SchemaName` e `RegistryName` devem ser fornecidos.
+ SchemaId\$1SchemaName: o nome do esquema. `SchemaArn` ou `SchemaName` e `RegistryName` devem ser fornecidos.
**Resposta**
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do registro.
+ `RegistryArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
O nome de recurso da Amazon (ARN) do registro.
+ `SchemaName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do esquema.
+ `SchemaArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
O nome de recurso da Amazon (ARN) do esquema.
+ `Description` – string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Uma descrição do esquema, se especificado quando criado
+ `DataFormat` – string UTF-8 (valores válidos: `AVRO` \$1 `JSON` \$1 `PROTOBUF`).
O formato de dados da definição do esquema. No momento, há suporte a `AVRO`, `JSON` e `PROTOBUF`.
+ `Compatibility` – string UTF-8 (valores válidos: `NONE` \$1 `DISABLED` \$1 `BACKWARD` \$1 `BACKWARD_ALL` \$1 `FORWARD` \$1 `FORWARD_ALL` \$1 `FULL` \$1 `FULL_ALL`).
O modo de compatibilidade do esquema.
+ `SchemaCheckpoint`: número (inteiro longo), não menos do que 1 ou superior a 100.000.
O número da versão do ponto de verificação (a última vez que o modo de compatibilidade foi alterado).
+ `LatestSchemaVersion`: número (inteiro longo), não menos do que 1 ou superior a 100.000.
A versão mais recente do esquema associado à definição do esquema retornado.
+ `NextSchemaVersion`: número (inteiro longo), não menos do que 1 ou superior a 100.000.
A próxima versão do esquema associado à definição do esquema retornado.
+ `SchemaStatus` – string UTF-8 (valores válidos: `AVAILABLE` \$1 `PENDING` \$1 `DELETING`).
O status do esquema.
+ `CreatedTime` – String UTF-8.
A data e a hora em que o esquema foi criado.
+ `UpdatedTime` – String UTF-8.
A data e a hora em que o esquema foi atualizado.
**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `InternalServiceException`
## Ação ListSchemaVersions (Python: list\$1schema\$1versions)
Retorna uma lista de versões de esquema que você criou, com informações mínimas. As versões do esquema no status Deleted (Excluído) não serão incluídas nos resultados. Resultados vazios serão retornados, se não houver versões de esquema disponíveis.
**Solicitação**
+ `SchemaId` – *Obrigatório:* um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).
É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
+ SchemaId\$1SchemaArno: o nome do recurso da Amazon (ARN) do esquema. `SchemaArn` ou `SchemaName` e `RegistryName` devem ser fornecidos.
+ SchemaId\$1SchemaName: o nome do esquema. `SchemaArn` ou `SchemaName` e `RegistryName` devem ser fornecidos.
+ `MaxResults`: número (inteiro), não menos do que 1 ou superior a 100.
O número máximo de resultados exigidos por página. Se o valor não for fornecido, esse valor será definido por padrão como 25 por página.
+ `NextToken` – String UTF-8.
Um token de continuação, se esta for uma chamada de continuação.
**Resposta**
+ `Schemas`: um array de objetos [SchemaVersionListItem](#aws-glue-api-schema-registry-api-SchemaVersionListItem).
Uma matriz de objetos `SchemaVersionList` contendo detalhes de cada versão do esquema.
+ `NextToken` – String UTF-8.
Um token de continuação para paginação da lista de tokens retornada, retornado se o segmento atual da lista não for o último.
**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `InternalServiceException`
## Ação GetSchemaVersion (Python: get\$1schema\$1version)
Obtém o esquema especificado por seu ID exclusivo atribuído quando uma versão do esquema é criada ou registrada. As versões do esquema no status Deleted (Excluído) não serão incluídas nos resultados.
**Solicitação**
+ `SchemaId` – Um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).
É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
+ SchemaId\$1SchemaArno: o nome do recurso da Amazon (ARN) do esquema. `SchemaArn` ou `SchemaName` e `RegistryName` devem ser fornecidos.
+ SchemaId\$1SchemaName: o nome do esquema. `SchemaArn` ou `SchemaName` e `RegistryName` devem ser fornecidos.
+ `SchemaVersionId` – string UTF-8, não menos do que 36 ou superior a 36 bytes de comprimento, correspondente a [Custom string pattern #45](aws-glue-api-common.md#regex_45).
O `SchemaVersionId` da versão do esquema. Esse campo é obrigatório para buscar pelo ID do esquema. Esse ou o wrapper `SchemaId` tem que ser fornecido.
+ `SchemaVersionNumber` – Um objeto [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber).
O número da versão do esquema.
**Resposta**
+ `SchemaVersionId` – string UTF-8, não menos do que 36 ou superior a 36 bytes de comprimento, correspondente a [Custom string pattern #45](aws-glue-api-common.md#regex_45).
O `SchemaVersionId` da versão do esquema.
+ `SchemaDefinition` – string UTF-8, não menos do que 1 ou superior a 170.000 bytes de comprimento, correspondente a [Custom string pattern #13](aws-glue-api-common.md#regex_13).
A definição do esquema para o ID do esquema.
+ `DataFormat` – string UTF-8 (valores válidos: `AVRO` \$1 `JSON` \$1 `PROTOBUF`).
O formato de dados da definição do esquema. No momento, há suporte a `AVRO`, `JSON` e `PROTOBUF`.
+ `SchemaArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
O nome de recurso da Amazon (ARN) do esquema.
+ `VersionNumber`: número (inteiro longo), não menos do que 1 ou superior a 100.000.
O número da versão do esquema.
+ `Status` – String UTF-8 (valores válidos: `AVAILABLE` \$1 `PENDING` \$1 `FAILURE` \$1 `DELETING`).
O status da versão do esquema.
+ `CreatedTime` – String UTF-8.
A data e hora em que a versão do esquema foi criada.
**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `InternalServiceException`
## Ação GetSchemaVersionsDiff (Python: get\$1schema\$1versions\$1diff)
Obtém a diferença de versão do esquema no tipo de diferença especificado entre duas versões de esquema armazenadas no registro de esquema.
Essa API permite comparar duas versões de esquema entre duas definições sob o mesmo esquema.
**Solicitação**
+ `SchemaId` – *Obrigatório:* um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).
É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
+ SchemaId\$1SchemaArno: o nome do recurso da Amazon (ARN) do esquema. Um de `SchemaArn` ou `SchemaName` tem de ser fornecido.
+ SchemaId\$1SchemaName: o nome do esquema. Um de `SchemaArn` ou `SchemaName` tem de ser fornecido.
+ `FirstSchemaVersionNumber` – *Obrigatório:* um objeto [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber).
A primeira das duas versões de esquema a serem comparadas.
+ `SecondSchemaVersionNumber` – *Obrigatório:* um objeto [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber).
A segunda das duas versões de esquema a serem comparadas.
+ `SchemaDiffType`: *obrigatório:* string UTF-8 (valores válidos: `SYNTAX_DIFF`).
Refere-se a `SYNTAX_DIFF`, que é o tipo de comparação atualmente suportado.
**Resposta**
+ `Diff` – string UTF-8, não menos do que 1 ou superior a 340.000 bytes de comprimento, correspondente a [Custom string pattern #13](aws-glue-api-common.md#regex_13).
A diferença entre esquemas como uma string no formato JsonPatch.
**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `InternalServiceException`
## Ação ListRegistries (Python: list\$1registries)
Retorna uma lista de registros que você criou, com informações mínimas de registro. Registros no status `Deleting` não serão incluídos nos resultados. Resultados vazios serão retornados, se não houver registros disponíveis.
**Solicitação**
+ `MaxResults`: número (inteiro), não menos do que 1 ou superior a 100.
O número máximo de resultados exigidos por página. Se o valor não for fornecido, esse valor será definido por padrão como 25 por página.
+ `NextToken` – String UTF-8.
Um token de continuação, se esta for uma chamada de continuação.
**Resposta**
+ `Registries`: um array de objetos [RegistryListItem](#aws-glue-api-schema-registry-api-RegistryListItem).
Uma matriz de objetos `RegistryDetailedListItem` contendo detalhes mínimos de cada registro.
+ `NextToken` – String UTF-8.
Um token de continuação para paginação da lista de tokens retornada, retornado se o segmento atual da lista não for o último.
**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `InternalServiceException`
## Ação ListSchemas (Python: list\$1schemas)
Retorna uma lista de esquemas com detalhes mínimos. Esquemas no status Deleting (Exclusão) não serão incluídos nos resultados. Resultados vazios serão retornados, se não houver esquemas disponíveis.
Quando o `RegistryId` não for fornecido, todos os esquemas nos registros serão parte da resposta da API.
**Solicitação**
+ `RegistryId` – Um objeto [RegistryId](#aws-glue-api-schema-registry-api-RegistryId).
Uma estrutura de wrapper que pode conter o nome de registro e o nome do recurso da Amazon (ARN).
+ `MaxResults`: número (inteiro), não menos do que 1 ou superior a 100.
O número máximo de resultados exigidos por página. Se o valor não for fornecido, esse valor será definido por padrão como 25 por página.
+ `NextToken` – String UTF-8.
Um token de continuação, se esta for uma chamada de continuação.
**Resposta**
+ `Schemas`: um array de objetos [SchemaListItem](#aws-glue-api-schema-registry-api-SchemaListItem).
Uma matriz de objetos `SchemaListItem` contendo detalhes de cada esquema.
+ `NextToken` – String UTF-8.
Um token de continuação para paginação da lista de tokens retornada, retornado se o segmento atual da lista não for o último.
**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `InternalServiceException`
## Ação RegisterSchemaVersion (Python: register\$1schema\$1version)
Adiciona uma nova versão ao esquema existente. Retorna um erro se a nova versão do esquema não atender aos requisitos de compatibilidade do conjunto de esquemas. Essa API não criará um novo conjunto de esquemas e retornará um erro 404 se o conjunto de esquemas ainda não estiver presente no registro de esquema.
Se essa for a primeira definição de esquema a ser registrada no registro de esquema, essa API armazenará a versão do esquema e retornará imediatamente. Caso contrário, essa chamada tem o potencial de ser executada por mais tempo do que outras operações graças aos modos de compatibilidade. Você pode chamar a API `GetSchemaVersion` com o `SchemaVersionId` para conferir os modos de compatibilidade.
Se a mesma definição de esquema já estiver armazenada no registro de esquema como uma versão, o ID do esquema existente será retornado ao autor da chamada.
**Solicitação**
+ `SchemaId` – *Obrigatório:* um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).
É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
+ SchemaId\$1SchemaArno: o nome do recurso da Amazon (ARN) do esquema. `SchemaArn` ou `SchemaName` e `RegistryName` devem ser fornecidos.
+ SchemaId\$1SchemaName: o nome do esquema. `SchemaArn` ou `SchemaName` e `RegistryName` devem ser fornecidos.
+ `SchemaDefinition`: *obrigatório:* string UTF-8, não menos do que 1 ou superior a 170.000 bytes de comprimento, correspondente a [Custom string pattern #13](aws-glue-api-common.md#regex_13).
A definição do esquema usando a configuração `DataFormat` para o `SchemaName`.
**Resposta**
+ `SchemaVersionId` – string UTF-8, não menos do que 36 ou superior a 36 bytes de comprimento, correspondente a [Custom string pattern #45](aws-glue-api-common.md#regex_45).
O ID exclusivo que representa a versão desse esquema.
+ `VersionNumber`: número (inteiro longo), não menos do que 1 ou superior a 100.000.
A versão desse esquema (apenas para fluxo de sincronização, caso esta seja a primeira versão).
+ `Status` – String UTF-8 (valores válidos: `AVAILABLE` \$1 `PENDING` \$1 `FAILURE` \$1 `DELETING`).
O status da versão do esquema.
**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ResourceNumberLimitExceededException`
+ `ThrottlingException`
+ `ConcurrentModificationException`
+ `InternalServiceException`
## Ação UpdateSchema (Python: update\$1schema)
Atualiza a descrição, a configuração de compatibilidade ou o ponto de verificação de versão de um conjunto de esquemas.
Para atualizar a configuração de compatibilidade, a chamada não validará a compatibilidade para todo o conjunto de versões de esquema com a nova configuração de compatibilidade. Se o valor para `Compatibility` for fornecido, o `VersionNumber` (um ponto de verificação) também será necessário. A API validará o número de versão do ponto de verificação para fins de consistência.
Se o valor para `VersionNumber` (ponto de verificação) for fornecido, `Compatibility` será opcional e isso poderá ser usado para definir/redefinir um ponto de verificação para o esquema.
Essa atualização ocorrerá somente se o esquema estiver no estado AVAILABLE (Disponível).
**Solicitação**
+ `SchemaId` – *Obrigatório:* um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).
É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
+ SchemaId\$1SchemaArno: o nome do recurso da Amazon (ARN) do esquema. Um de `SchemaArn` ou `SchemaName` tem de ser fornecido.
+ SchemaId\$1SchemaName: o nome do esquema. Um de `SchemaArn` ou `SchemaName` tem de ser fornecido.
+ `SchemaVersionNumber` – Um objeto [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber).
Número de versão necessário para criar o ponto de verificação. Um de `VersionNumber` ou `Compatibility` tem de ser fornecido.
+ `Compatibility` – string UTF-8 (valores válidos: `NONE` \$1 `DISABLED` \$1 `BACKWARD` \$1 `BACKWARD_ALL` \$1 `FORWARD` \$1 `FORWARD_ALL` \$1 `FULL` \$1 `FULL_ALL`).
A nova configuração de compatibilidade do esquema.
+ `Description` – string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
A nova descrição do esquema.
**Resposta**
+ `SchemaArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
O nome de recurso da Amazon (ARN) do esquema.
+ `SchemaName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do esquema.
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do registro que contém o esquema.
**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ConcurrentModificationException`
+ `ThrottlingException`
+ `InternalServiceException`
## Ação CheckSchemaVersionValidity (Python: check\$1schema\$1version\$1validity)
Valida o esquema fornecido. Essa chamada não tem efeitos colaterais, ela simplesmente valida usando o esquema fornecido que usa `DataFormat` como o formato. Como ela não usa um nome de conjunto de esquemas, nenhuma verificação de compatibilidade é realizada.
**Solicitação**
+ `DataFormat` – *Obrigatório:* string UTF-8 (valores válidos: `AVRO` \$1 `JSON` \$1 `PROTOBUF`).
O formato de dados da definição do esquema. No momento, há suporte a `AVRO`, `JSON` e `PROTOBUF`.
+ `SchemaDefinition`: *obrigatório:* string UTF-8, não menos do que 1 ou superior a 170.000 bytes de comprimento, correspondente a [Custom string pattern #13](aws-glue-api-common.md#regex_13).
A definição do esquema que deve ser validado.
**Resposta**
+ `Valid` – Booleano.
Retorna true, se o esquema for válido, e false, caso contrário.
+ `Error`: string UTF-8, não menos do que 1 ou superior a 5.000 bytes de comprimento.
Uma mensagem de erro de falha de validação.
**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `InternalServiceException`
## Ação UpdateRegistry (Python: update\$1registry)
Atualiza um registro existente que é usado para armazenar uma coleção de esquemas. As propriedades atualizadas se relacionam com o registro e não modificam nenhum dos esquemas dentro dele.
**Solicitação**
+ `RegistryId` – *Obrigatório:* um objeto [RegistryId](#aws-glue-api-schema-registry-api-RegistryId).
Esta é uma estrutura de wrapper que pode conter o nome de registro e o nome do recurso da Amazon (ARN).
+ `Description`: *obrigatório:* string de descrição, inferior a 2.048 bytes de comprimento, correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Uma descrição do registro. Se a descrição não for fornecida, esse campo não será atualizado.
**Resposta**
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do registro atualizado.
+ `RegistryArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
O nome do recurso da Amazon (ARN) do registro atualizado.
**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ConcurrentModificationException`
+ `ThrottlingException`
+ `InternalServiceException`
## Ação GetSchemaByDefinition (Python: get\$1schema\$1by\$1definition)
Recupera um esquema pela `SchemaDefinition`. A definição de esquema é enviada para o registro de esquema, canonizada e com hash. Se o hash for correspondido dentro do escopo do `SchemaName` ou ARN (ou o registro padrão, se nenhum for fornecido), os metadados desse esquema serão retornados. Caso contrário, um erro 404 ou NotFound (não encontrado) é retornado. As versões do esquema no status `Deleted` não serão incluídas nos resultados.
**Solicitação**
+ `SchemaId` – *Obrigatório:* um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).
É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
+ SchemaId\$1SchemaArno: o nome do recurso da Amazon (ARN) do esquema. Um de `SchemaArn` ou `SchemaName` tem de ser fornecido.
+ SchemaId\$1SchemaName: o nome do esquema. Um de `SchemaArn` ou `SchemaName` tem de ser fornecido.
+ `SchemaDefinition`: *obrigatório:* string UTF-8, não menos do que 1 ou superior a 170.000 bytes de comprimento, correspondente a [Custom string pattern #13](aws-glue-api-common.md#regex_13).
A definição do esquema para a qual os detalhes do esquema são necessários.
**Resposta**
+ `SchemaVersionId` – string UTF-8, não menos do que 36 ou superior a 36 bytes de comprimento, correspondente a [Custom string pattern #45](aws-glue-api-common.md#regex_45).
O ID do esquema da versão do esquema.
+ `SchemaArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
O nome de recurso da Amazon (ARN) do esquema.
+ `DataFormat` – string UTF-8 (valores válidos: `AVRO` \$1 `JSON` \$1 `PROTOBUF`).
O formato de dados da definição do esquema. No momento, há suporte a `AVRO`, `JSON` e `PROTOBUF`.
+ `Status` – String UTF-8 (valores válidos: `AVAILABLE` \$1 `PENDING` \$1 `FAILURE` \$1 `DELETING`).
O status da versão do esquema.
+ `CreatedTime` – String UTF-8.
A data e a hora em que o esquema foi criado.
**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `InternalServiceException`
## Ação GetRegistry (Python: get\$1registry)
Descreve o registro especificado em detalhes.
**Solicitação**
+ `RegistryId` – *Obrigatório:* um objeto [RegistryId](#aws-glue-api-schema-registry-api-RegistryId).
Esta é uma estrutura de wrapper que pode conter o nome de registro e o nome do recurso da Amazon (ARN).
**Resposta**
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do registro.
+ `RegistryArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
O nome de recurso da Amazon (ARN) do registro.
+ `Description` – string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Uma descrição do registro.
+ `Status` – string UTF-8 (valores válidos: `AVAILABLE` \$1 `DELETING`).
O status do registro.
+ `CreatedTime` – String UTF-8.
A data e a hora em que o registro foi criado.
+ `UpdatedTime` – String UTF-8.
A data e a hora em que o registro foi atualizado.
**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `InternalServiceException`
## Ação PutSchemaVersionMetadata (Python: put\$1schema\$1version\$1metadata)
Insere o par de chave-valor de metadados para um ID de versão de esquema especificado. Um máximo de dez pares de chave-valor será permitido por versão do esquema. Eles podem ser adicionados em uma ou mais chamadas.
**Solicitação**
+ `SchemaId` – Um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).
O ID exclusivo do esquema.
+ `SchemaVersionNumber` – Um objeto [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber).
O número da versão do esquema.
+ `SchemaVersionId` – string UTF-8, não menos do que 36 ou superior a 36 bytes de comprimento, correspondente a [Custom string pattern #45](aws-glue-api-common.md#regex_45).
O ID de versão exclusivo da versão do esquema.
+ `MetadataKeyValue` – *Obrigatório:* um objeto [MetadataKeyValuePair](#aws-glue-api-schema-registry-api-MetadataKeyValuePair).
O valor correspondente da chave de metadados.
**Resposta**
+ `SchemaArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
O nome do recurso da Amazon (ARN) do esquema.
+ `SchemaName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do esquema.
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do registro.
+ `LatestVersion` – Booleano.
A versão mais recente do esquema.
+ `VersionNumber`: número (inteiro longo), não menos do que 1 ou superior a 100.000.
O número da versão do esquema.
+ `SchemaVersionId` – string UTF-8, não menos do que 36 ou superior a 36 bytes de comprimento, correspondente a [Custom string pattern #45](aws-glue-api-common.md#regex_45).
O ID de versão exclusivo da versão do esquema.
+ `MetadataKey` – string UTF-8, não menos do que 1 ou superior a 128 bytes de comprimento, correspondente a [Custom string pattern #14](aws-glue-api-common.md#regex_14).
A chave de metadados.
+ `MetadataValue` – string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a [Custom string pattern #14](aws-glue-api-common.md#regex_14).
O valor da chave de metadados.
**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `AlreadyExistsException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `ResourceNumberLimitExceededException`
## Ação QuerySchemaVersionMetadata (Python: query\$1schema\$1version\$1metadata)
Consultas para obter as informações de metadados da versão do esquema.
**Solicitação**
+ `SchemaId` – Um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).
Uma estrutura de wrapper que pode conter o nome do esquema e o nome do recurso da Amazon (ARN).
+ `SchemaVersionNumber` – Um objeto [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber).
O número da versão do esquema.
+ `SchemaVersionId` – string UTF-8, não menos do que 36 ou superior a 36 bytes de comprimento, correspondente a [Custom string pattern #45](aws-glue-api-common.md#regex_45).
O ID de versão exclusivo da versão do esquema.
+ `MetadataList`: um array de objetos [MetadataKeyValuePair](#aws-glue-api-schema-registry-api-MetadataKeyValuePair).
Pesquisa os pares de chave-valor para metadados. Se eles não forem fornecidos, todas as informações de metadados serão buscadas.
+ `MaxResults`: número (inteiro), não menos do que 1 ou superior a 50.
O número máximo de resultados exigidos por página. Se o valor não for fornecido, esse valor será definido por padrão como 25 por página.
+ `NextToken` – String UTF-8.
Um token de continuação, se esta for uma chamada de continuação.
**Resposta**
+ `MetadataInfoMap` – Um array de mapa dos pares de valor-chave.
Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes, correspondente a [Custom string pattern #14](aws-glue-api-common.md#regex_14).
Cada valor é um objeto [MetadataInfo](#aws-glue-api-schema-registry-api-MetadataInfo) A.
Um mapa de uma chave de metadados e valores associados.
+ `SchemaVersionId` – string UTF-8, não menos do que 36 ou superior a 36 bytes de comprimento, correspondente a [Custom string pattern #45](aws-glue-api-common.md#regex_45).
O ID de versão exclusivo da versão do esquema.
+ `NextToken` – String UTF-8.
Um token de continuação para paginação da lista de tokens retornada, retornado se o segmento atual da lista não for o último.
**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `EntityNotFoundException`
## Ação RemoveSchemaVersionMetadata (Python: remove\$1schema\$1version\$1metadata)
Remove um par de chave-valor dos metadados de versão do esquema para o ID de versão do esquema especificado.
**Solicitação**
+ `SchemaId` – Um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).
Uma estrutura de wrapper que pode conter o nome do esquema e o nome do recurso da Amazon (ARN).
+ `SchemaVersionNumber` – Um objeto [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber).
O número da versão do esquema.
+ `SchemaVersionId` – string UTF-8, não menos do que 36 ou superior a 36 bytes de comprimento, correspondente a [Custom string pattern #45](aws-glue-api-common.md#regex_45).
O ID de versão exclusivo da versão do esquema.
+ `MetadataKeyValue` – *Obrigatório:* um objeto [MetadataKeyValuePair](#aws-glue-api-schema-registry-api-MetadataKeyValuePair).
O valor da chave de metadados.
**Resposta**
+ `SchemaArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
O nome de recurso da Amazon (ARN) do esquema.
+ `SchemaName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do esquema.
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do registro.
+ `LatestVersion` – Booleano.
A versão mais recente do esquema.
+ `VersionNumber`: número (inteiro longo), não menos do que 1 ou superior a 100.000.
O número da versão do esquema.
+ `SchemaVersionId` – string UTF-8, não menos do que 36 ou superior a 36 bytes de comprimento, correspondente a [Custom string pattern #45](aws-glue-api-common.md#regex_45).
O ID da versão para a versão do esquema.
+ `MetadataKey` – string UTF-8, não menos do que 1 ou superior a 128 bytes de comprimento, correspondente a [Custom string pattern #14](aws-glue-api-common.md#regex_14).
A chave de metadados.
+ `MetadataValue` – string UTF-8, não menos do que 1 ou superior a 256 bytes de comprimento, correspondente a [Custom string pattern #14](aws-glue-api-common.md#regex_14).
O valor da chave de metadados.
**Erros**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `EntityNotFoundException`
## Ação DeleteRegistry (Python: delete\$1registry)
Exclui todo o registro, incluindo esquema e todas as suas versões. Para obter o status da operação de exclusão, é possível chamar a API `GetRegistry` após a chamada assíncrona. Excluir um registro desativará todas as operações online para ele, como as APIs `UpdateRegistry`, `CreateSchema`, `UpdateSchema` e `RegisterSchemaVersion`.
**Solicitação**
+ `RegistryId` – *Obrigatório:* um objeto [RegistryId](#aws-glue-api-schema-registry-api-RegistryId).
Esta é uma estrutura de wrapper que pode conter o nome de registro e o nome do recurso da Amazon (ARN).
**Resposta**
+ `RegistryName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do registro sendo excluído.
+ `RegistryArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
O nome do recurso da Amazon (ARN) do registro a ser excluído.
+ `Status` – string UTF-8 (valores válidos: `AVAILABLE` \$1 `DELETING`).
O status do registro. Uma operação bem-sucedida retornará o status `Deleting`.
**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `ConcurrentModificationException`
## Ação DeleteSchema (Python: delete\$1schema)
Exclui todo o conjunto de esquemas, incluindo o conjunto de esquemas e todas as suas versões. Para obter o status da operação de exclusão, é possível chamar a API `GetSchema` após a chamada assíncrona. Excluir um registro desativará todas as operações online para ele, como as APIs `GetSchemaByDefinition` e `RegisterSchemaVersion`.
**Solicitação**
+ `SchemaId` – *Obrigatório:* um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).
Esta é uma estrutura de wrapper que pode conter o nome do esquema e o nome do recurso da Amazon (ARN).
**Resposta**
+ `SchemaArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50).
O nome do recurso da Amazon (ARN) do esquema sendo excluído.
+ `SchemaName` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Custom string pattern #46](aws-glue-api-common.md#regex_46).
O nome do esquema sendo excluído.
+ `Status` – string UTF-8 (valores válidos: `AVAILABLE` \$1 `PENDING` \$1 `DELETING`).
O status do esquema.
**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `ConcurrentModificationException`
## Ação DeleteSchemaVersions (Python: delete\$1schema\$1versions)
Remove versões do esquema especificado. Um número de versão ou intervalo pode ser fornecido. Se o modo de compatibilidade proibir a exclusão de uma versão que é necessária, como BACKWARDS\$1FULL, um erro será retornado. Chamar a API `GetSchemaVersions` após essa chamada listará o status das versões excluídas.
Quando o intervalo de números de versão contiver a versão de ponto de verificação, a API retornará um conflito 409 e não prosseguirá com a exclusão. Primeiro, é preciso remover o ponto de verificação usando a API `DeleteSchemaCheckpoint` antes de usar essa API.
Não é possível utilizar a API `DeleteSchemaVersions` para excluir a primeira versão do esquema no conjunto de esquemas. A primeira versão do esquema só pode ser excluída pela API `DeleteSchema`. Essa operação também excluirá os `SchemaVersionMetadata` anexados nas versões do esquema. Exclusões irreversíveis serão impostas no banco de dados.
Se o modo de compatibilidade proibir a exclusão de uma versão que é necessária, como BACKWARDS\$1FULL, um erro será retornado.
**Solicitação**
+ `SchemaId` – *Obrigatório:* um objeto [SchemaId](#aws-glue-api-schema-registry-api-SchemaId).
Esta é uma estrutura de wrapper que pode conter o nome do esquema e o nome do recurso da Amazon (ARN).
+ `Versions`: *obrigatório:* string UTF-8, não menos do que 1 ou superior a 100.000 bytes de comprimento, correspondente a [Custom string pattern #15](aws-glue-api-common.md#regex_15).
Pode ser fornecido um intervalo de versões que pode ser do formato:
+ um único número de versão, 5
+ um intervalo, 5-8: exclui as versões 5, 6, 7 e 8
**Resposta**
+ `SchemaVersionErrors`: um array de objetos [SchemaVersionErrorItem](#aws-glue-api-schema-registry-api-SchemaVersionErrorItem).
Uma lista de objetos `SchemaVersionErrorItem`, cada um contendo uma versão de esquema e erro.
**Erros**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `ConcurrentModificationException`