Registre de schémas

L'API de registre des schémas décrit les types de données et l'API liés à l'utilisation des schémas dans AWS Glue.

Types de données

• RegistryId structure

• RegistryListItem structure

• MetadataInfo structure

• OtherMetadataValueListItem structure

• SchemaListItem structure

• SchemaVersionListItem structure

• MetadataKeyValuePair structure

• SchemaVersionErrorItem structure

• ErrorDetails structure

• SchemaVersionNumber structure

• SchemaId structure

RegistryId structure

Structure d'encapsulation qui peut contenir le nom et l'Amazon Resource Name (ARN) du registre.

Champs

• RegistryName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du registre. Utilisé uniquement pour la recherche. RegistryArn ou RegistryName doit être fourni.

• RegistryArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  ARN du registre à mettre à jour. RegistryArn ou RegistryName doit être fourni.

RegistryListItem structure

Une structure contenant les détails d'un registre.

Champs

• RegistryName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du registre.

• RegistryArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  L'Amazon Resource Name (ARN) du registre.

• Description – Chaîne de description, d'une longueur maximale de 2 048 octets, correspondant au URI address multi-line string pattern.

  Description du registre.

• Status – Chaîne UTF-8 (valeurs valides : AVAILABLE | DELETING).

  Statut du registre.

• CreatedTime – Chaîne UTF-8.

  Données que le registre a été créé.

• UpdatedTime – Chaîne UTF-8.

  Date à laquelle le registre a été mis à jour.

MetadataInfo structure

Structure contenant des informations de métadonnées pour une version de schéma.

Champs

• MetadataValue – Chaîne UTF-8, d'une longueur comprise entre 1 et 256 octets, correspondant au Custom string pattern #33.

  Valeur correspondant à une clé de métadonnées.

• CreatedTime – Chaîne UTF-8.

  Heure à laquelle l'entrée a été créée.

• OtherMetadataValueList – Un tableau d'objets OtherMetadataValueListItem.

  Autres métadonnées appartenant à la même clé de métadonnées.

OtherMetadataValueListItem structure

Structure contenant d'autres métadonnées pour une version de schéma appartenant à la même clé de métadonnées.

Champs

• MetadataValue – Chaîne UTF-8, d'une longueur comprise entre 1 et 256 octets, correspondant au Custom string pattern #33.

  Valeur correspondante de la clé de métadonnées pour les autres métadonnées appartenant à la même clé de métadonnées.

• CreatedTime – Chaîne UTF-8.

  Heure à laquelle l'entrée a été créée.

SchemaListItem structure

Objet qui contient des détails minimaux pour un schéma.

Champs

• RegistryName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du registre dans lequel se trouve le schéma.

• SchemaName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du schéma.

• SchemaArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  Amazon Resource Name (ARN) du schéma.

• Description – Chaîne de description, d'une longueur maximale de 2 048 octets, correspondant au URI address multi-line string pattern.

  Description du schéma.

• SchemaStatus – Chaîne UTF-8 (valeurs valides : AVAILABLE | PENDING | DELETING).

  Statut du schéma.

• CreatedTime – Chaîne UTF-8.

  Date et heure de création d'un schéma.

• UpdatedTime – Chaîne UTF-8.

  Date et heure de mise à jour d'un schéma.

SchemaVersionListItem structure

Objet contenant les détails d'une version de schéma.

Champs

• SchemaArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  L'Amazon Resource Name (ARN) du filtre.

• SchemaVersionId – Chaîne UTF-8, d'une longueur exacte de 36 octets, correspondant au Custom string pattern #17.

  Identifiant unique de la version du schéma.

• VersionNumber – Nombre (long), compris entre 1 et 100 000.

  Numéro de version du schéma.

• Status – Chaîne UTF-8 (valeurs valides : AVAILABLE | PENDING | FAILURE | DELETING).

  Statut de la version du schéma.

• CreatedTime – Chaîne UTF-8.

  Date et heure de création à laquelle la version de schéma a été créée.

MetadataKeyValuePair structure

Structure contenant une paire de valeurs clé pour les métadonnées.

Champs

• MetadataKey – Chaîne UTF-8, d'une longueur comprise entre 1 et 128 octets, correspondant au Custom string pattern #33.

  Clé de métadonnées.

• MetadataValue – Chaîne UTF-8, d'une longueur comprise entre 1 et 256 octets, correspondant au Custom string pattern #33.

  Valeur correspondant à une clé de métadonnées.

SchemaVersionErrorItem structure

Objet contenant les détails d'erreur d'une opération sur une version de schéma.

Champs

• VersionNumber – Nombre (long), compris entre 1 et 100 000.

  Numéro de version du schéma.

• ErrorDetails – Un objet ErrorDetails.

  Détails de l'erreur pour la version du schéma.

ErrorDetails structure

Objet contenant des détails d'erreur.

Champs

• ErrorCode – Chaîne UTF-8.

  Code d'erreur correspondant à une erreur.

• ErrorMessage – Chaîne UTF-8.

  Message d'erreur pour une erreur.

SchemaVersionNumber structure

Structure contenant les informations de version du schéma.

Champs

• LatestVersion – Booléen.

  Dernière version disponible pour le schéma.

• VersionNumber – Nombre (long), compris entre 1 et 100 000.

  Numéro de version du schéma.

SchemaId structure

ID unique du schéma dans le registre des AWS Glue schémas.

Champs

• SchemaArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  L'Amazon Resource Name (ARN) du filtre. SchemaArn ou SchemaName doit être fourni.

