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
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 #45.Nome do registro. Usado apenas para pesquisa. Um de
RegistryArnouRegistryNametem 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 #49.ARN do registro a ser atualizado. Um de
RegistryArnouRegistryNametem 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 #45.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 #49.O nome de recurso da Amazon (ARN) do registro.
-
Description– String de descrição, inferior a 2048 bytes de comprimento, correspondente a URI address multi-line string pattern.Uma descrição do registro.
-
Status: string UTF-8 (valores válidos:AVAILABLE|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.O valor correspondente da chave de metadados.
-
CreatedTime– String UTF-8.A hora em que a entrada foi criada.
-
OtherMetadataValueList– Uma matriz de objetos 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.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 #45.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 #45.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 #49.O nome do recurso da Amazon (ARN) do esquema.
-
Description– String de descrição, inferior a 2048 bytes de comprimento, correspondente a URI address multi-line string pattern.Uma descrição para o esquema.
-
SchemaStatus– String UTF-8 (valores válidos:AVAILABLE|PENDING|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 #49.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 #44.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|PENDING|FAILURE|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.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.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.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 #49.O nome de recurso da Amazon (ARN) do esquema. Um de
SchemaArnouSchemaNametem de ser fornecido. -
SchemaName– String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Custom string pattern #45.O nome do esquema. Um de
SchemaArnouSchemaNametem de ser fornecido. -
RegistryName– String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Custom string pattern #45.O nome do registro do esquema que contém o esquema.
Operações
Ação GetSchemaVersionsDiff (Python: get_schema_versions_diff)
Ação RegisterSchemaVersion (Python: register_schema_version)
Ação CheckSchemaVersionValidity (Python: check_schema_version_validity)
Ação GetSchemaByDefinition (Python: get_schema_by_definition)
Ação PutSchemaVersionMetadata (Python: put_schema_version_metadata)
Ação QuerySchemaVersionMetadata (Python: query_schema_version_metadata)
Ação RemoveSchemaVersionMetadata (Python: remove_schema_version_metadata)
Ação CreateRegistry (Python: create_registry)
Cria um novo registro que pode ser usado para armazenar uma coleção de esquemas.
Solicitação
-
RegistryName– Obrigatório: string UTF-8, no mínimo 1 ou mais de 255 bytes de comprimento, correspondente a Custom string pattern #45.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, inferior a 2048 bytes de comprimento, correspondente a URI address multi-line string pattern.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.
Tags da AWS 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 #49.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 #45.O nome do registro.
-
Description– String de descrição, inferior a 2048 bytes de comprimento, correspondente a URI address multi-line string pattern.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
InvalidInputExceptionAccessDeniedExceptionAlreadyExistsExceptionResourceNumberLimitExceededExceptionConcurrentModificationExceptionInternalServiceException
Ação CreateSchema (Python: create_esquema)
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.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:<customer id>:registry/default-registry:random-5-letter-id. -
SchemaName– Obrigatório: string UTF-8, no mínimo 1 ou mais de 255 bytes de comprimento, correspondente a Custom string pattern #45.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|JSON|PROTOBUF).O formato de dados da definição do esquema. No momento, há suporte a
AVRO,JSONePROTOBUF. -
Compatibility– String UTF-8 (valores válidos:NONE|DISABLED|BACKWARD|BACKWARD_ALL|FORWARD|FORWARD_ALL|FULL|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_ALL (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_ALL (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_ALL (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, inferior a 2048 bytes de comprimento, correspondente a URI address multi-line string pattern.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.
Tags da AWS 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.A definição do esquema usando a configuração
DataFormatparaSchemaName.
Resposta
-
RegistryName– String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Custom string pattern #45.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 #49.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 #45.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 #49.O nome de recurso da Amazon (ARN) do esquema.
-
Description– String de descrição, inferior a 2048 bytes de comprimento, correspondente a URI address multi-line string pattern.Uma descrição do esquema, se especificado quando criado.
-
DataFormat– String UTF-8 (valores válidos:AVRO|JSON|PROTOBUF).O formato de dados da definição do esquema. No momento, há suporte a
AVRO,JSONePROTOBUF. -
Compatibility– String UTF-8 (valores válidos:NONE|DISABLED|BACKWARD|BACKWARD_ALL|FORWARD|FORWARD_ALL|FULL|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|PENDING|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 #44.O identificador exclusivo da primeira versão do esquema.
-
SchemaVersionStatus– String UTF-8 (valores válidos:AVAILABLE|PENDING|FAILURE|DELETING).O status da primeira versão do esquema criada.
Erros
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionAlreadyExistsExceptionResourceNumberLimitExceededExceptionConcurrentModificationExceptionInternalServiceException
Ação GetSchema (Python: get_schema)
Descreve o esquema especificado em detalhes.
Solicitação
-
SchemaId– Obrigatório: um objeto SchemaId.É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
-
SchemaId$SchemaArno: o nome do recurso da Amazon (ARN) do esquema.
SchemaArnouSchemaNameeRegistryNamedevem ser fornecidos. -
SchemaId$SchemaName: o nome do esquema.
SchemaArnouSchemaNameeRegistryNamedevem ser fornecidos.
-
Resposta
-
RegistryName– String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Custom string pattern #45.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 #49.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 #45.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 #49.O nome de recurso da Amazon (ARN) do esquema.
-
Description– String de descrição, inferior a 2048 bytes de comprimento, correspondente a URI address multi-line string pattern.Uma descrição do esquema, se especificado quando criado
-
DataFormat– String UTF-8 (valores válidos:AVRO|JSON|PROTOBUF).O formato de dados da definição do esquema. No momento, há suporte a
AVRO,JSONePROTOBUF. -
Compatibility– String UTF-8 (valores válidos:NONE|DISABLED|BACKWARD|BACKWARD_ALL|FORWARD|FORWARD_ALL|FULL|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|PENDING|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
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
Ação ListSchemaVersions (Python: list_schema_versions)
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.É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
-
SchemaId$SchemaArno: o nome do recurso da Amazon (ARN) do esquema.
SchemaArnouSchemaNameeRegistryNamedevem ser fornecidos. -
SchemaId$SchemaName: o nome do esquema.
SchemaArnouSchemaNameeRegistryNamedevem 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– Uma matriz de objetos SchemaVersionListItem.Uma matriz de objetos
SchemaVersionListcontendo 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
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
Ação GetSchemaVersion (Python: get_schema_version)
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.É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
-
SchemaId$SchemaArno: o nome do recurso da Amazon (ARN) do esquema.
SchemaArnouSchemaNameeRegistryNamedevem ser fornecidos. -
SchemaId$SchemaName: o nome do esquema.
SchemaArnouSchemaNameeRegistryNamedevem ser fornecidos.
-
-
SchemaVersionId: string UTF-8, não menos do que 36 ou superior a 36 bytes de comprimento, correspondente a Custom string pattern #44.O
SchemaVersionIdda versão do esquema. Esse campo é obrigatório para buscar pelo ID do esquema. Esse ou o wrapperSchemaIdtem que ser fornecido. -
SchemaVersionNumber– Um objeto 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 #44.O
SchemaVersionIdda 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.A definição do esquema para o ID do esquema.
-
DataFormat– String UTF-8 (valores válidos:AVRO|JSON|PROTOBUF).O formato de dados da definição do esquema. No momento, há suporte a
AVRO,JSONePROTOBUF. -
SchemaArn: string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a Custom string pattern #49.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|PENDING|FAILURE|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
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
Ação GetSchemaVersionsDiff (Python: get_schema_versions_diff)
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.É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
-
SchemaId$SchemaArno: o nome do recurso da Amazon (ARN) do esquema. Um de
SchemaArnouSchemaNametem de ser fornecido. -
SchemaId$SchemaName: o nome do esquema. Um de
SchemaArnouSchemaNametem de ser fornecido.
-
-
FirstSchemaVersionNumber– Obrigatório: um objeto SchemaVersionNumber.A primeira das duas versões de esquema a serem comparadas.
-
SecondSchemaVersionNumber– Obrigatório: um objeto 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.A diferença entre esquemas como uma string no formato JsonPatch.
Erros
InvalidInputExceptionEntityNotFoundExceptionAccessDeniedExceptionInternalServiceException
Ação ListRegistries (Python: list_registries)
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– Uma matriz de objetos RegistryListItem.Uma matriz de objetos
RegistryDetailedListItemcontendo 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
InvalidInputExceptionAccessDeniedExceptionInternalServiceException
Ação ListSchemas (Python: list_schemas)
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.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– Uma matriz de objetos SchemaListItem.Uma matriz de objetos
SchemaListItemcontendo 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
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
Ação RegisterSchemaVersion (Python: register_schema_version)
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.É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
-
SchemaId$SchemaArno: o nome do recurso da Amazon (ARN) do esquema.
SchemaArnouSchemaNameeRegistryNamedevem ser fornecidos. -
SchemaId$SchemaName: o nome do esquema.
SchemaArnouSchemaNameeRegistryNamedevem 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.A definição do esquema usando a configuração
DataFormatpara oSchemaName.
Resposta
-
SchemaVersionId: string UTF-8, não menos do que 36 ou superior a 36 bytes de comprimento, correspondente a Custom string pattern #44.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|PENDING|FAILURE|DELETING).O status da versão do esquema.
Erros
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionResourceNumberLimitExceededExceptionConcurrentModificationExceptionInternalServiceException
Ação UpdateSchema (Python: update_schema)
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.É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
-
SchemaId$SchemaArno: o nome do recurso da Amazon (ARN) do esquema. Um de
SchemaArnouSchemaNametem de ser fornecido. -
SchemaId$SchemaName: o nome do esquema. Um de
SchemaArnouSchemaNametem de ser fornecido.
-
-
SchemaVersionNumber– Um objeto SchemaVersionNumber.Número de versão necessário para criar o ponto de verificação. Um de
VersionNumberouCompatibilitytem de ser fornecido. -
Compatibility– String UTF-8 (valores válidos:NONE|DISABLED|BACKWARD|BACKWARD_ALL|FORWARD|FORWARD_ALL|FULL|FULL_ALL).A nova configuração de compatibilidade do esquema.
-
Description– String de descrição, inferior a 2048 bytes de comprimento, correspondente a URI address multi-line string pattern.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 #49.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 #45.O nome do esquema.
-
RegistryName– String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Custom string pattern #45.O nome do registro que contém o esquema.
Erros
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionConcurrentModificationExceptionInternalServiceException
Ação CheckSchemaVersionValidity (Python: check_schema_version_validity)
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|JSON|PROTOBUF).O formato de dados da definição do esquema. No momento, há suporte a
AVRO,JSONePROTOBUF. -
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.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
InvalidInputExceptionAccessDeniedExceptionInternalServiceException
Ação UpdateRegistry (Python: update_registry)
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.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.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 #45.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 #49.O nome do recurso da Amazon (ARN) do registro atualizado.
Erros
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionConcurrentModificationExceptionInternalServiceException
Ação GetSchemaByDefinition (Python: get_schema_by_definition)
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.É uma estrutura de wrapper para conter campos de identidade de esquema. A estrutura contém:
-
SchemaId$SchemaArno: o nome do recurso da Amazon (ARN) do esquema. Um de
SchemaArnouSchemaNametem de ser fornecido. -
SchemaId$SchemaName: o nome do esquema. Um de
SchemaArnouSchemaNametem 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.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 #44.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 #49.O nome de recurso da Amazon (ARN) do esquema.
-
DataFormat– String UTF-8 (valores válidos:AVRO|JSON|PROTOBUF).O formato de dados da definição do esquema. No momento, há suporte a
AVRO,JSONePROTOBUF. -
Status– String UTF-8 (valores válidos:AVAILABLE|PENDING|FAILURE|DELETING).O status da versão do esquema.
-
CreatedTime– String UTF-8.A data e a hora em que o esquema foi criado.
Erros
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
Ação GetRegistry (Python: get_registry)
Descreve o registro especificado em detalhes.
Solicitação
-
RegistryId– Obrigatório: um objeto 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 #45.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 #49.O nome de recurso da Amazon (ARN) do registro.
-
Description– String de descrição, inferior a 2048 bytes de comprimento, correspondente a URI address multi-line string pattern.Uma descrição do registro.
-
Status: string UTF-8 (valores válidos:AVAILABLE|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
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
Ação PutSchemaVersionMetadata (Python: put_schema_version_metadata)
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.O ID exclusivo do esquema.
-
SchemaVersionNumber– Um objeto 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 #44.O ID de versão exclusivo da versão do esquema.
-
MetadataKeyValue– Obrigatório: um objeto 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 #49.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 #45.O nome do esquema.
-
RegistryName– String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Custom string pattern #45.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 #44.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.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.O valor da chave de metadados.
Erros
InvalidInputExceptionAccessDeniedExceptionAlreadyExistsExceptionEntityNotFoundExceptionResourceNumberLimitExceededException
Ação QuerySchemaVersionMetadata (Python: query_schema_version_metadata)
Consultas para obter as informações de metadados da versão do esquema.
Solicitação
-
SchemaId– Um objeto SchemaId.Uma estrutura de wrapper que pode conter o nome do esquema e o nome do recurso da Amazon (ARN).
-
SchemaVersionNumber– Um objeto 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 #44.O ID de versão exclusivo da versão do esquema.
-
MetadataList– Uma matriz de objetos 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.
Cada valor é um objeto 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 #44.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
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundException
Ação RemoveSchemaVersionMetadata (Python: remove_schema_version_metadata)
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.Uma estrutura de wrapper que pode conter o nome do esquema e o nome do recurso da Amazon (ARN).
-
SchemaVersionNumber– Um objeto 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 #44.O ID de versão exclusivo da versão do esquema.
-
MetadataKeyValue– Obrigatório: um objeto 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 #49.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 #45.O nome do esquema.
-
RegistryName– String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Custom string pattern #45.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 #44.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.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.O valor da chave de metadados.
Erros
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundException
Ação DeleteRegistry (Python: delete_registry)
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.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 #45.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 #49.O nome do recurso da Amazon (ARN) do registro a ser excluído.
-
Status: string UTF-8 (valores válidos:AVAILABLE|DELETING).O status do registro. Uma operação bem-sucedida retornará o status
Deleting.
Erros
InvalidInputExceptionEntityNotFoundExceptionAccessDeniedExceptionConcurrentModificationException
Ação DeleteSchema (Python: delete_schema)
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.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 #49.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 #45.O nome do esquema sendo excluído.
-
Status– String UTF-8 (valores válidos:AVAILABLE|PENDING|DELETING).O status do esquema.
Erros
InvalidInputExceptionEntityNotFoundExceptionAccessDeniedExceptionConcurrentModificationException
Ação DeleteSchemaVersions (Python: delete_schema_versions)
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_FULL, 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_FULL, um erro será retornado.
Solicitação
-
SchemaId– Obrigatório: um objeto 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.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– Uma matriz de objetos SchemaVersionErrorItem.Uma lista de objetos
SchemaVersionErrorItem, cada um contendo uma versão de esquema e erro.
Erros
InvalidInputExceptionEntityNotFoundExceptionAccessDeniedExceptionConcurrentModificationException
