Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
Schema Registry
La API de Schema Registry describe la API y los tipos de datos relacionados con el trabajo con esquemas en AWS Glue.
Tipos de datos
Estructura RegistryId
Una estructura de encapsulador que puede contener el nombre de registro y el nombre de recurso de Amazon (ARN).
Campos
-
RegistryName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.Nombre del registro. Sólo se utiliza para la búsqueda. Uno de
RegistryArnoRegistryNamedebe ser proporcionado. -
RegistryArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.Arn del registro que se actualizará. Uno de
RegistryArnoRegistryNamedebe ser proporcionado.
Estructura RegistryListItem
Una estructura que contiene los detalles de un registro.
Campos
-
RegistryName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.El nombre del registro.
-
RegistryArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.Nombre de recurso de Amazon (ARN) del registro.
-
Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.Es una descripción del recurso.
-
Status: cadena UTF-8 (valores válidos:AVAILABLE|DELETING).Estado del registro.
-
CreatedTime: cadena UTF-8.La fecha en que se creó el registro.
-
UpdatedTime: cadena UTF-8.La fecha en que se actualizó el registro.
Estructura MetadataInfo
Estructura que contiene información de metadatos para una versión de esquema.
Campos
-
MetadataValue: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo, que coincide con el Custom string pattern #34.Valor correspondiente de una clave de metadatos.
-
CreatedTime: cadena UTF-8.La hora a la que se creó la entrada.
-
OtherMetadataValueList: matriz de objetos OtherMetadataValueListItem.Otros metadatos pertenecientes a la misma clave de metadatos.
Estructura OtherMetadataValueListItem
Estructura que contiene otros metadatos para una versión de esquema que pertenece a la misma clave de metadatos.
Campos
-
MetadataValue: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo, que coincide con el Custom string pattern #34.El valor correspondiente de la clave de metadatos para los demás metadatos pertenecientes a la misma clave de metadatos.
-
CreatedTime: cadena UTF-8.La hora a la que se creó la entrada.
Estructura SchemaListItem
Objeto que contiene detalles mínimos de un esquema.
Campos
-
RegistryName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.Nombre del registro donde reside el esquema.
-
SchemaName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.El nombre del esquema.
-
SchemaArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.Nombre de recurso de Amazon (ARN) del esquema.
-
Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.Una descripción del esquema.
-
SchemaStatus: cadena UTF-8 (valores válidos:AVAILABLE|PENDING|DELETING).Estado del esquema.
-
CreatedTime: cadena UTF-8.La fecha y hora en que se creó el esquema.
-
UpdatedTime: cadena UTF-8.La fecha y hora en que se actualizó el esquema.
Estructura SchemaVersionListItem
Objeto que contiene los detalles sobre una versión de esquema.
Campos
-
SchemaArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.Nombre de recurso de Amazon (ARN) del esquema.
-
SchemaVersionId: cadena UTF-8, con 36 bytes de largo como mínimo y 36 bytes de largo como máximo, que coincide con el Custom string pattern #17.El identificador único de la versión del esquema.
-
VersionNumber: número (largo) que no es inferior a 1 ni es superior a 100 000.El número de versión del esquema.
-
Status: cadena UTF-8 (valores válidos:AVAILABLE|PENDING|FAILURE|DELETING).El estado de la versión del esquema.
-
CreatedTime: cadena UTF-8.La fecha y hora en que se creó la versión del esquema.
Estructura MetadataKeyValuePair
Una estructura que contiene un par de valor-clave para metadatos.
Campos
-
MetadataKey: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #34.Una clave de metadatos.
-
MetadataValue: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo, que coincide con el Custom string pattern #34.Valor correspondiente de una clave de metadatos.
Estructura SchemaVersionErrorItem
Objeto que contiene los detalles de error de una operación en una versión de esquema.
Campos
-
VersionNumber: número (largo) que no es inferior a 1 ni es superior a 100 000.El número de versión del esquema.
-
ErrorDetails: un objeto ErrorDetails.Detalles del error para la versión del esquema.
Estructura ErrorDetails
Objeto que contiene detalles de error.
Campos
-
ErrorCode: cadena UTF-8.El código de error de un error.
-
ErrorMessage: cadena UTF-8.El mensaje de un error.
Estructura SchemaVersionNumber
Una estructura que contiene la información de versión del esquema.
Campos
-
LatestVersion: booleano.La última versión disponible para el esquema.
-
VersionNumber: número (largo) que no es inferior a 1 ni es superior a 100 000.El número de versión del esquema.
Estructura SchemaId
ID único del esquema en el registro de esquemas de AWS Glue.
Campos
-
SchemaArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.Nombre de recurso de Amazon (ARN) del esquema. Uno de
SchemaArnoSchemaNamedebe ser proporcionado. -
SchemaName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.El nombre del esquema. Uno de
SchemaArnoSchemaNamedebe ser proporcionado. -
RegistryName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.Nombre del registro de esquemas que contiene el esquema.
Operaciones
Acción GetSchemaVersionsDiff (Python: get_schema_versions_diff)
Acción RegisterSchemaVersion (Python: register_schema_version)
Acción CheckSchemaVersionValidity (Python: check_schema_version_validity)
Acción GetSchemabyDefinition (Python: get_schema_by_definition)
Acción PutSchemaVersionMetadata (Python: put_schema_version_metadata)
Acción QuerySchemaVersionMetadata (Python: query_schema_version_metadata)
Acción RemoveSchemaVersionMetadata (Python: remove_schema_version_metadata)
Acción DeleteSchemaVersions (Python: delete_schema_versions)
Acción CreateRegistry (Python: create_registry)
Crea un nuevo registro que se puede utilizar para contener una recopilación de esquemas.
Solicitud
-
RegistryName: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.Nombre del registro que se va a crear con una longitud máxima de 255, solo puede contener letras, números, guión, guión bajo, signo de dólar o marca hash. Sin espacio en blanco.
-
Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.Es una descripción del recurso. Si no se proporciona una descripción, no habrá ningún valor predeterminado para esto.
-
Tags: matriz de mapas de pares de clave-valor, con 50 pares como máximo.Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes.
Cada valor es una cadena UTF-8 que no tiene más de 256 bytes de largo.
Etiquetas de AWS que contienen un par de valor-clave y se pueden buscar por consola, línea de comandos o API.
Respuesta
-
RegistryArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.El nombre de recurso de Amazon (ARN) del registro recientemente creado.
-
RegistryName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.El nombre del registro.
-
Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.Es una descripción del recurso.
-
Tags: matriz de mapas de pares de clave-valor, con 50 pares como máximo.Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes.
Cada valor es una cadena UTF-8 que no tiene más de 256 bytes de largo.
Etiquetas para el registro.
Errores
InvalidInputExceptionAccessDeniedExceptionAlreadyExistsExceptionResourceNumberLimitExceededExceptionConcurrentModificationExceptionInternalServiceException
Acción CreateSchema (Python: create_schema)
Crea un nuevo conjunto de esquemas y registra la definición de esquema. Devuelve un error si el conjunto de esquemas ya existe sin haber registrado realmente la versión.
Cuando se crea el conjunto de esquemas, se establecerá un punto de comprobación de versión en la primera versión. El modo de compatibilidad “DISABLED (DESACTIVADO)” restringe el agregado de versiones de esquema adicionales después de la primera versión del esquema. Para todos los demás modos de compatibilidad, la validación de la configuración de compatibilidad solo se aplicará a partir de la segunda versión cuando se utilice la API de RegisterSchemaVersion.
Cuando se llama a esta API sin un RegistryId, esto creará una entrada para un “registro predeterminado” en las tablas de la base de datos del registro, si aún no se encuentra incluido.
Solicitud
-
RegistryId: un objeto RegistryId.Esta es una forma de encapsulador que contiene los campos de identidad del registro. Si no se proporciona, se usará el registro predeterminado. El formato del ARN para el mismo será:
arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id. -
SchemaName: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.Nombre del esquema que se va a crear con una longitud máxima de 255, y solo puede contener letras, números, guión, guión bajo, signo de dólar o marca hash. Sin espacio en blanco.
-
DataFormat– Obligatorio: cadena UTF-8 (valores válidos:AVRO|JSON|PROTOBUF).El formato de datos de la definición de esquema.
AVRO,JSONyPROTOBUFse admiten en la actualidad. -
Compatibility: cadena UTF-8 (valores válidos:NONE|DISABLED|BACKWARD|BACKWARD_ALL|FORWARD|FORWARD_ALL|FULL|FULL_ALL).El modo de compatibilidad del esquema. Los valores posibles son:
-
NONE (NINGUNO): no se aplica ningún modo de compatibilidad. Puede utilizar esta opción en escenarios de desarrollo o si no conoce el modo de compatibilidad que desea aplicar a los esquemas. Cualquier nueva versión que se agregue será aceptada sin someterse a una comprobación de compatibilidad.
-
DISABLED (DESACTIVADO): esta opción de compatibilidad impide el control de versiones de un esquema en particular. Puede utilizar esta opción para evitar el control de versiones de un esquema a futuro.
-
BACKWARDS (HACIA ATRÁS): se recomienda esta opción de compatibilidad ya que permite a los receptores de datos leer tanto la versión actual como la anterior del esquema. Esto significa que, por ejemplo, una nueva versión de esquema no puede eliminar campos de datos ni cambiar el tipo de estos campos, por lo que los lectores no pueden leerlos con la versión anterior.
-
BACKWARD_ALL (HACIA ATRÁS_TODO): esta opción de compatibilidad permite a los receptores de datos leer tanto la versión actual como todas las versiones anteriores del esquema. Puede utilizar esta opción cuando necesite eliminar campos o agregar campos opcionales, y comprobar la compatibilidad con todas las versiones de esquema anteriores.
-
FORWARD (HACIA ADELANTE): esta opción de compatibilidad permite a los receptores de datos leer tanto la versión actual como la inmediatamente siguiente del esquema, pero no necesariamente versiones posteriores. Puede utilizar esta opción cuando necesite agregar campos o eliminar campos opcionales, pero comprobar la compatibilidad con la última versión del esquema únicamente.
-
FORWARD_ALL (HACIA ADELANTE_TODO): esta opción de compatibilidad permite a los receptores de datos leer datos escritos por los productores de cualquier nuevo esquema registrado. Puede utilizar esta opción cuando necesite agregar campos o eliminar campos opcionales, y comprobar la compatibilidad con todas las versiones de esquema anteriores.
-
FULL (COMPLETO): esta opción de compatibilidad permite a los receptores de datos leer los datos escritos por los productores utilizando la versión inmediatamente anterior o siguiente del esquema, pero no necesariamente versiones anteriores o posteriores. Puede utilizar esta opción cuando necesite agregar campos o eliminar campos opcionales, pero comprobar la compatibilidad con la última versión del esquema únicamente.
-
FULL_ALL (COMPLETO_TODO): esta opción de compatibilidad permite a los receptores de datos leer los datos escritos por los productores utilizando todas las versiones de esquema anteriores. Puede utilizar esta opción cuando necesite agregar campos o eliminar campos opcionales, y comprobar la compatibilidad con todas las versiones anteriores del esquema.
-
-
Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.Una descripción opcional del esquema. Si no se proporciona una descripción, no habrá ningún valor predeterminado automático para esto.
-
Tags: matriz de mapas de pares de clave-valor, con 50 pares como máximo.Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes.
Cada valor es una cadena UTF-8 que no tiene más de 256 bytes de largo.
Etiquetas de AWS que contienen un par de valor-clave y se pueden buscar por consola, línea de comandos o API. Si se especifica, sigue el patrón tags-on-create de AWS.
-
SchemaDefinition: cadena UTF-8, con 1 byte de largo como mínimo y 170 000 bytes de largo como máximo, que coincide con el Custom string pattern #33.Definición de esquema que utiliza la configuración
DataFormatdeSchemaName.
Respuesta
-
RegistryName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.El nombre del registro.
-
RegistryArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.Nombre de recurso de Amazon (ARN) del registro.
-
SchemaName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.El nombre del esquema.
-
SchemaArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.Nombre de recurso de Amazon (ARN) del esquema.
-
Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.Una descripción del esquema si se especifica cuando se crea.
-
DataFormat: cadena UTF-8 (valores válidos:AVRO|JSON|PROTOBUF).El formato de datos de la definición de esquema.
AVRO,JSONyPROTOBUFse admiten en la actualidad. -
Compatibility: cadena UTF-8 (valores válidos:NONE|DISABLED|BACKWARD|BACKWARD_ALL|FORWARD|FORWARD_ALL|FULL|FULL_ALL).El modo de compatibilidad del esquema.
-
SchemaCheckpoint: número (largo) que no es inferior a 1 ni es superior a 100 000.El número de versión del punto de comprobación (la última vez que se cambió el modo de compatibilidad).
-
LatestSchemaVersion: número (largo) que no es inferior a 1 ni es superior a 100 000.La última versión del esquema asociada a la definición del esquema devuelta.
-
NextSchemaVersion: número (largo) que no es inferior a 1 ni es superior a 100 000.La siguiente versión del esquema asociada a la definición de esquema devuelta.
-
SchemaStatus: cadena UTF-8 (valores válidos:AVAILABLE|PENDING|DELETING).Estado del esquema.
-
Tags: matriz de mapas de pares de clave-valor, con 50 pares como máximo.Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes.
Cada valor es una cadena UTF-8 que no tiene más de 256 bytes de largo.
Etiquetas para el esquema.
-
SchemaVersionId: cadena UTF-8, con 36 bytes de largo como mínimo y 36 bytes de largo como máximo, que coincide con el Custom string pattern #17.El identificador único de la primera versión del esquema.
-
SchemaVersionStatus: cadena UTF-8 (valores válidos:AVAILABLE|PENDING|FAILURE|DELETING).El estado de la primera versión creada del esquema.
Errores
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionAlreadyExistsExceptionResourceNumberLimitExceededExceptionConcurrentModificationExceptionInternalServiceException
Acción GetSchema (Python: get_schema)
Describe el esquema especificado en detalle.
Solicitud
-
SchemaId: obligatorio: objeto SchemaId.Una estructura de encapsulador que contiene campos de identidad de esquema. La estructura contiene lo siguiente:
-
SchemaId$SchemaArn: nombre del recurso de Amazon (ARN) del esquema. Se debe proporcionar
SchemaArnoSchemaNameyRegistryName. -
SchemaId$SchemaName: el nombre del esquema. Se debe proporcionar
SchemaArnoSchemaNameyRegistryName.
-
Respuesta
-
RegistryName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.El nombre del registro.
-
RegistryArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.Nombre de recurso de Amazon (ARN) del registro.
-
SchemaName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.El nombre del esquema.
-
SchemaArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.Nombre de recurso de Amazon (ARN) del esquema.
-
Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.Se especifica una descripción del esquema en el momento de la creación
-
DataFormat: cadena UTF-8 (valores válidos:AVRO|JSON|PROTOBUF).El formato de datos de la definición de esquema.
AVRO,JSONyPROTOBUFse admiten en la actualidad. -
Compatibility: cadena UTF-8 (valores válidos:NONE|DISABLED|BACKWARD|BACKWARD_ALL|FORWARD|FORWARD_ALL|FULL|FULL_ALL).El modo de compatibilidad del esquema.
-
SchemaCheckpoint: número (largo) que no es inferior a 1 ni es superior a 100 000.El número de versión del punto de comprobación (la última vez que se cambió el modo de compatibilidad).
-
LatestSchemaVersion: número (largo) que no es inferior a 1 ni es superior a 100 000.La última versión del esquema asociada a la definición del esquema devuelta.
-
NextSchemaVersion: número (largo) que no es inferior a 1 ni es superior a 100 000.La siguiente versión del esquema asociada a la definición de esquema devuelta.
-
SchemaStatus: cadena UTF-8 (valores válidos:AVAILABLE|PENDING|DELETING).Estado del esquema.
-
CreatedTime: cadena UTF-8.La fecha y hora en que se creó el esquema.
-
UpdatedTime: cadena UTF-8.La fecha y hora en que se actualizó el esquema.
Errores
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
Acción ListSchemaVersions (Python: list_schema_versions)
Devuelve una lista de versiones de esquema que ha creado, con información mínima. Las versiones del esquema en estado Deleted (Eliminado) no se incluirán en los resultados. Los resultados vacíos se devolverán si no hay versiones de esquema disponibles.
Solicitud
-
SchemaId: obligatorio: objeto SchemaId.Una estructura de encapsulador que contiene campos de identidad de esquema. La estructura contiene lo siguiente:
-
SchemaId$SchemaArn: nombre del recurso de Amazon (ARN) del esquema. Se debe proporcionar
SchemaArnoSchemaNameyRegistryName. -
SchemaId$SchemaName: el nombre del esquema. Se debe proporcionar
SchemaArnoSchemaNameyRegistryName.
-
-
MaxResults: número (entero) que no es inferior a 1 ni es superior a 100.Número máximo de resultados requeridos por página. Si no se proporciona el valor, el valor predeterminado será 25 por página.
-
NextToken: cadena UTF-8.Token de continuación si se trata de una llamada de continuidad.
Respuesta
-
Schemas: matriz de objetos SchemaVersionListItem.Una matriz de objetos de
SchemaVersionListque contiene detalles de cada versión del esquema. -
NextToken: cadena UTF-8.Token de continuación para paginar la lista de tokens obtenida; se devuelve si el segmento actual de la lista no es el último.
Errores
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
Acción GetSchemaVersion (Python: get_schema_version)
Obtenga el esquema especificado por su ID único asignado cuando se crea o registra una versión del esquema. Las versiones del esquema en estado Deleted (Eliminado) no se incluirán en los resultados.
Solicitud
-
SchemaId: un objeto SchemaId.Una estructura de encapsulador que contiene campos de identidad de esquema. La estructura contiene lo siguiente:
-
SchemaId$SchemaArn: nombre del recurso de Amazon (ARN) del esquema. Se debe proporcionar
SchemaArnoSchemaNameyRegistryName. -
SchemaId$SchemaName: el nombre del esquema. Se debe proporcionar
SchemaArnoSchemaNameyRegistryName.
-
-
SchemaVersionId: cadena UTF-8, con 36 bytes de largo como mínimo y 36 bytes de largo como máximo, que coincide con el Custom string pattern #17.El
SchemaVersionIdde versión del esquema. Este campo es obligatorio para recuperar por ID de esquema. Se debe proporcionar este encapsulador oSchemaId. -
SchemaVersionNumber: un objeto SchemaVersionNumber.El número de versión del esquema.
Respuesta
-
SchemaVersionId: cadena UTF-8, con 36 bytes de largo como mínimo y 36 bytes de largo como máximo, que coincide con el Custom string pattern #17.El
SchemaVersionIdde versión del esquema. -
SchemaDefinition: cadena UTF-8, con 1 byte de largo como mínimo y 170 000 bytes de largo como máximo, que coincide con el Custom string pattern #33.Definición de esquema para ID del esquema.
-
DataFormat: cadena UTF-8 (valores válidos:AVRO|JSON|PROTOBUF).El formato de datos de la definición de esquema.
AVRO,JSONyPROTOBUFse admiten en la actualidad. -
SchemaArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.Nombre de recurso de Amazon (ARN) del esquema.
-
VersionNumber: número (largo) que no es inferior a 1 ni es superior a 100 000.El número de versión del esquema.
-
Status: cadena UTF-8 (valores válidos:AVAILABLE|PENDING|FAILURE|DELETING).El estado de la versión del esquema.
-
CreatedTime: cadena UTF-8.La fecha y hora en que se creó la versión del esquema.
Errores
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
Acción GetSchemaVersionsDiff (Python: get_schema_versions_diff)
Recupera la diferencia de versión del esquema en el tipo de diferencia especificado entre dos versiones de esquema almacenadas en el Schema Registry.
Esta API le permite comparar dos versiones entre dos definiciones de esquemas bajo el mismo esquema.
Solicitud
-
SchemaId: obligatorio: objeto SchemaId.Una estructura de encapsulador que contiene campos de identidad de esquema. La estructura contiene lo siguiente:
-
SchemaId$SchemaArn: nombre del recurso de Amazon (ARN) del esquema. Uno de
SchemaArnoSchemaNamedebe ser proporcionado. -
SchemaId$SchemaName: el nombre del esquema. Uno de
SchemaArnoSchemaNamedebe ser proporcionado.
-
-
FirstSchemaVersionNumber: obligatorio: objeto SchemaVersionNumber.La primera de las dos versiones de esquema que se van a comparar.
-
SecondSchemaVersionNumber: obligatorio: objeto SchemaVersionNumber.La segunda de las dos versiones de esquema que se van a comparar.
-
SchemaDiffType– Obligatorio: cadena UTF-8 (valores válidos:SYNTAX_DIFF).Se refiere a
SYNTAX_DIFF, que es el tipo diferente que se soporta actualmente.
Respuesta
-
Diff: cadena UTF-8, con 1 byte de largo como mínimo y 340 000 bytes de largo como máximo, que coincide con el Custom string pattern #33.La diferencia entre esquemas como una cadena en formato JsonPatch.
Errores
InvalidInputExceptionEntityNotFoundExceptionAccessDeniedExceptionInternalServiceException
Acción ListRegistries (Python: list_registries)
Devuelve una lista de registros que ha creado, con información mínima del registro. Los registros con estado Deleting no se incluirá en los resultados. Se devolverán resultados vacíos si no hay registros disponibles.
Solicitud
-
MaxResults: número (entero) que no es inferior a 1 ni es superior a 100.Número máximo de resultados requeridos por página. Si no se proporciona el valor, el valor predeterminado será 25 por página.
-
NextToken: cadena UTF-8.Token de continuación si se trata de una llamada de continuidad.
Respuesta
-
Registries: matriz de objetos RegistryListItem.Una matriz de objetos
RegistryDetailedListItemque contienen detalles mínimos de cada registro. -
NextToken: cadena UTF-8.Token de continuación para paginar la lista de tokens obtenida; se devuelve si el segmento actual de la lista no es el último.
Errores
InvalidInputExceptionAccessDeniedExceptionInternalServiceException
Acción ListSchemas (Python: list_schemas)
Devuelve una lista de esquemas con detalles mínimos. Los esquemas con estado Deleting (Eliminación) no se incluirán en los resultados. Se devolverán resultados vacíos si no hay esquemas disponibles.
Cuando no se proporciona el RegistryId, todos los esquemas de los registros formarán parte de la respuesta de la API.
Solicitud
-
RegistryId: un objeto RegistryId.Una estructura de encapsulador que puede contener el nombre de registro y el nombre de recurso de Amazon (ARN).
-
MaxResults: número (entero) que no es inferior a 1 ni es superior a 100.Número máximo de resultados requeridos por página. Si no se proporciona el valor, el valor predeterminado será 25 por página.
-
NextToken: cadena UTF-8.Token de continuación si se trata de una llamada de continuidad.
Respuesta
-
Schemas: matriz de objetos SchemalistItem.Una matriz de objetos
SchemaListItemque contienen detalles de cada esquema. -
NextToken: cadena UTF-8.Token de continuación para paginar la lista de tokens obtenida; se devuelve si el segmento actual de la lista no es el último.
Errores
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
Acción RegisterSchemaVersion (Python: register_schema_version)
Agrega una nueva versión al esquema existente. Devuelve un error si la nueva versión del esquema no cumple los requisitos de compatibilidad del conjunto de esquemas. Esta API no creará un nuevo conjunto de esquemas y devolverá un error 404 si el conjunto de esquemas no está ya presente en el Schema Registry.
Si esta es la primera definición de esquema que se registra en el Schema Registry, esta API almacenará la versión del esquema y la devolverá inmediatamente. De lo contrario, esta llamada tiene el potencial de ejecutarse más tiempo que otras operaciones debido a los modos de compatibilidad. Puede invocar la API de GetSchemaVersion con el SchemaVersionId para comprobar los modos de compatibilidad.
Si la misma definición de esquema ya está almacenada en el Schema Registry como una versión, el ID del esquema existente se devuelve al que realiza la llamada.
Solicitud
-
SchemaId: obligatorio: objeto SchemaId.Una estructura de encapsulador que contiene campos de identidad de esquema. La estructura contiene lo siguiente:
-
SchemaId$SchemaArn: nombre del recurso de Amazon (ARN) del esquema. Se debe proporcionar
SchemaArnoSchemaNameyRegistryName. -
SchemaId$SchemaName: el nombre del esquema. Se debe proporcionar
SchemaArnoSchemaNameyRegistryName.
-
-
SchemaDefinition– Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 170 000 bytes de largo como máximo, que coincide con el Custom string pattern #33.Definición de esquema que utiliza la configuración
DataFormatpara elSchemaName.
Respuesta
-
SchemaVersionId: cadena UTF-8, con 36 bytes de largo como mínimo y 36 bytes de largo como máximo, que coincide con el Custom string pattern #17.El ID único que representa la versión de este esquema.
-
VersionNumber: número (largo) que no es inferior a 1 ni es superior a 100 000.La versión de este esquema (solo para flujo de sincronización, en caso de que sea la primera versión).
-
Status: cadena UTF-8 (valores válidos:AVAILABLE|PENDING|FAILURE|DELETING).El estado de la versión del esquema.
Errores
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionResourceNumberLimitExceededExceptionConcurrentModificationExceptionInternalServiceException
Acción UpdateSchema (Python: update_schema)
Actualiza la descripción, la configuración de compatibilidad o el punto de comprobación de la versión de un conjunto de esquemas.
Para actualizar la configuración de compatibilidad, la llamada no validará la compatibilidad para todo el conjunto de versiones de esquema con la nueva configuración de compatibilidad. Si se proporciona el valor de Compatibility, también se requiere el VersionNumber (un punto de comprobación). La API validará el número de versión del punto de comprobación para fines de coherencia.
Si se proporciona el valor del VersionNumber (punto de comprobación), la Compatibility es opcional y esto se puede usar para establecer/restablecer un punto de comprobación para el esquema.
Esta actualización sólo se realizará si el esquema está en el estado AVAILABLE (DISPONIBLE).
Solicitud
-
SchemaId: obligatorio: objeto SchemaId.Una estructura de encapsulador que contiene campos de identidad de esquema. La estructura contiene lo siguiente:
-
SchemaId$SchemaArn: nombre del recurso de Amazon (ARN) del esquema. Uno de
SchemaArnoSchemaNamedebe ser proporcionado. -
SchemaId$SchemaName: el nombre del esquema. Uno de
SchemaArnoSchemaNamedebe ser proporcionado.
-
-
SchemaVersionNumber: un objeto SchemaVersionNumber.Se requiere el número de versión para realizar la comprobación. Uno de
VersionNumberoCompatibilitydebe ser proporcionado. -
Compatibility: cadena UTF-8 (valores válidos:NONE|DISABLED|BACKWARD|BACKWARD_ALL|FORWARD|FORWARD_ALL|FULL|FULL_ALL).La nueva configuración de compatibilidad para el esquema.
-
Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.La nueva descripción del esquema.
Respuesta
-
SchemaArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.Nombre de recurso de Amazon (ARN) del esquema.
-
SchemaName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.El nombre del esquema.
-
RegistryName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.Nombre del registro que contiene el esquema.
Errores
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionConcurrentModificationExceptionInternalServiceException
Acción CheckSchemaVersionValidity (Python: check_schema_version_validity)
Valida el esquema suministrado. Esta llamada no tiene efectos secundarios, simplemente valida el uso del esquema suministrado con DataFormat como el formato. Dado que no toma un nombre de conjunto de esquemas, no se realizan comprobaciones de compatibilidad.
Solicitud
-
DataFormat– Obligatorio: cadena UTF-8 (valores válidos:AVRO|JSON|PROTOBUF).El formato de datos de la definición de esquema.
AVRO,JSONyPROTOBUFse admiten en la actualidad. -
SchemaDefinition– Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 170 000 bytes de largo como máximo, que coincide con el Custom string pattern #33.La definición del esquema que debe validarse.
Respuesta
-
Valid: booleano.Devuelve verdadero, si el esquema es válido y falso en caso contrario.
-
Error: cadena UTF-8, con 1 byte de largo como mínimo y 5000 bytes de largo como máximo.Mensaje de error por falla de validación.
Errores
InvalidInputExceptionAccessDeniedExceptionInternalServiceException
Acción UpdateRegistry (Python: update_registry)
Actualiza un registro existente que se utiliza para contener una recopilación de esquemas. Las propiedades actualizadas se relacionan con el registro y no modifican ninguno de los esquemas dentro del registro.
Solicitud
-
RegistryId: obligatorio: objeto RegistryId.Una estructura de encapsulador que puede contener el nombre del registro y el nombre de recurso de Amazon (ARN).
-
Description– Obligatorio: cadena de descripción, máximo de 2048 bytes de largo, que coincide con URI address multi-line string pattern.Es una descripción del recurso. Si no se proporciona una descripción, este campo no se actualizará.
Respuesta
-
RegistryName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.El nombre del registro actualizado.
-
RegistryArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.Nombre de recurso de Amazon (ARN) del registro actualizado.
Errores
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionConcurrentModificationExceptionInternalServiceException
Acción GetSchemabyDefinition (Python: get_schema_by_definition)
Recupera un esquema mediante la SchemaDefinition. La definición de esquema se envía a Schema Registry, se canonicaliza y se resume en un hash. Si el hash se hace coincidir dentro del alcance del SchemaName o ARN (o el registro predeterminado, si no se proporciona ninguno), se devuelven los metadatos de ese esquema. De lo contrario, se devuelve un error 404 o NotFound (No encontrado). Las versiones del esquema con estado Deleted no se incluirán en los resultados.
Solicitud
-
SchemaId: obligatorio: objeto SchemaId.Una estructura de encapsulador que contiene campos de identidad de esquema. La estructura contiene lo siguiente:
-
SchemaId$SchemaArn: nombre del recurso de Amazon (ARN) del esquema. Uno de
SchemaArnoSchemaNamedebe ser proporcionado. -
SchemaId$SchemaName: el nombre del esquema. Uno de
SchemaArnoSchemaNamedebe ser proporcionado.
-
-
SchemaDefinition– Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 170 000 bytes de largo como máximo, que coincide con el Custom string pattern #33.Definición del esquema para el que se requieren detalles de esquema.
Respuesta
-
SchemaVersionId: cadena UTF-8, con 36 bytes de largo como mínimo y 36 bytes de largo como máximo, que coincide con el Custom string pattern #17.El ID de esquema de la versión del esquema.
-
SchemaArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.Nombre de recurso de Amazon (ARN) del esquema.
-
DataFormat: cadena UTF-8 (valores válidos:AVRO|JSON|PROTOBUF).El formato de datos de la definición de esquema.
AVRO,JSONyPROTOBUFse admiten en la actualidad. -
Status: cadena UTF-8 (valores válidos:AVAILABLE|PENDING|FAILURE|DELETING).El estado de la versión del esquema.
-
CreatedTime: cadena UTF-8.La fecha y hora en que se creó el esquema.
Errores
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
Acción GetRegistry (Python: get_registry)
Describe el registro especificado en detalle.
Solicitud
-
RegistryId: obligatorio: objeto RegistryId.Una estructura de encapsulador que puede contener el nombre del registro y el nombre de recurso de Amazon (ARN).
Respuesta
-
RegistryName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.El nombre del registro.
-
RegistryArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.Nombre de recurso de Amazon (ARN) del registro.
-
Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.Es una descripción del recurso.
-
Status: cadena UTF-8 (valores válidos:AVAILABLE|DELETING).Estado del registro.
-
CreatedTime: cadena UTF-8.La fecha y hora en que se creó el registro.
-
UpdatedTime: cadena UTF-8.La fecha y hora en que se actualizó el registro.
Errores
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
Acción PutSchemaVersionMetadata (Python: put_schema_version_metadata)
Coloca el par valor-clave de los metadatos para un ID de versión de esquema especificado. Se permitirá un máximo de 10 pares valor-clave por versión de esquema. Se pueden agregar a través de una o más llamadas.
Solicitud
-
SchemaId: un objeto SchemaId.El ID único del esquema.
-
SchemaVersionNumber: un objeto SchemaVersionNumber.El número de versión del esquema.
-
SchemaVersionId: cadena UTF-8, con 36 bytes de largo como mínimo y 36 bytes de largo como máximo, que coincide con el Custom string pattern #17.El ID de versión único de la versión del esquema.
-
MetadataKeyValue: obligatorio: objeto MetadataKeyValuePair.Valor correspondiente de una clave de metadatos.
Respuesta
-
SchemaArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.Nombre de recurso de Amazon (ARN) del esquema.
-
SchemaName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.El nombre para el esquema.
-
RegistryName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.El nombre para el registro.
-
LatestVersion: booleano.La última versión del esquema.
-
VersionNumber: número (largo) que no es inferior a 1 ni es superior a 100 000.El número de versión del esquema.
-
SchemaVersionId: cadena UTF-8, con 36 bytes de largo como mínimo y 36 bytes de largo como máximo, que coincide con el Custom string pattern #17.El ID de versión único de la versión del esquema.
-
MetadataKey: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #34.La clave de metadatos.
-
MetadataValue: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo, que coincide con el Custom string pattern #34.El valor de la clave de metadatos.
Errores
InvalidInputExceptionAccessDeniedExceptionAlreadyExistsExceptionEntityNotFoundExceptionResourceNumberLimitExceededException
Acción QuerySchemaVersionMetadata (Python: query_schema_version_metadata)
Consulta la información de metadatos de versión del esquema.
Solicitud
-
SchemaId: un objeto SchemaId.Una estructura de encapsulador que puede contener el nombre del esquema y el nombre de recurso de Amazon (ARN).
-
SchemaVersionNumber: un objeto SchemaVersionNumber.El número de versión del esquema.
-
SchemaVersionId: cadena UTF-8, con 36 bytes de largo como mínimo y 36 bytes de largo como máximo, que coincide con el Custom string pattern #17.El ID de versión único de la versión del esquema.
-
MetadataList: matriz de objetos MetadataKeyValuePair.Busca los pares clave-valor para los metadatos, si no se proporcionan se obtendrá toda la información de los metadatos.
-
MaxResults: número (entero) que no es inferior a 1 ni es superior a 50.Número máximo de resultados requeridos por página. Si no se proporciona el valor, el valor predeterminado será 25 por página.
-
NextToken: cadena UTF-8.Token de continuación si se trata de una llamada de continuidad.
Respuesta
-
MetadataInfoMap: matriz de mapas de pares clave-valor.Cada clave es una cadena UTF-8 con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con Custom string pattern #34.
Cada valor es un objeto A MetadataInfo.
Mapa de una clave de metadatos y valores asociados.
-
SchemaVersionId: cadena UTF-8, con 36 bytes de largo como mínimo y 36 bytes de largo como máximo, que coincide con el Custom string pattern #17.El ID de versión único de la versión del esquema.
-
NextToken: cadena UTF-8.Token de continuación para paginar la lista de tokens obtenida; se devuelve si el segmento actual de la lista no es el último.
Errores
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundException
Acción RemoveSchemaVersionMetadata (Python: remove_schema_version_metadata)
Elimina un par valor-clave de los metadatos de la versión del esquema para el ID de versión de esquema especificado.
Solicitud
-
SchemaId: un objeto SchemaId.Una estructura de encapsulador que puede contener el nombre del esquema y el nombre de recurso de Amazon (ARN).
-
SchemaVersionNumber: un objeto SchemaVersionNumber.El número de versión del esquema.
-
SchemaVersionId: cadena UTF-8, con 36 bytes de largo como mínimo y 36 bytes de largo como máximo, que coincide con el Custom string pattern #17.El ID de versión único de la versión del esquema.
-
MetadataKeyValue: obligatorio: objeto MetadataKeyValuePair.El valor de la clave de metadatos.
Respuesta
-
SchemaArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.Nombre de recurso de Amazon (ARN) del esquema.
-
SchemaName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.El nombre del esquema.
-
RegistryName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.El nombre del registro.
-
LatestVersion: booleano.La última versión del esquema.
-
VersionNumber: número (largo) que no es inferior a 1 ni es superior a 100 000.El número de versión del esquema.
-
SchemaVersionId: cadena UTF-8, con 36 bytes de largo como mínimo y 36 bytes de largo como máximo, que coincide con el Custom string pattern #17.El ID de versión de la versión del esquema.
-
MetadataKey: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #34.La clave de metadatos.
-
MetadataValue: cadena UTF-8, con 1 byte de largo como mínimo y 256 bytes de largo como máximo, que coincide con el Custom string pattern #34.El valor de la clave de metadatos.
Errores
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundException
Acción DeleteRegistry (Python: delete_registry)
Elimina todo el registro, incluido el esquema y todas sus versiones. Para obtener el estado de la operación de eliminación, puede llamar a la API GetRegistry después de la llamada asíncrona. Al eliminar un registro se desactivarán todas las operaciones en línea para el registro, como las API UpdateRegistry, CreateSchema, UpdateSchema y RegisterSchemaVersion.
Solicitud
-
RegistryId: obligatorio: objeto RegistryId.Una estructura de encapsulador que puede contener el nombre del registro y el nombre de recurso de Amazon (ARN).
Respuesta
-
RegistryName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.El nombre del registro que se está eliminando.
-
RegistryArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.El nombre de recurso de Amazon (ARN) del registro que se está eliminando.
-
Status: cadena UTF-8 (valores válidos:AVAILABLE|DELETING).Estado del registro. Una operación exitosa devolverá el estado
Deleting.
Errores
InvalidInputExceptionEntityNotFoundExceptionAccessDeniedExceptionConcurrentModificationException
Acción DeleteSchema (Python: delete_schema)
Elimina todo el conjunto de esquemas, incluido el conjunto de esquemas y todas sus versiones. Para obtener el estado de la operación de eliminación, puede llamar a la API GetSchema después de la llamada asíncrona. Al eliminar un registro se desactivarán todas las operaciones en línea para el esquema, como las API GetSchemaByDefinition y RegisterSchemaVersion.
Solicitud
-
SchemaId: obligatorio: objeto SchemaId.Es una estructura de encapsulador que puede contener el nombre del esquema y el nombre de recurso de Amazon (ARN).
Respuesta
-
SchemaArn: cadena UTF-8, con 1 byte de largo como mínimo y 10 240 bytes de largo como máximo, que coincide con el Custom string pattern #22.Nombre de recurso de Amazon (ARN) del esquema que se está eliminando.
-
SchemaName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #18.El nombre del esquema que se está eliminando.
-
Status: cadena UTF-8 (valores válidos:AVAILABLE|PENDING|DELETING).Estado del esquema.
Errores
InvalidInputExceptionEntityNotFoundExceptionAccessDeniedExceptionConcurrentModificationException
Acción DeleteSchemaVersions (Python: delete_schema_versions)
Elimina versiones del esquema especificado. Se puede suministrar un número o rango de versiones. Si el modo de compatibilidad prohíbe eliminar una versión necesaria, como HACIA ATRÁS_COMPLETO, se devuelve un error. Llamar a la API GetSchemaVersions después de esta llamada arrojará una lista del estado de las versiones eliminadas.
Cuando el rango de números de versión contiene versiones de punto de comprobación, la API devolverá un conflicto 409 y no continuará con la eliminación. Primero debe eliminar el punto de comprobación con la API DeleteSchemaCheckpoint, antes de usar esta API.
No puede usar la API DeleteSchemaVersions para eliminar la primera versión del esquema de un conjunto de esquemas. La primera versión del esquema sólo puede ser eliminada por la API DeleteSchema. Esta operación también eliminará los SchemaVersionMetadata asociados con las versiones del esquema. Se aplicarán eliminaciones fragmentadas en la base de datos.
Si el modo de compatibilidad prohíbe eliminar una versión necesaria, como HACIA ATRÁS_COMPLETO, se devuelve un error.
Solicitud
-
SchemaId: obligatorio: objeto SchemaId.Es una estructura de encapsulador que puede contener el nombre del esquema y el nombre de recurso de Amazon (ARN).
-
Versions– Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 100 000 bytes de largo como máximo, que coincide con el Custom string pattern #35.Puede suministrarse un rango de versiones que puede tener el siguiente formato:
-
un único número de versión, 5
-
un rango, 5-8: elimina las versiones 5, 6, 7, 8
-
Respuesta
-
SchemaVersionErrors: matriz de objetos SchemaVersionErrorItem.Una lista de objetos
SchemaVersionErrorItem, cada uno de los cuales contiene un error y una versión de esquema.
Errores
InvalidInputExceptionEntityNotFoundExceptionAccessDeniedExceptionConcurrentModificationException