• SchemaName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du schéma. SchemaArn ou SchemaName doit être fourni.

• RegistryName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du registre de schémas contenant le schéma.

Opérations

• CreateRegistry action (Python : create_registry)

• CreateSchema action (Python : créer_schéma)

• GetSchema action (Python : get_schema)

• ListSchemaVersions action (Python : list_schema_versions)

• GetSchemaVersion action (Python : get_schema_version)

• GetSchemaVersionsDiff action (Python : get_schema_versions_diff)

• ListRegistries action (Python : list_registries)

• ListSchemas action (Python : list_schemas)

• RegisterSchemaVersion action (Python : register_schema_version)

• UpdateSchema action (Python : update_schema)

• CheckSchemaVersionValidity action (Python : check_schema_version_validity)

• UpdateRegistry action (Python : update_registry)

• GetSchemaByDefinition action (Python : get_schema_by_definition)

• GetRegistry action (Python : get_registry)

• PutSchemaVersionMetadata action (Python : put_schema_version_metadata)

• QuerySchemaVersionMetadata action (Python : query_schema_version_metadata)

• RemoveSchemaVersionMetadata action (Python : remove_schema_version_metadata)

• DeleteRegistry action (Python : supprimer_registre)

• DeleteSchema action (Python : supprimer_schéma)

• DeleteSchemaVersions action (Python : delete_schema_versions)

CreateRegistry action (Python : create_registry)

Crée un registre qui peut être utilisé pour contenir une collection de schémas.

Demande

• RegistryName – Obligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du registre à créer, d'une longueur maximale de 255, et ne pouvant contenir que des lettres, des chiffres, trait d'union, trait de soulignement, symbole dollar ou dièse. Pas d'espace.

• Description – Chaîne de description, d'une longueur maximale de 2 048 octets, correspondant au URI address multi-line string pattern.

  Description du registre. Si la description n'est pas fournie, aucune valeur par défaut ne sera attribuée.

• Tags – Tableau de mappage de paires clé-valeur, avec 50 paires au maximum.

  Chaque clé est une chaîne UTF-8, d'une longueur comprise entre 1 et 128 octets.

  Chaque valeur est une chaîne UTF-8, d'une longueur maximale de 256 octets.

  AWS balises contenant une paire clé-valeur et pouvant être recherchées par console, ligne de commande ou API.

Réponse

• RegistryArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  Amazon Resource Name (ARN) du registre nouvellement créé.

• RegistryName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du registre.

• Description – Chaîne de description, d'une longueur maximale de 2 048 octets, correspondant au URI address multi-line string pattern.

  Description du registre.

• Tags – Tableau de mappage de paires clé-valeur, avec 50 paires au maximum.

  Chaque clé est une chaîne UTF-8, d'une longueur comprise entre 1 et 128 octets.

  Chaque valeur est une chaîne UTF-8, d'une longueur maximale de 256 octets.

  Balises pour le registre.

Erreurs

• InvalidInputException

• AccessDeniedException

• AlreadyExistsException

• ResourceNumberLimitExceededException

• ConcurrentModificationException

• InternalServiceException

CreateSchema action (Python : créer_schéma)

Crée un jeu de schémas et enregistre la définition de schéma. Renvoie une erreur si le jeu de schémas existe déjà sans pour autant enregistrer la version.

Lorsque le jeu de schémas est créé, un point de contrôle de version est défini sur la première version. Le mode de compatibilité « DISABLED » empêche toute version de schéma supplémentaire d'être ajoutée après la première version de schéma. Pour tous les autres modes de compatibilité, la validation des paramètres de compatibilité ne sera appliquée qu'à partir de la deuxième version lorsque l'API RegisterSchemaVersion est utilisée.

Lorsque cette API est appelée sans RegistryId, cela créera une entrée pour un « registre par défaut » dans les tables de base de données du registre, si elle n'est pas déjà présente.

Demande

• RegistryId – Un objet RegistryId.

  Il s'agit d'une forme d'encapsulation qui contient les champs d'identité du registre. S'il n'est pas fourni, le registre par défaut sera utilisé. Le format ARN pour celui-ci sera : arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id.

• SchemaName – Obligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du schéma à créer d'une longueur maximale de 255. Il ne peut contenir que des lettres, chiffres, tirets, traits de soulignement, signes dollar ou signes de hachage. Pas d'espace.

• DataFormat – Obligatoire : Chaîne UTF-8 (valeurs valides : AVRO | JSON | PROTOBUF).

  Format de données de la définition de schéma. À l'heure actuelle, AVRO, JSON et PROTOBUF sont pris en charge.

• Compatibility – Chaîne UTF-8 (valeurs valides : NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL).

  Mode de compatibilité du schéma. Les valeurs possibles sont :

  • NONE (AUCUN) : aucun mode de compatibilité ne s'applique. Vous pouvez utiliser ce choix dans les scénarios de développement ou si vous ne connaissez pas le mode de compatibilité que vous souhaitez appliquer aux schémas. Toute nouvelle version ajoutée sera acceptée sans faire l'objet d'un contrôle de compatibilité.

  • DISABLED (DÉSACTIVÉ) : ce choix de compatibilité empêche la gestion des versions pour un schéma particulier. Vous pouvez utiliser ce choix pour empêcher la gestion des versions futures d'un schéma.

  • BACKWARD (DESCENDANT) : ce choix de compatibilité est recommandé, car il permet aux récepteurs de données de lire à la fois la version actuelle et une version antérieure du schéma. Cela signifie, par exemple, qu'une nouvelle version de schéma ne peut pas supprimer des champs de données ou modifier le type de ces champs, de sorte qu'ils ne peuvent pas être lus par les lecteurs utilisant la version précédente.

  • BACKWARD_ALL (DESCENDANT_TOUT) : ce choix de compatibilité permet aux récepteurs de données de lire à la fois la version actuelle et toutes les versions antérieures du schéma. Vous pouvez utiliser ce choix lorsque vous devez supprimer des champs ou ajouter des champs facultatifs, et vérifier la compatibilité avec toutes les versions de schéma précédentes.

  • ASCENDANT : ce choix de compatibilité permet aux récepteurs de données de lire à la fois la version actuelle et la version suivante du schéma, mais pas nécessairement les versions ultérieures. Vous pouvez utiliser ce choix lorsque vous devez ajouter des champs ou supprimer des champs facultatifs, mais uniquement vérifier la compatibilité avec la dernière version du schéma.

  • ASCENDANT_TOUT : ce choix de compatibilité permet aux récepteurs de données de lire les données écrites par les producteurs de tout nouveau schéma enregistré. Vous pouvez utiliser ce choix lorsque vous devez ajouter des champs ou supprimer des champs facultatifs, et vérifier la compatibilité avec toutes les versions de schéma précédentes.

  • COMPLET : ce choix de compatibilité permet aux récepteurs de données de lire les données écrites par les producteurs à l'aide de la version précédente ou suivante du schéma, mais pas nécessairement des versions antérieures ou ultérieures. Vous pouvez utiliser ce choix lorsque vous devez ajouter ou supprimer des champs facultatifs, mais uniquement vérifier la compatibilité par rapport à la dernière version du schéma.

  • COMPLET_TOUT : ce choix de compatibilité permet aux récepteurs de données de lire les données écrites par les producteurs utilisant toutes les versions de schéma précédentes. Vous pouvez utiliser ce choix lorsque vous devez ajouter ou supprimer des champs facultatifs et vérifier la compatibilité avec toutes les versions de schéma précédentes.

• Description – Chaîne de description, d'une longueur maximale de 2 048 octets, correspondant au URI address multi-line string pattern.

  Description facultative du schéma. Si la description n'est pas fournie, aucune valeur par défaut ne sera attribuée automatiquement.

• Tags – Tableau de mappage de paires clé-valeur, avec 50 paires au maximum.

  Chaque clé est une chaîne UTF-8, d'une longueur comprise entre 1 et 128 octets.

  Chaque valeur est une chaîne UTF-8, d'une longueur maximale de 256 octets.

  AWS balises contenant une paire clé-valeur et pouvant être recherchées par console, ligne de commande ou API. Si spécifié, suit le AWS tags-on-create modèle.

• SchemaDefinition – Chaîne UTF-8, d'une longueur comprise entre 1 et 170 000 octets, correspondant au Custom string pattern #32.

  Définition de schéma à l'aide du paramètre DataFormat pour SchemaName.

Réponse

• RegistryName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du registre.

• RegistryArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  L'Amazon Resource Name (ARN) du registre.

• SchemaName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du schéma.

• SchemaArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  L'Amazon Resource Name (ARN) du filtre.

• Description – Chaîne de description, d'une longueur maximale de 2 048 octets, correspondant au URI address multi-line string pattern.

  Description du schéma si spécifié lors de sa création.

• DataFormat – Chaîne UTF-8 (valeurs valides : AVRO | JSON | PROTOBUF).

  Format de données de la définition de schéma. À l'heure actuelle, AVRO, JSON et PROTOBUF sont pris en charge.

• Compatibility – Chaîne UTF-8 (valeurs valides : NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL).

  Mode de compatibilité du schéma.

• SchemaCheckpoint – Nombre (long), compris entre 1 et 100 000.

  Numéro de version du point de contrôle (la dernière fois que le mode de compatibilité a été modifié).

• LatestSchemaVersion – Nombre (long), compris entre 1 et 100 000.

  Version la plus récente du schéma associé à la définition de schéma renvoyée.

• NextSchemaVersion – Nombre (long), compris entre 1 et 100 000.

  Version suivante du schéma associé à la définition de schéma renvoyée.

• SchemaStatus – Chaîne UTF-8 (valeurs valides : AVAILABLE | PENDING | DELETING).

  Statut du schéma.

• Tags – Tableau de mappage de paires clé-valeur, avec 50 paires au maximum.

  Chaque clé est une chaîne UTF-8, d'une longueur comprise entre 1 et 128 octets.

  Chaque valeur est une chaîne UTF-8, d'une longueur maximale de 256 octets.

  Balises pour le schéma.

• SchemaVersionId – Chaîne UTF-8, d'une longueur exacte de 36 octets, correspondant au Custom string pattern #17.

  Identifiant unique de la première version du schéma.

• SchemaVersionStatus – Chaîne UTF-8 (valeurs valides : AVAILABLE | PENDING | FAILURE | DELETING).

  Statut de la première version du schéma créée.

Erreurs

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• AlreadyExistsException

• ResourceNumberLimitExceededException

• ConcurrentModificationException

• InternalServiceException

GetSchema action (Python : get_schema)

Décrit en détail le schéma spécifié.

Demande

• SchemaId – Obligatoire : un objet SchemaId.

  Structure d'encapsulation contenant les champs d'identité de schéma. La structure contient :

  • SchemaId$ SchemaArn : Le nom de ressource Amazon (ARN) du schéma. Il faut fournir soit SchemaArn, soit SchemaName et RegistryName.

  • SchemaId$ SchemaName : nom du schéma. Il faut fournir soit SchemaArn, soit SchemaName et RegistryName.

Réponse

• RegistryName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du registre.

• RegistryArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  L'Amazon Resource Name (ARN) du registre.

• SchemaName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du schéma.

• SchemaArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  L'Amazon Resource Name (ARN) du filtre.

• Description – Chaîne de description, d'une longueur maximale de 2 048 octets, correspondant au URI address multi-line string pattern.

  Description du schéma si spécifié lors de sa création

• DataFormat – Chaîne UTF-8 (valeurs valides : AVRO | JSON | PROTOBUF).

  Format de données de la définition de schéma. À l'heure actuelle, AVRO, JSON et PROTOBUF sont pris en charge.

• Compatibility – Chaîne UTF-8 (valeurs valides : NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL).

  Mode de compatibilité du schéma.

• SchemaCheckpoint – Nombre (long), compris entre 1 et 100 000.

  Numéro de version du point de contrôle (la dernière fois que le mode de compatibilité a été modifié).

• LatestSchemaVersion – Nombre (long), compris entre 1 et 100 000.

  Version la plus récente du schéma associé à la définition de schéma renvoyée.

• NextSchemaVersion – Nombre (long), compris entre 1 et 100 000.

  Version suivante du schéma associé à la définition de schéma renvoyée.

• SchemaStatus – Chaîne UTF-8 (valeurs valides : AVAILABLE | PENDING | DELETING).

  Statut du schéma.

• CreatedTime – Chaîne UTF-8.

  Date et heure de création du schéma.

• UpdatedTime – Chaîne UTF-8.

  Date et heure de mise à jour du schéma.

Erreurs

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• InternalServiceException

ListSchemaVersions action (Python : list_schema_versions)

Renvoie une liste des versions de schéma que vous avez créées, avec un minimum d'informations. Les versions de schémas dont le statut est Deleted ne seront pas incluses dans les résultats. Des résultats vides seront retournés s'il n'y a pas de version de schéma disponible.

Demande

• SchemaId – Obligatoire : un objet SchemaId.

  Structure d'encapsulation contenant les champs d'identité de schéma. La structure contient :

  • SchemaId$ SchemaArn : Le nom de ressource Amazon (ARN) du schéma. Il faut fournir soit SchemaArn, soit SchemaName et RegistryName.

  • SchemaId$ SchemaName : nom du schéma. Il faut fournir soit SchemaArn, soit SchemaName et RegistryName.

• MaxResults – Nombre (entier), compris entre 1 et 100.

  Nombre maximum de résultats requis par page. Si la valeur n'est pas fournie, elle par défaut sera de 25 par page.

• NextToken – Chaîne UTF-8.

  Jeton de continuation, s'il s'agit d'un appel de continuation.

Réponse

• Schemas – Un tableau d'objets SchemaVersionListItem.

  Tableau d'objets SchemaVersionList contenant les détails de chaque version de schéma.

• NextToken – Chaîne UTF-8.

  Jeton de continuation pour la pagination de la liste des jetons renvoyés, renvoyé si le segment actuel de la liste n'est pas le dernier.

Erreurs

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• InternalServiceException

GetSchemaVersion action (Python : get_schema_version)

Récupère le schéma spécifié par son ID unique attribué lors de la création ou de l'enregistrement d'une version du schéma. Les versions de schémas dont le statut est Deleted ne seront pas incluses dans les résultats.

Demande

• SchemaId – Un objet SchemaId.

  Structure d'encapsulation contenant les champs d'identité de schéma. La structure contient :

  • SchemaId$ SchemaArn : Le nom de ressource Amazon (ARN) du schéma. Il faut fournir soit SchemaArn, soit SchemaName et RegistryName.

  • SchemaId$ SchemaName : nom du schéma. Il faut fournir soit SchemaArn, soit SchemaName et RegistryName.

• SchemaVersionId – Chaîne UTF-8, d'une longueur exacte de 36 octets, correspondant au Custom string pattern #17.

  Le SchemaVersionId de la version du schéma. Ce champ est requis pour l'extraction par ID de schéma. Il faut fournir soit cet élément, soit l'encapsulateur SchemaId.

• SchemaVersionNumber – Un objet SchemaVersionNumber.

  Numéro de version du schéma.

Réponse

• SchemaVersionId – Chaîne UTF-8, d'une longueur exacte de 36 octets, correspondant au Custom string pattern #17.

  Le SchemaVersionId de la version du schéma.

• SchemaDefinition – Chaîne UTF-8, d'une longueur comprise entre 1 et 170 000 octets, correspondant au Custom string pattern #32.

  La définition du schéma pour l'ID du schéma.

• DataFormat – Chaîne UTF-8 (valeurs valides : AVRO | JSON | PROTOBUF).

  Format de données de la définition de schéma. À l'heure actuelle, AVRO, JSON et PROTOBUF sont pris en charge.

• SchemaArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  L'Amazon Resource Name (ARN) du filtre.

• VersionNumber – Nombre (long), compris entre 1 et 100 000.

  Numéro de version du schéma.

• Status – Chaîne UTF-8 (valeurs valides : AVAILABLE | PENDING | FAILURE | DELETING).

  Statut de la version du schéma.

• CreatedTime – Chaîne UTF-8.

  Date et heure de création à laquelle la version de schéma a été créée.

Erreurs

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• InternalServiceException

GetSchemaVersionsDiff action (Python : get_schema_versions_diff)

Récupère la différence de version de schéma dans le type de différence spécifié entre deux versions de schéma stockées dans le registre des schémas.

Cette API vous permet de comparer deux versions de schéma entre deux définitions de schéma sous le même schéma.

Demande

• SchemaId – Obligatoire : un objet SchemaId.

  Structure d'encapsulation contenant les champs d'identité de schéma. La structure contient :

  • SchemaId$ SchemaArn : Le nom de ressource Amazon (ARN) du schéma. SchemaArn ou SchemaName doit être fourni.

  • SchemaId$ SchemaName : nom du schéma. SchemaArn ou SchemaName doit être fourni.

• FirstSchemaVersionNumber – Obligatoire : un objet SchemaVersionNumber.

  La première des deux versions de schéma à comparer.

• SecondSchemaVersionNumber – Obligatoire : un objet SchemaVersionNumber.

  La seconde des deux versions de schéma à comparer.

• SchemaDiffType – Obligatoire : Chaîne UTF-8 (valeurs valides : SYNTAX_DIFF).

  Fait référence à SYNTAX_DIFF, qui est le type diff actuellement pris en charge.

Réponse

• Diff – Chaîne UTF-8, d'une longueur comprise entre 1 et 340 000 octets, correspondant au Custom string pattern #32.

  La différence entre les schémas sous forme de chaîne de JsonPatch caractères.

Erreurs

• InvalidInputException

• EntityNotFoundException

• AccessDeniedException

• InternalServiceException

ListRegistries action (Python : list_registries)

Renvoie une liste des registres que vous avez créés, avec des informations de registre minimales. Les registres dont le statut est Deleting ne seront pas inclus dans les résultats. Des résultats vides seront retournés s'il n'y a pas de registres disponibles.

Demande

• MaxResults – Nombre (entier), compris entre 1 et 100.

  Nombre maximum de résultats requis par page. Si la valeur n'est pas fournie, elle par défaut sera de 25 par page.

• NextToken – Chaîne UTF-8.

  Jeton de continuation, s'il s'agit d'un appel de continuation.

Réponse

• Registries – Un tableau d'objets RegistryListItem.

  Tableau d'objets RegistryDetailedListItem contenant des détails minimaux de chaque registre.

• NextToken – Chaîne UTF-8.

  Jeton de continuation pour la pagination de la liste des jetons renvoyés, renvoyé si le segment actuel de la liste n'est pas le dernier.

Erreurs

• InvalidInputException

• AccessDeniedException

• InternalServiceException

ListSchemas action (Python : list_schemas)

Renvoie une liste de schémas avec des détails minimaux. Les schémas dont le statut est Deleted ne seront pas inclus dans les résultats. Des résultats vides seront retournés s'il n'y a pas de schéma disponible.

Lorsque RegistryId n'est pas fourni, tous les schémas entre les registres feront partie de la réponse de l'API.

Demande

• RegistryId – Un objet RegistryId.

  Structure d'encapsulation qui peut contenir le nom et l'Amazon Resource Name (ARN) du registre.

• MaxResults – Nombre (entier), compris entre 1 et 100.

  Nombre maximum de résultats requis par page. Si la valeur n'est pas fournie, elle par défaut sera de 25 par page.

• NextToken – Chaîne UTF-8.

  Jeton de continuation, s'il s'agit d'un appel de continuation.

Réponse

• Schemas – Un tableau d'objets SchemaListItem.

  Tableau d'objets SchemaListItem contenant les détails de chaque schéma.

• NextToken – Chaîne UTF-8.

  Jeton de continuation pour la pagination de la liste des jetons renvoyés, renvoyé si le segment actuel de la liste n'est pas le dernier.

Erreurs

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• InternalServiceException

RegisterSchemaVersion action (Python : register_schema_version)

Ajoute une nouvelle version au schéma existant. Renvoie une erreur si la nouvelle version du schéma ne répond pas aux exigences de compatibilité du jeu de schémas. Cette API ne crée pas de nouveau jeu de schémas et renvoie une erreur 404 si le jeu de schémas n'est pas déjà présent dans le registre de schémas.

S'il s'agit de la première définition de schéma enregistrée dans le registre de schéma, cette API stockera la version du schéma et retournera immédiatement à l'appelant. Sinon, cet appel peut s'exécuter plus longtemps que d'autres opérations en raison des modes de compatibilité. Vous pouvez appeler l'API GetSchemaVersion avec le SchemaVersionId pour vérifier les modes de compatibilité.

Si la même définition de schéma est déjà stockée dans le registre de schéma en tant que version, l'ID de schéma du schéma existant est renvoyé à l'appelant.

Demande

• SchemaId – Obligatoire : un objet SchemaId.

  Structure d'encapsulation contenant les champs d'identité de schéma. La structure contient :

  • SchemaId$ SchemaArn : Le nom de ressource Amazon (ARN) du schéma. Il faut fournir soit SchemaArn, soit SchemaName et RegistryName.

  • SchemaId$ SchemaName : nom du schéma. Il faut fournir soit SchemaArn, soit SchemaName et RegistryName.

• SchemaDefinition – Obligatoire : chaîne UTF-8, d'une longueur comprise entre 1 et 170 000 octets, correspondant au Custom string pattern #32.

  Définition de schéma à l'aide du paramètre DataFormat pour SchemaName.

Réponse

• SchemaVersionId – Chaîne UTF-8, d'une longueur exacte de 36 octets, correspondant au Custom string pattern #17.

  ID unique qui représente la version de ce schéma.

• VersionNumber – Nombre (long), compris entre 1 et 100 000.

  Version de ce schéma (pour le flux de synchronisation uniquement, dans le cas où il s'agit de la première version).

• Status – Chaîne UTF-8 (valeurs valides : AVAILABLE | PENDING | FAILURE | DELETING).

  Statut de la version du schéma.

Erreurs

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• ResourceNumberLimitExceededException

• ConcurrentModificationException

• InternalServiceException

UpdateSchema action (Python : update_schema)

Met à jour la description, le paramètre de compatibilité ou le point de contrôle de version d'un jeu de schéma.

Pour mettre à jour le paramètre de compatibilité, l'appel ne valide pas la compatibilité pour l'ensemble des versions de schéma avec le nouveau paramètre de compatibilité. Si la valeur pour Compatibility est fournie, le VersionNumber (un point de contrôle) est également requis. L'API valide le numéro de version du point de contrôle à des fins de cohérence.

Si la valeur pour VersionNumber (point de contrôle) est fournie, Compatibility est facultatif et cela peut être utilisé pour définir/réinitialiser un point de contrôle pour le schéma.

Cette mise à jour se produira uniquement si le schéma est dans l'état AVAILABLE (DISPONIBLE).

Demande

• SchemaId – Obligatoire : un objet SchemaId.

  Structure d'encapsulation contenant les champs d'identité de schéma. La structure contient :

  • SchemaId$ SchemaArn : Le nom de ressource Amazon (ARN) du schéma. SchemaArn ou SchemaName doit être fourni.

  • SchemaId$ SchemaName : nom du schéma. SchemaArn ou SchemaName doit être fourni.

• SchemaVersionNumber – Un objet SchemaVersionNumber.

  Numéro de version requis pour le pointage de contrôle. VersionNumber ou Compatibility doit être fourni.

• Compatibility – Chaîne UTF-8 (valeurs valides : NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL).

  Nouveau paramètre de compatibilité pour le schéma.

• Description – Chaîne de description, d'une longueur maximale de 2 048 octets, correspondant au URI address multi-line string pattern.

  Nouvelle description du schéma.

Réponse

• SchemaArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  L'Amazon Resource Name (ARN) du filtre.

• SchemaName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du schéma.

• RegistryName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du registre contenant le schéma.

Erreurs

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• ConcurrentModificationException

• InternalServiceException

CheckSchemaVersionValidity action (Python : check_schema_version_validity)

Valide le schéma fourni. Cet appel n'a pas d'effets secondaires, il effectue simplement une validation en utilisant le schéma fourni à l'aide de DataFormat. Comme il ne prend pas de nom de jeu de schéma, aucune vérification de compatibilité n'est effectuée.

Demande

• DataFormat – Obligatoire : Chaîne UTF-8 (valeurs valides : AVRO | JSON | PROTOBUF).

  Format de données de la définition de schéma. À l'heure actuelle, AVRO, JSON et PROTOBUF sont pris en charge.

• SchemaDefinition – Obligatoire : chaîne UTF-8, d'une longueur comprise entre 1 et 170 000 octets, correspondant au Custom string pattern #32.

  Définition du schéma qui doit être validé.

Réponse

• Valid – Booléen.

  Renvoie true, si le schéma est valide et false sinon.

• Error – Chaîne UTF-8, d'une longueur comprise entre 1 et 5 000 octets.

  Message d'erreur d'échec de validation.

Erreurs

• InvalidInputException

• AccessDeniedException

• InternalServiceException

UpdateRegistry action (Python : update_registry)

Met à jour un registre existant qui est utilisé pour contenir une collection de schémas. Les propriétés mises à jour se rapportent au registre et ne modifient aucun des schémas de celui-ci.

Demande

• RegistryId – Obligatoire : un objet RegistryId.

  Structure d'encapsulation qui peut contenir le nom et l'Amazon Resource Name (ARN) du registre.

• Description – Obligatoire : Chaîne de description, d'une longueur maximale de 2 048 octets, correspondant au URI address multi-line string pattern.

  Description du registre. Si la description n'est pas fournie, ce champ ne sera pas mis à jour.

Réponse

• RegistryName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du registre mis à jour.

• RegistryArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  Amazon Resource Name (ARN) du registre mis à jour.

Erreurs

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• ConcurrentModificationException

• InternalServiceException

GetSchemaByDefinition action (Python : get_schema_by_definition)

Récupère un schéma à l'aide de sa SchemaDefinition. La définition du schéma est envoyée au registre de schéma, rendue canonique et hachée. Si le hachage correspond à la portée du SchemaName ou de l'ARN (ou du registre par défaut, si aucun n'est fourni), les métadonnées de ce schéma sont retournées. Dans le cas contraire, un 404 ou une NotFound erreur est renvoyée. Les versions de schémas dont le statut est Deleted ne seront pas incluses dans les résultats.

Demande

• SchemaId – Obligatoire : un objet SchemaId.

  Structure d'encapsulation contenant les champs d'identité de schéma. La structure contient :

  • SchemaId$ SchemaArn : Le nom de ressource Amazon (ARN) du schéma. SchemaArn ou SchemaName doit être fourni.

  • SchemaId$ SchemaName : nom du schéma. SchemaArn ou SchemaName doit être fourni.

• SchemaDefinition – Obligatoire : chaîne UTF-8, d'une longueur comprise entre 1 et 170 000 octets, correspondant au Custom string pattern #32.

  Définition du schéma pour lequel les détails du schéma sont requis.

Réponse

• SchemaVersionId – Chaîne UTF-8, d'une longueur exacte de 36 octets, correspondant au Custom string pattern #17.

  ID de schéma de la version du schéma.

• SchemaArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  L'Amazon Resource Name (ARN) du filtre.

• DataFormat – Chaîne UTF-8 (valeurs valides : AVRO | JSON | PROTOBUF).

  Format de données de la définition de schéma. À l'heure actuelle, AVRO, JSON et PROTOBUF sont pris en charge.

• Status – Chaîne UTF-8 (valeurs valides : AVAILABLE | PENDING | FAILURE | DELETING).

  Statut de la version du schéma.

• CreatedTime – Chaîne UTF-8.

  Date et heure de création du schéma.

Erreurs

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• InternalServiceException

GetRegistry action (Python : get_registry)

Décrit en détail le registre spécifié.

Demande

• RegistryId – Obligatoire : un objet RegistryId.

  Structure d'encapsulation qui peut contenir le nom et l'Amazon Resource Name (ARN) du registre.

Réponse

• RegistryName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du registre.

• RegistryArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  L'Amazon Resource Name (ARN) du registre.

• Description – Chaîne de description, d'une longueur maximale de 2 048 octets, correspondant au URI address multi-line string pattern.

  Description du registre.

• Status – Chaîne UTF-8 (valeurs valides : AVAILABLE | DELETING).

  Statut du registre.

• CreatedTime – Chaîne UTF-8.

  Date et heure de création du registre.

• UpdatedTime – Chaîne UTF-8.

  Date et heure de mise à jour du registre.

Erreurs

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

• InternalServiceException

PutSchemaVersionMetadata action (Python : put_schema_version_metadata)

Place la paire de valeurs clé de métadonnées pour un ID de version de schéma spécifié. Un maximum de 10 paires de valeurs clé sera autorisé par version de schéma. Ils peuvent être ajoutés au moyen d'un ou de plusieurs appels.

Demande

• SchemaId – Un objet SchemaId.

  ID unique du schéma.

• SchemaVersionNumber – Un objet SchemaVersionNumber.

  Numéro de version du schéma.

• SchemaVersionId – Chaîne UTF-8, d'une longueur exacte de 36 octets, correspondant au Custom string pattern #17.

  ID de version unique de la version du schéma.

• MetadataKeyValue – Obligatoire : un objet MetadataKeyValuePair.

  Valeur correspondant à une clé de métadonnées.

Réponse

• SchemaArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  Amazon Resource Name (ARN) du schéma.

• SchemaName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du schéma.

• RegistryName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du registre.

• LatestVersion – Booléen.

  Dernière version du schéma.

• VersionNumber – Nombre (long), compris entre 1 et 100 000.

  Numéro de version du schéma.

• SchemaVersionId – Chaîne UTF-8, d'une longueur exacte de 36 octets, correspondant au Custom string pattern #17.

  ID de version unique de la version du schéma.

• MetadataKey – Chaîne UTF-8, d'une longueur comprise entre 1 et 128 octets, correspondant au Custom string pattern #33.

  Clé de métadonnées.

• MetadataValue – Chaîne UTF-8, d'une longueur comprise entre 1 et 256 octets, correspondant au Custom string pattern #33.

  Valeur de la clé de métadonnées.

Erreurs

• InvalidInputException

• AccessDeniedException

• AlreadyExistsException

• EntityNotFoundException

• ResourceNumberLimitExceededException

QuerySchemaVersionMetadata action (Python : query_schema_version_metadata)

Requêtes pour les informations de métadonnées de version du schéma.

Demande

• SchemaId – Un objet SchemaId.

  Structure d'encapsulation qui peut contenir le nom et l'Amazon Resource Name (ARN) du schéma.

• SchemaVersionNumber – Un objet SchemaVersionNumber.

  Numéro de version du schéma.

• SchemaVersionId – Chaîne UTF-8, d'une longueur exacte de 36 octets, correspondant au Custom string pattern #17.

  ID de version unique de la version du schéma.

• MetadataList – Un tableau d'objets MetadataKeyValuePair.

  Rechercher des paires clé-valeur pour les métadonnées, si elles ne sont pas fournies, toutes les informations de métadonnées seront récupérées.

• MaxResults – Nombre (entier), compris entre 1 et 50.

  Nombre maximum de résultats requis par page. Si la valeur n'est pas fournie, elle par défaut sera de 25 par page.

• NextToken – Chaîne UTF-8.

  Jeton de continuation, s'il s'agit d'un appel de continuation.

Réponse

• MetadataInfoMap – Tableau de mappage de paires valeur-clé.

  Chaque clé est une chaîne UTF-8, d'une longueur comprise entre 1 et 128 octets, correspondant au Custom string pattern #33.

  Chaque valeur est un objet MetadataInfo.

  Carte d'une clé de métadonnées et des valeurs associées.

• SchemaVersionId – Chaîne UTF-8, d'une longueur exacte de 36 octets, correspondant au Custom string pattern #17.

  ID de version unique de la version du schéma.

• NextToken – Chaîne UTF-8.

  Jeton de continuation pour la pagination de la liste des jetons renvoyés, renvoyé si le segment actuel de la liste n'est pas le dernier.

Erreurs

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

RemoveSchemaVersionMetadata action (Python : remove_schema_version_metadata)

Supprime une paire de valeurs clé des métadonnées de version de schéma pour l'ID de version de schéma spécifié.

Demande

• SchemaId – Un objet SchemaId.

  Structure d'encapsulation qui peut contenir le nom et l'Amazon Resource Name (ARN) du schéma.

• SchemaVersionNumber – Un objet SchemaVersionNumber.

  Numéro de version du schéma.

• SchemaVersionId – Chaîne UTF-8, d'une longueur exacte de 36 octets, correspondant au Custom string pattern #17.

  ID de version unique de la version du schéma.

• MetadataKeyValue – Obligatoire : un objet MetadataKeyValuePair.

  Valeur de la clé de métadonnées.

Réponse

• SchemaArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  L'Amazon Resource Name (ARN) du filtre.

• SchemaName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du schéma.

• RegistryName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du registre.

• LatestVersion – Booléen.

  Dernière version du schéma.

• VersionNumber – Nombre (long), compris entre 1 et 100 000.

  Numéro de version du schéma.

• SchemaVersionId – Chaîne UTF-8, d'une longueur exacte de 36 octets, correspondant au Custom string pattern #17.

  ID de version pour la version du schéma.

• MetadataKey – Chaîne UTF-8, d'une longueur comprise entre 1 et 128 octets, correspondant au Custom string pattern #33.

  Clé de métadonnées.

• MetadataValue – Chaîne UTF-8, d'une longueur comprise entre 1 et 256 octets, correspondant au Custom string pattern #33.

  Valeur de la clé de métadonnées.

Erreurs

• InvalidInputException

• AccessDeniedException

• EntityNotFoundException

DeleteRegistry action (Python : supprimer_registre)

Supprimer l'intégralité du registre, y compris le schéma et toutes ses versions. Pour obtenir le statut de l'opération de suppression, vous pouvez appeler l'API GetRegistry après l'appel asynchrone. La suppression d'un registre désactivera toutes les opérations en ligne pour le registre, telles que les API UpdateRegistry, CreateSchema, UpdateSchema et RegisterSchemaVersion.

Demande

• RegistryId – Obligatoire : un objet RegistryId.

  Structure d'encapsulation qui peut contenir le nom et l'Amazon Resource Name (ARN) du registre.

Réponse

• RegistryName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du registre en cours de suppression.

• RegistryArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  Amazon Resource Name (ARN) du registre en cours de suppression.

• Status – Chaîne UTF-8 (valeurs valides : AVAILABLE | DELETING).

  Statut du registre. La réussite de l'opération retournera le statut Deleting.

Erreurs

• InvalidInputException

• EntityNotFoundException

• AccessDeniedException

• ConcurrentModificationException

DeleteSchema action (Python : supprimer_schéma)

Supprime l'ensemble de schémas, y compris le jeu de schémas et toutes ses versions. Pour obtenir le statut de l'opération de suppression, vous pouvez appeler l'API GetSchema après l'appel asynchrone. La suppression d'un registre désactivera toutes les opérations en ligne pour le registre, telles que les API GetSchemaByDefinition et RegisterSchemaVersion.

Demande

• SchemaId – Obligatoire : un objet SchemaId.

  Structure d'encapsulation qui peut contenir le nom et l'Amazon Resource Name (ARN) du schéma.

Réponse

• SchemaArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant au Custom string pattern #22.

  Amazon Resource Name (ARN) du schéma en cours de suppression.

• SchemaName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Custom string pattern #18.

  Nom du schéma en cours de suppression.

• Status – Chaîne UTF-8 (valeurs valides : AVAILABLE | PENDING | DELETING).

  Statut du schéma.

Erreurs

• InvalidInputException

• EntityNotFoundException

• AccessDeniedException

• ConcurrentModificationException

DeleteSchemaVersions action (Python : delete_schema_versions)

Supprimez des versions du schéma spécifié. Un numéro ou une plage de versions peut être fourni. Si le mode de compatibilité interdit la suppression d'une version nécessaire, telle que BACKWARDS_FULL (DESCENDANT_TOUT), une erreur est renvoyée. En appelant l'API GetSchemaVersions après cet appel, vous obtiendrez la liste de l'état des versions supprimées.

Lorsque la plage de numéros de version contient une version comportant un point de contrôle, l'API renvoie un conflit 409 et ne procède pas à la suppression. Vous devez d'abord supprimer le point de contrôle à l'aide de l'API DeleteSchemaCheckpoint avant d'utiliser cette API.

Vous ne pouvez pas utiliser l'API DeleteSchemaVersions pour supprimer la première version de schéma dans le jeu de schémas. La première version de schéma ne peut être supprimée que par l'appel à l'API DeleteSchema. Cette opération supprimera également les SchemaVersionMetadata attachées aux versions du schéma. Les suppressions définitives seront appliquées sur la base de données.

Si le mode de compatibilité interdit la suppression d'une version nécessaire, telle que BACKWARDS_FULL (DESCENDANT_TOUT), une erreur est renvoyée.

Demande

• SchemaId – Obligatoire : un objet SchemaId.

  Structure d'encapsulation qui peut contenir le nom et l'Amazon Resource Name (ARN) du schéma.

• Versions – Obligatoire : chaîne UTF-8, d'une longueur comprise entre 1 et 100 000 octets, correspondant au Custom string pattern #34.

  Une plage de versions peut être fournie au format suivant :

  • un numéro de version unique, 5

  • une plage, 5-8 : supprime les versions 5, 6, 7, 8

Réponse

• SchemaVersionErrors – Un tableau d'objets SchemaVersionErrorItem.

  Une liste d'objets SchemaVersionErrorItem, chacun contenant une version d'erreur et de schéma.

Erreurs

• InvalidInputException

• EntityNotFoundException

• AccessDeniedException

• ConcurrentModificationException