Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
Registro degli schemi
L'API del registro Schema descrive i tipi di dati e le API relativi all'utilizzo degli schemi in AWS Glue.
Tipi di dati
RegistryId struttura
Una struttura wrapper che può contenere il nome del registro e l'Amazon Resource Name (ARN).
Campi
-
RegistryName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Nome del registro. Utilizzato solo per la ricerca. Deve essere fornito
RegistryArnoRegistryName. -
RegistryArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.Arn del registro da aggiornare. Deve essere fornito
RegistryArnoRegistryName.
RegistryListItem struttura
Una struttura contenente i dettagli di un registro.
Campi
-
RegistryName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome del registro.
-
RegistryArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.L'ARN (Amazon Resource Name) del registro.
-
Description: stringa di descrizione, non superiore a 2048 byte di lunghezza, corrispondente a URI address multi-line string pattern.Una descrizione del registro.
-
Status: stringa UTF-8 (valori validi:AVAILABLE|DELETING).Lo stato del registro.
-
CreatedTime: stringa UTF-8.La data in cui è stato creato il registro.
-
UpdatedTime: stringa UTF-8.La data in cui è stato aggiornato il registro.
MetadataInfo struttura
Una struttura contenente informazioni sui metadati per una versione dello schema.
Campi
-
MetadataValue: stringa UTF-8, non inferiore a 1 o superiore a 256 byte di lunghezza, corrispondente a Custom string pattern #14.Il valore corrispondente alla chiave di metadati.
-
CreatedTime: stringa UTF-8.L'ora in cui è stata creata la voce.
-
OtherMetadataValueList: una matrice di oggetti OtherMetadataValueListItem.Altri metadati appartenenti alla stessa chiave di metadati.
OtherMetadataValueListItem struttura
Struttura contenente altri metadati per una versione dello schema appartenente alla stessa chiave di metadati.
Campi
-
MetadataValue– stringa UTF-8, non inferiore a 1 o superiore a 256 byte di lunghezza, corrispondente a Custom string pattern #14.Il valore corrispondente della chiave di metadati per gli altri metadati appartenenti alla stessa chiave dei metadati.
-
CreatedTime: stringa UTF-8.L'ora in cui è stata creata la voce.
SchemaListItem struttura
Un oggetto che contiene dettagli minimi per uno schema.
Campi
-
RegistryName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome del registro in cui si trova lo schema.
-
SchemaName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome dello schema.
-
SchemaArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.L'ARN (Amazon Resource Name) per lo schema.
-
Description: stringa di descrizione, non superiore a 2048 byte di lunghezza, corrispondente a URI address multi-line string pattern.Una descrizione per lo schema.
-
SchemaStatus: stringa UTF-8 (valori validi:AVAILABLE|PENDING|DELETING).Lo stato dello schema.
-
CreatedTime: stringa UTF-8.La data e l'ora di creazione dello schema.
-
UpdatedTime: stringa UTF-8.La data e l'ora di aggiornamento dello schema.
SchemaVersionListItem struttura
Oggetto contenente i dettagli relativi a una versione dello schema.
Campi
-
SchemaArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.L'ARN (Amazon Resource Name) dello schema.
-
SchemaVersionId– stringa UTF-8, non inferiore a 36 o superiore a 36 byte di lunghezza, corrispondente a Custom string pattern #44.L'identificatore univoco della versione dello schema.
-
VersionNumber– Numero (intero), non inferiore a 1 o superiore a 100000.Il numero di versione dello schema.
-
Status: stringa UTF-8 (valori validi:AVAILABLE|PENDING|FAILURE|DELETING).Lo stato della versione dello schema.
-
CreatedTime: stringa UTF-8.La data e l'ora in cui è stata creata la versione dello schema.
MetadataKeyValuePair struttura
La struttura contenente una coppia chiave-valore per i metadati.
Campi
-
MetadataKey: stringa UTF-8, non inferiore a 1 o superiore a 128 byte di lunghezza, corrispondente a Custom string pattern #14.Una chiave di metadati.
-
MetadataValue– stringa UTF-8, non inferiore a 1 o superiore a 256 byte di lunghezza, corrispondente a Custom string pattern #14.Il valore corrispondente a una chiave di metadati.
SchemaVersionErrorItem struttura
Oggetto che contiene i dettagli di errore per un'operazione su una versione dello schema.
Campi
-
VersionNumber: numero (intero), non inferiore a 1 o superiore a 100000.Il numero di versione dello schema.
-
ErrorDetails: un oggetto ErrorDetails.I dettagli dell'errore per la versione dello schema.
ErrorDetails struttura
Un oggetto contenente dettagli di errore.
Campi
-
ErrorCode: stringa UTF-8.Il codice di errore per un errore.
-
ErrorMessage: stringa UTF-8.Il messaggio di errore relativo a un errore.
SchemaVersionNumber struttura
Una struttura contenente le informazioni sulla versione dello schema.
Campi
-
LatestVersion: booleano.La versione più recente disponibile per lo schema.
-
VersionNumber– Numero (intero), non inferiore a 1 o superiore a 100000.Il numero di versione dello schema.
SchemaId struttura
L'ID univoco dello schema nel registro degli AWS Glue schemi.
Campi
-
SchemaArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.L'ARN (Amazon Resource Name) dello schema. Deve essere fornito
SchemaArnoSchemaName. -
SchemaName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome dello schema. Deve essere fornito
SchemaArnoSchemaName. -
RegistryName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome del registro degli schemi che contiene lo schema.
Operazioni
GetSchemaVersionsDiff azione (Python: get_schema_versions_diff)
RegisterSchemaVersion azione (Python: register_schema_version)
CheckSchemaVersionValidity azione (Python: check_schema_version_idity)
GetSchemaByDefinition azione (Python: get_schema_by_definition)
PutSchemaVersionMetadata azione (Python: put_schema_version_metadata)
QuerySchemaVersionMetadata azione (Python: query_schema_version_metadata)
RemoveSchemaVersionMetadata azione (Python: remove_schema_version_metadata)
DeleteSchemaVersions azione (Python: delete_schema_versions)
CreateRegistry azione (Python: create_registry)
Crea un nuovo registro che può essere utilizzato per contenere una raccolta di schemi.
Richiesta
-
RegistryName: obbligatorio: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome del registro da creare, che può avere una lunghezza massima di 255 caratteri e può contenere solo lettere, numeri, trattino, trattino basso, simbolo del dollaro o cancelletto. Non sono ammessi spazi.
-
Description: stringa di descrizione, non superiore a 2048 byte di lunghezza, corrispondente a URI address multi-line string pattern.Una descrizione del registro. Se la descrizione non viene fornita, non ci sarà alcun valore di default.
-
Tags– Una matrice di mappe con coppie chiave-valore, non superiore alle 50 coppie.Ogni chiave è una stringa UTF-8, non inferiore a 1 o superiore a 128 byte di lunghezza.
Ogni valore è una stringa UTF-8, lunga non più di 256 byte.
AWS tag che contengono una coppia chiave-valore e possono essere ricercati tramite console, riga di comando o API.
Risposta
-
RegistryArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.L'Amazon Resource Name (ARN) del registro appena creato.
-
RegistryName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome del registro.
-
Description: stringa di descrizione, non superiore a 2048 byte di lunghezza, corrispondente a URI address multi-line string pattern.Una descrizione del registro.
-
Tags– Una matrice di mappe con coppie chiave-valore, non superiore alle 50 coppie.Ogni chiave è una stringa UTF-8, non inferiore a 1 o superiore a 128 byte di lunghezza.
Ogni valore è una stringa UTF-8, lunga non più di 256 byte.
I tag per il registro.
Errori
InvalidInputExceptionAccessDeniedExceptionAlreadyExistsExceptionResourceNumberLimitExceededExceptionConcurrentModificationExceptionInternalServiceException
CreateSchema azione (Python: create_schema)
Crea un nuovo set di schemi e registra la definizione dello schema. Restituisce un errore se il set di schemi esiste già senza registrare effettivamente la versione.
Quando viene creato il set di schemi, un checkpoint della versione verrà impostato sulla prima versione. La modalità di compatibilità "DISABLED" limita l'aggiunta di eventuali versioni aggiuntive dello schema dopo la prima versione. Per tutte le altre modalità di compatibilità, la convalida delle impostazioni di compatibilità verrà applicata solo a partire dalla seconda versione quando viene utilizzata l'API RegisterSchemaVersion.
Quando questa API viene chiamata senza un RegistryId, verrà creata una voce per un "registro predefinito" nelle tabelle del database del registro, se non è già presente.
Richiesta
-
RegistryId: un oggetto RegistryId.Si tratta di una forma wrapper che contiene i campi di identità del registro. Se non viene fornito, verrà utilizzato il registro predefinito. Il formato ARN per lo stesso sarà:
arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id. -
SchemaName: obbligatorio: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome dello schema da creare, che può avere una lunghezza massima di 255 caratteri e può contenere solo lettere, numeri, trattini, carattere di sottolineatura, simbolo del dollaro o segno di hash. Non sono ammessi spazi.
-
DataFormat: obbligatorio: stringa UTF-8 (valori validi:AVRO|JSON|PROTOBUF).Il formato dei dati della definizione dello schema. Al momento sono supportati
AVRO,JSONePROTOBUF. -
Compatibility: stringa UTF-8 (valori validi:NONE|DISABLED|BACKWARD|BACKWARD_ALL|FORWARD|FORWARD_ALL|FULL|FULL_ALL).La modalità di compatibilità dello schema. I valori possibili sono:
-
NONE: non si applica alcuna modalità di compatibilità. È possibile utilizzare questa opzione negli scenari di sviluppo o se non si conosce la modalità di compatibilità da applicare agli schemi. Qualsiasi nuova versione aggiunta sarà accettata senza essere sottoposta a un controllo di compatibilità.
-
DISABLED: questa scelta di compatibilità impedisce il controllo delle versioni per uno schema specifico. È possibile utilizzare questa opzione per impedire il controllo delle versioni future di uno schema.
-
BACKWARD: questa scelta di compatibilità è consigliata in quanto consente ai ricevitori di dati di leggere sia la versione attuale che quella precedente dello schema. Ciò significa che, ad esempio, una nuova versione dello schema non può eliminare i campi dati o modificarne il tipo, in modo che non possano essere letti dai lettori che utilizzano la versione precedente.
-
BACKWARD_ALL:: questa scelta di compatibilità consente ai ricevitori di dati di leggere sia la versione attuale che tutte quelle precedenti dello schema. È possibile utilizzare questa opzione quando è necessario eliminare campi o aggiungere campi facoltativi e verificare la compatibilità con tutte le versioni precedenti dello schema.
-
FORWARD: questa scelta di compatibilità consente ai ricevitori di dati di leggere sia la versione attuale che una versione successiva dello schema, ma non necessariamente le versioni più recenti. È possibile utilizzare questa opzione quando è necessario aggiungere campi o eliminare campi facoltativi, ma solo verificare la compatibilità con l'ultima versione dello schema.
-
FORWARD_ALL: questa scelta di compatibilità consente ai ricevitori di dati di leggere scritti dai produttori di qualsiasi nuovo schema registrato. È possibile utilizzare questa opzione quando è necessario aggiungere campi o eliminare campi facoltativi e verificare la compatibilità con tutte le versioni precedenti dello schema.
-
FULL: questa scelta di compatibilità consente ai ricevitori di dati di leggere i dati scritti dai produttori utilizzando la versione precedente o successiva dello schema, ma non necessariamente versioni precedenti o successive. È possibile utilizzare questa opzione quando è necessario aggiungere o eliminare campi facoltativi, ma solo verificare la compatibilità con l'ultima versione dello schema.
-
FULL_ALL: questa scelta di compatibilità consente ai ricevitori di dati di leggere i dati scritti dai produttori utilizzando tutte le versioni precedenti dello schema. È possibile utilizzare questa opzione quando è necessario aggiungere o eliminare campi facoltativi e verificare la compatibilità con tutte le versioni precedenti dello schema.
-
-
Description: stringa di descrizione, non superiore a 2048 byte di lunghezza, corrispondente a URI address multi-line string pattern.Una descrizione facoltativa dello schema. Se la descrizione non viene fornita, non ci sarà alcun valore predefinito automatico.
-
Tags– Una matrice di mappe con coppie chiave-valore, non superiore alle 50 coppie.Ogni chiave è una stringa UTF-8, non inferiore a 1 o superiore a 128 byte di lunghezza.
Ogni valore è una stringa UTF-8, lunga non più di 256 byte.
AWS tag che contengono una coppia chiave-valore e possono essere ricercati tramite console, riga di comando o API. Se specificato, segue lo AWS tags-on-create schema.
-
SchemaDefinition: stringa UTF-8, non inferiore a 1 o superiore a 170000 byte di lunghezza, corrispondente a Custom string pattern #13.La definizione dello schema che utilizza l'impostazione
DataFormatperSchemaName.
Risposta
-
RegistryName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome del registro.
-
RegistryArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.L'ARN (Amazon Resource Name) del registro.
-
SchemaName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome dello schema.
-
SchemaArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.L'ARN (Amazon Resource Name) dello schema.
-
Description: stringa di descrizione, non superiore a 2048 byte di lunghezza, corrispondente a URI address multi-line string pattern.Una descrizione dello schema, se specificata al momento della creazione.
-
DataFormat: stringa UTF-8 (valori validi:AVRO|JSON|PROTOBUF).Il formato dei dati della definizione dello schema. Al momento sono supportati
AVRO,JSONePROTOBUF. -
Compatibility: stringa UTF-8 (valori validi:NONE|DISABLED|BACKWARD|BACKWARD_ALL|FORWARD|FORWARD_ALL|FULL|FULL_ALL).La modalità di compatibilità dello schema.
-
SchemaCheckpoint– Numero (intero), non inferiore a 1 o superiore a 100000.Il numero di versione del checkpoint (l'ultima volta che la modalità di compatibilità è stata modificata).
-
LatestSchemaVersion– Numero (intero), non inferiore a 1 o superiore a 100000.La versione più recente dello schema associata alla definizione dello schema restituita.
-
NextSchemaVersion– Numero (intero), non inferiore a 1 o superiore a 100000.La versione successiva dello schema associata alla definizione dello schema restituita.
-
SchemaStatus: stringa UTF-8 (valori validi:AVAILABLE|PENDING|DELETING).Lo stato dello schema.
-
Tags– Una matrice di mappe con coppie chiave-valore, non superiore alle 50 coppie.Ogni chiave è una stringa UTF-8, non inferiore a 1 o superiore a 128 byte di lunghezza.
Ogni valore è una stringa UTF-8, lunga non più di 256 byte.
I tag per lo schema.
-
SchemaVersionId– stringa UTF-8, non inferiore a 36 o superiore a 36 byte di lunghezza, corrispondente a Custom string pattern #44.L'identificatore univoco della prima versione dello schema.
-
SchemaVersionStatus: stringa UTF-8 (valori validi:AVAILABLE|PENDING|FAILURE|DELETING).Lo stato della prima versione dello schema creata.
Errori
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionAlreadyExistsExceptionResourceNumberLimitExceededExceptionConcurrentModificationExceptionInternalServiceException
GetSchema azione (Python: get_schema)
Descrive lo schema specificato nel dettaglio.
Richiesta
-
SchemaId: obbligatorio: un oggetto SchemaId.Si tratta di una struttura wrapper che contiene i campi di identità dello schema. La struttura include:
-
SchemaId$SchemaArn: L'Amazon Resource Name (ARN) dello schema. Deve essere fornito
SchemaArnoppureSchemaNameeRegistryName. -
SchemaId$SchemaName: il nome dello schema. Deve essere fornito
SchemaArnoppureSchemaNameeRegistryName.
-
Risposta
-
RegistryName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome del registro.
-
RegistryArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.L'ARN (Amazon Resource Name) del registro.
-
SchemaName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome dello schema.
-
SchemaArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.L'ARN (Amazon Resource Name) dello schema.
-
Description: stringa di descrizione, non superiore a 2048 byte di lunghezza, corrispondente a URI address multi-line string pattern.Una descrizione dello schema, se specificata al momento della creazione
-
DataFormat: stringa UTF-8 (valori validi:AVRO|JSON|PROTOBUF).Il formato dei dati della definizione dello schema. Al momento sono supportati
AVRO,JSONePROTOBUF. -
Compatibility: stringa UTF-8 (valori validi:NONE|DISABLED|BACKWARD|BACKWARD_ALL|FORWARD|FORWARD_ALL|FULL|FULL_ALL).La modalità di compatibilità dello schema.
-
SchemaCheckpoint– Numero (intero), non inferiore a 1 o superiore a 100000.Il numero di versione del checkpoint (l'ultima volta che la modalità di compatibilità è stata modificata).
-
LatestSchemaVersion– Numero (intero), non inferiore a 1 o superiore a 100000.La versione più recente dello schema associata alla definizione dello schema restituita.
-
NextSchemaVersion– Numero (intero), non inferiore a 1 o superiore a 100000.La versione successiva dello schema associata alla definizione dello schema restituita.
-
SchemaStatus: stringa UTF-8 (valori validi:AVAILABLE|PENDING|DELETING).Lo stato dello schema.
-
CreatedTime: stringa UTF-8.La data e l'ora di creazione dello schema.
-
UpdatedTime: stringa UTF-8.La data e l'ora di aggiornamento dello schema.
Errori
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
ListSchemaVersions azione (Python: list_schema_versions)
Restituisce un elenco delle versioni dello schema create dall'utente, con informazioni minime. Le versioni dello schema nello stato Deleted non verranno incluse nei risultati. Se non sono disponibili versioni dello schema, verranno restituiti risultati vuoti.
Richiesta
-
SchemaId: obbligatorio: un oggetto SchemaId.Si tratta di una struttura wrapper che contiene i campi di identità dello schema. La struttura include:
-
SchemaId$SchemaArn: L'Amazon Resource Name (ARN) dello schema. Deve essere fornito
SchemaArnoppureSchemaNameeRegistryName. -
SchemaId$SchemaName: il nome dello schema. Deve essere fornito
SchemaArnoppureSchemaNameeRegistryName.
-
-
MaxResults– Numero (intero), non inferiore a 1 o superiore a 100.Numero massimo di risultati richiesti per pagina. Se il valore non viene fornito, sarà impostato in modo predefinito su 25 per pagina.
-
NextToken: stringa UTF-8.Un token di continuazione, se si tratta di una chiamata di continuazione.
Risposta
-
Schemas: una matrice di oggetti SchemaVersionListItem.Una matrice di oggetti
SchemaVersionListcontenenti i dettagli di ogni versione dello schema. -
NextToken: stringa UTF-8.Un token di continuazione per impaginare l'elenco restituito di token, restituiti se il segmento corrente dell'elenco non è l'ultimo.
Errori
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
GetSchemaVersion azione (Python: get_schema_version)
Ottiene lo schema specificato in base al relativo ID univoco assegnato alla creazione o alla registrazione di una versione dello schema. Le versioni dello schema nello stato Deleted non verranno incluse nei risultati.
Richiesta
-
SchemaId: un oggetto SchemaId.Si tratta di una struttura wrapper che contiene i campi di identità dello schema. La struttura include:
-
SchemaId$SchemaArn: L'Amazon Resource Name (ARN) dello schema. Deve essere fornito
SchemaArnoppureSchemaNameeRegistryName. -
SchemaId$SchemaName: il nome dello schema. Deve essere fornito
SchemaArnoppureSchemaNameeRegistryName.
-
-
SchemaVersionId– stringa UTF-8, non inferiore a 36 o superiore a 36 byte di lunghezza, corrispondente a Custom string pattern #44.La versione
SchemaVersionIddello schema. Questo campo è obbligatorio per il recupero in base all'ID dello schema. Deve essere fornito questo o il wrapperSchemaId. -
SchemaVersionNumber: un oggetto SchemaVersionNumber.Il numero di versione dello schema.
Risposta
-
SchemaVersionId– stringa UTF-8, non inferiore a 36 o superiore a 36 byte di lunghezza, corrispondente a Custom string pattern #44.La versione
SchemaVersionIddello schema. -
SchemaDefinition– stringa UTF-8, non inferiore a 1 o superiore a 170000 byte di lunghezza, corrispondente a Custom string pattern #13.La definizione dello schema per l'ID dello schema.
-
DataFormat: stringa UTF-8 (valori validi:AVRO|JSON|PROTOBUF).Il formato dei dati della definizione dello schema. Al momento sono supportati
AVRO,JSONePROTOBUF. -
SchemaArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.L'ARN (Amazon Resource Name) dello schema.
-
VersionNumber– Numero (intero), non inferiore a 1 o superiore a 100000.Il numero di versione dello schema.
-
Status: stringa UTF-8 (valori validi:AVAILABLE|PENDING|FAILURE|DELETING).Lo stato della versione dello schema.
-
CreatedTime: stringa UTF-8.La data e l'ora in cui è stata creata la versione dello schema.
Errori
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
GetSchemaVersionsDiff azione (Python: get_schema_versions_diff)
Recupera la differenza di versione dello schema nel tipo di differenza specificato tra due versioni dello schema archiviate nel registro degli schemi.
Questa API consente di confrontare due versioni dello schema tra due definizioni dello schema nello stesso schema.
Richiesta
-
SchemaId: obbligatorio: un oggetto SchemaId.Si tratta di una struttura wrapper che contiene i campi di identità dello schema. La struttura include:
-
SchemaId$SchemaArn: L'Amazon Resource Name (ARN) dello schema. Deve essere fornito
SchemaArnoSchemaName. -
SchemaId$SchemaName: il nome dello schema. Deve essere fornito
SchemaArnoSchemaName.
-
-
FirstSchemaVersionNumber: obbligatorio: un oggetto SchemaVersionNumber.La prima delle due versioni dello schema da confrontare.
-
SecondSchemaVersionNumber: obbligatorio: un oggetto SchemaVersionNumber.La seconda delle due versioni dello schema da confrontare.
-
SchemaDiffType. Obbligatorio: stringa UTF-8 (valori validi:SYNTAX_DIFF).Si riferisce a
SYNTAX_DIFF, che è il tipo di diff attualmente supportato.
Risposta
-
Diff: obbligatorio: stringa UTF-8, non inferiore a 1 o superiore a 340000 byte di lunghezza, corrispondente a Custom string pattern #13.La differenza tra gli schemi come stringa in JsonPatch formato.
Errori
InvalidInputExceptionEntityNotFoundExceptionAccessDeniedExceptionInternalServiceException
ListRegistries azione (Python: list_registries)
Restituisce un elenco di registri dall'utente, con informazioni minime. I registri nello stato Deleting non verranno inclusi nei risultati. Se non sono disponibili registri, verranno restituiti risultati vuoti.
Richiesta
-
MaxResults– Numero (intero), non inferiore a 1 o superiore a 100.Numero massimo di risultati richiesti per pagina. Se il valore non viene fornito, sarà impostato in modo predefinito su 25 per pagina.
-
NextToken: stringa UTF-8.Un token di continuazione, se si tratta di una chiamata di continuazione.
Risposta
-
Registries: una matrice di oggetti RegistryListItem.Una matrice di oggetti
RegistryDetailedListItemcontenenti dettagli minimi di ogni registro. -
NextToken: stringa UTF-8.Un token di continuazione per impaginare l'elenco restituito di token, restituiti se il segmento corrente dell'elenco non è l'ultimo.
Errori
InvalidInputExceptionAccessDeniedExceptionInternalServiceException
ListSchemas azione (Python: list_schemas)
Restituisce un elenco di schemi con dettagli minimi. Gli schemi nello stato Deleting non verranno inclusi nei risultati. Se non sono disponibili schemi, verranno restituiti risultati vuoti.
Quando il RegistryId non viene fornito, tutti gli schemi nei registri faranno parte della risposta dell'API.
Richiesta
-
RegistryId: un oggetto RegistryId.Una struttura wrapper che può contenere il nome del registro e l'Amazon Resource Name (ARN).
-
MaxResults– Numero (intero), non inferiore a 1 o superiore a 100.Numero massimo di risultati richiesti per pagina. Se il valore non viene fornito, sarà impostato in modo predefinito su 25 per pagina.
-
NextToken: stringa UTF-8.Un token di continuazione, se si tratta di una chiamata di continuazione.
Risposta
-
Schemas: una matrice di oggetti SchemaListItem.Una matrice di oggetti
SchemaListItemcontenenti i dettagli di ogni schema. -
NextToken: stringa UTF-8.Un token di continuazione per impaginare l'elenco restituito di token, restituiti se il segmento corrente dell'elenco non è l'ultimo.
Errori
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
RegisterSchemaVersion azione (Python: register_schema_version)
Aggiunge una nuova versione allo schema esistente. Restituisce un errore se la nuova versione dello schema non soddisfa i requisiti di compatibilità del set di schemi. Questa API non creerà un nuovo set di schemi e restituirà un errore 404 se il set di schemi non è già presente nel registro degli schemi.
Se si tratta della prima definizione dello schema da registrare nel registro degli schemi, questa API archivierà la versione dello schema e restituirà immediatamente. In caso contrario, l'esecuzione di questa chiamata potrebbe durare più a lungo rispetto ad altre operazioni a causa delle modalità di compatibilità. È possibile chiamare l'API GetSchemaVersion con SchemaVersionId per controllare le modalità di compatibilità.
Se la stessa definizione di schema è già archiviata nel registro degli schemi come versione, viene restituito al chiamante l'ID dello schema esistente.
Richiesta
-
SchemaId: obbligatorio: un oggetto SchemaId.Si tratta di una struttura wrapper che contiene i campi di identità dello schema. La struttura include:
-
SchemaId$SchemaArn: L'Amazon Resource Name (ARN) dello schema. Deve essere fornito
SchemaArnoppureSchemaNameeRegistryName. -
SchemaId$SchemaName: il nome dello schema. Deve essere fornito
SchemaArnoppureSchemaNameeRegistryName.
-
-
SchemaDefinition: obbligatorio: stringa UTF-8, non inferiore a 1 o superiore a 170000 byte di lunghezza, corrispondente a Custom string pattern #13.La definizione dello schema che utilizza l'impostazione
DataFormatperSchemaName.
Risposta
-
SchemaVersionId– stringa UTF-8, non inferiore a 36 o superiore a 36 byte di lunghezza, corrispondente a Custom string pattern #44.L'ID univoco che rappresenta la versione di questo schema.
-
VersionNumber– Numero (intero), non inferiore a 1 o superiore a 100000.La versione di questo schema (solo per flusso di sincronizzazione, se si tratta della prima versione).
-
Status: stringa UTF-8 (valori validi:AVAILABLE|PENDING|FAILURE|DELETING).Lo stato della versione dello schema.
Errori
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionResourceNumberLimitExceededExceptionConcurrentModificationExceptionInternalServiceException
UpdateSchema azione (Python: update_schema)
Aggiorna la descrizione, l'impostazione di compatibilità o il checkpoint della versione per un set di schemi.
Per aggiornare l'impostazione di compatibilità, la chiamata non convaliderà la compatibilità per l'intero set di versioni dello schema con la nuova impostazione di compatibilità. Se il valore per Compatibility viene fornito, è necessario fornire anche VersionNumber (un checkpoint). L'API convaliderà il numero di versione del checkpoint per garantire coerenza.
Se il valore per VersionNumber (checkpoint) è fornito, Compatibility è facoltativo e può essere usato per impostare/reimpostare un checkpoint per lo schema.
Questo aggiornamento verrà eseguito solo se lo schema si trova nello stato AVAILABLE.
Richiesta
-
SchemaId: obbligatorio: un oggetto SchemaId.Si tratta di una struttura wrapper che contiene i campi di identità dello schema. La struttura include:
-
SchemaId$SchemaArn: L'Amazon Resource Name (ARN) dello schema. Deve essere fornito
SchemaArnoSchemaName. -
SchemaId$SchemaName: il nome dello schema. Deve essere fornito
SchemaArnoSchemaName.
-
-
SchemaVersionNumber: un oggetto SchemaVersionNumber.Numero di versione richiesto per il checkpoint. Deve essere fornito
VersionNumberoCompatibility. -
Compatibility: stringa UTF-8 (valori validi:NONE|DISABLED|BACKWARD|BACKWARD_ALL|FORWARD|FORWARD_ALL|FULL|FULL_ALL).La nuova impostazione di compatibilità per lo schema.
-
Description: stringa di descrizione, non superiore a 2048 byte di lunghezza, corrispondente a URI address multi-line string pattern.La nuova descrizione per lo schema.
Risposta
-
SchemaArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.L'ARN (Amazon Resource Name) dello schema.
-
SchemaName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome dello schema.
-
RegistryName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome del registro che contiene lo schema.
Errori
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionConcurrentModificationExceptionInternalServiceException
CheckSchemaVersionValidity azione (Python: check_schema_version_idity)
Convalida lo schema fornito. Questa chiamata non ha effetti collaterali, convalida semplicemente usando lo schema fornito, utilizzando DataFormat come formato. Poiché non prevede un nome di set di schemi, non vengono eseguiti controlli di compatibilità.
Richiesta
-
DataFormat: obbligatorio: stringa UTF-8 (valori validi:AVRO|JSON|PROTOBUF).Il formato dei dati della definizione dello schema. Al momento sono supportati
AVRO,JSONePROTOBUF. -
SchemaDefinition– Obbligatorio: stringa UTF-8, non inferiore a 1 o superiore a 170000 byte di lunghezza, corrispondente a Custom string pattern #13.La definizione dello schema che deve essere convalidato.
Risposta
-
Valid: booleano.Se lo schema è valido restituisce true, in caso contrario false.
-
Error: stringa UTF-8, non inferiore a 1 o superiore a 5000 byte di lunghezza.Un messaggio di errore di convalida.
Errori
InvalidInputExceptionAccessDeniedExceptionInternalServiceException
UpdateRegistry azione (Python: update_registry)
Aggiorna un registro esistente che viene utilizzato per contenere una raccolta di schemi. Le proprietà aggiornate si riferiscono al registro e non modificano gli schemi all'interno del registro.
Richiesta
-
RegistryId: obbligatorio: un oggetto RegistryId.Si tratta di una struttura wrapper che può contenere il nome del registro e l'Amazon Resource Name (ARN).
-
Description: obbligatorio: stringa di descrizione, non superiore a 2048 byte di lunghezza, corrispondente a URI address multi-line string pattern.Una descrizione del registro. Se la descrizione non viene fornita, questo campo non verrà aggiornato.
Risposta
-
RegistryName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome del registro aggiornato.
-
RegistryArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.L'Amazon Resource name (ARN) del registro aggiornato.
Errori
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionConcurrentModificationExceptionInternalServiceException
GetSchemaByDefinition azione (Python: get_schema_by_definition)
Recupera uno schema mediante la SchemaDefinition. La definizione dello schema viene inviata al registro degli schemi, canonicalizzata e sottoposta ad hashing. Se l'hash è abbinato nell'ambito del SchemaName o ARN (o il registro di default, se non viene fornito), vengono restituiti i metadati dello schema. In caso contrario, viene restituito un errore 404 o. NotFound Le versioni dello schema nello stato Deleted non verranno incluse nei risultati.
Richiesta
-
SchemaId: obbligatorio: un oggetto SchemaId.Si tratta di una struttura wrapper che contiene i campi di identità dello schema. La struttura include:
-
SchemaId$SchemaArn: L'Amazon Resource Name (ARN) dello schema. Deve essere fornito
SchemaArnoSchemaName. -
SchemaId$SchemaName: il nome dello schema. Deve essere fornito
SchemaArnoSchemaName.
-
-
SchemaDefinition. Obbligatorio: stringa UTF-8, non inferiore a 1 o superiore a 170000 byte di lunghezza, corrispondente a Custom string pattern #13.La definizione dello schema per il quale sono necessari i dettagli dello schema.
Risposta
-
SchemaVersionId– stringa UTF-8, non inferiore a 36 o superiore a 36 byte di lunghezza, corrispondente a Custom string pattern #44.L'ID dello schema della versione dello schema.
-
SchemaArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.L'ARN (Amazon Resource Name) dello schema.
-
DataFormat: stringa UTF-8 (valori validi:AVRO|JSON|PROTOBUF).Il formato dei dati della definizione dello schema. Al momento sono supportati
AVRO,JSONePROTOBUF. -
Status: stringa UTF-8 (valori validi:AVAILABLE|PENDING|FAILURE|DELETING).Lo stato della versione dello schema.
-
CreatedTime: stringa UTF-8.La data e l'ora di creazione dello schema.
Errori
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
GetRegistry azione (Python: get_registry)
Descrive il registro specificato nel dettaglio.
Richiesta
-
RegistryId: obbligatorio: un oggetto RegistryId.Si tratta di una struttura wrapper che può contenere il nome del registro e l'Amazon Resource Name (ARN).
Risposta
-
RegistryName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome del registro.
-
RegistryArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.L'ARN (Amazon Resource Name) del registro.
-
Description: stringa di descrizione, non superiore a 2048 byte di lunghezza, corrispondente a URI address multi-line string pattern.Una descrizione del registro.
-
Status: stringa UTF-8 (valori validi:AVAILABLE|DELETING).Lo stato del registro.
-
CreatedTime: stringa UTF-8.La data e l'ora di creazione del registro.
-
UpdatedTime: stringa UTF-8.La data e l'ora di aggiornamento del registro.
Errori
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
PutSchemaVersionMetadata azione (Python: put_schema_version_metadata)
Inserisce la coppia chiave-valore dei metadati per un ID versione dello schema specificato. Sarà consentito un massimo di 10 coppie chiave-valore per ciascuna versione dello schema. Possono essere aggiunte su una o più chiamate.
Richiesta
-
SchemaId: un oggetto SchemaId.L'ID univoco dello schema.
-
SchemaVersionNumber: un oggetto SchemaVersionNumber.Il numero di versione dello schema.
-
SchemaVersionId– stringa UTF-8, non inferiore a 36 o superiore a 36 byte di lunghezza, corrispondente a Custom string pattern #44.L'ID versione univoco della versione dello schema.
-
MetadataKeyValue: obbligatorio: un oggetto MetadataKeyValuePair.Il valore corrispondente a una chiave di metadati.
Risposta
-
SchemaArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.L'ARN (Amazon Resource Name) per lo schema.
-
SchemaName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome per lo schema.
-
RegistryName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome per il registro.
-
LatestVersion: booleano.La versione più recente dello schema.
-
VersionNumber– Numero (intero), non inferiore a 1 o superiore a 100000.Il numero di versione dello schema.
-
SchemaVersionId– stringa UTF-8, non inferiore a 36 o superiore a 36 byte di lunghezza, corrispondente a Custom string pattern #44.L'ID versione univoco della versione dello schema.
-
MetadataKey– stringa UTF-8, non inferiore a 1 o superiore a 128 byte di lunghezza, corrispondente a Custom string pattern #14.La chiave di metadati.
-
MetadataValue– stringa UTF-8, non inferiore a 1 o superiore a 256 byte di lunghezza, corrispondente a Custom string pattern #14.Il valore della chiave di metadati.
Errori
InvalidInputExceptionAccessDeniedExceptionAlreadyExistsExceptionEntityNotFoundExceptionResourceNumberLimitExceededException
QuerySchemaVersionMetadata azione (Python: query_schema_version_metadata)
Query per le informazioni sui metadati della versione dello schema.
Richiesta
-
SchemaId: un oggetto SchemaId.Una struttura wrapper che può contenere il nome dello schema e l'Amazon Resource Name (ARN).
-
SchemaVersionNumber: un oggetto SchemaVersionNumber.Il numero di versione dello schema.
-
SchemaVersionId– stringa UTF-8, non inferiore a 36 o superiore a 36 byte di lunghezza, corrispondente a Custom string pattern #44.L'ID versione univoco della versione dello schema.
-
MetadataList: una matrice di oggetti MetadataKeyValuePair.Cerca coppie chiave-valore per i metadati, se non vengono forniti verranno recuperate tutte le informazioni sui metadati.
-
MaxResults: numero (intero), non inferiore a 1 o superiore a 50.Numero massimo di risultati richiesti per pagina. Se il valore non viene fornito, sarà impostato in modo predefinito su 25 per pagina.
-
NextToken: stringa UTF-8.Un token di continuazione, se si tratta di una chiamata di continuazione.
Risposta
-
MetadataInfoMap: una matrice della mappa di coppie chiave-valore.Ogni chiave è una stringa UTF-8, non inferiore a 1 o superiore a 128 byte di lunghezza, corrispondente a Custom string pattern #14.
Ogni valore è un oggetto MetadataInfo.
Una mappa di una chiave di metadati e dei valori associati.
-
SchemaVersionId– stringa UTF-8, non inferiore a 36 o superiore a 36 byte di lunghezza, corrispondente a Custom string pattern #44.L'ID versione univoco della versione dello schema.
-
NextToken: stringa UTF-8.Un token di continuazione per impaginare l'elenco restituito di token, restituiti se il segmento corrente dell'elenco non è l'ultimo.
Errori
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundException
RemoveSchemaVersionMetadata azione (Python: remove_schema_version_metadata)
Rimuove una coppia chiave-valore dai metadati della versione dello schema per l'ID versione dello schema specificato.
Richiesta
-
SchemaId: un oggetto SchemaId.Una struttura wrapper che può contenere il nome dello schema e l'Amazon Resource Name (ARN).
-
SchemaVersionNumber: un oggetto SchemaVersionNumber.Il numero di versione dello schema.
-
SchemaVersionId– stringa UTF-8, non inferiore a 36 o superiore a 36 byte di lunghezza, corrispondente a Custom string pattern #44.L'ID versione univoco della versione dello schema.
-
MetadataKeyValue: obbligatorio: un oggetto MetadataKeyValuePair.Il valore della chiave di metadati.
Risposta
-
SchemaArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.L'ARN (Amazon Resource Name) dello schema.
-
SchemaName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome dello schema.
-
RegistryName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome del registro.
-
LatestVersion: booleano.La versione più recente dello schema.
-
VersionNumber– Numero (intero), non inferiore a 1 o superiore a 100000.Il numero di versione dello schema.
-
SchemaVersionId– stringa UTF-8, non inferiore a 36 o superiore a 36 byte di lunghezza, corrispondente a Custom string pattern #44.L'ID versione per la versione dello schema.
-
MetadataKey– stringa UTF-8, non inferiore a 1 o superiore a 128 byte di lunghezza, corrispondente a Custom string pattern #14.La chiave di metadati.
-
MetadataValue– stringa UTF-8, non inferiore a 1 o superiore a 256 byte di lunghezza, corrispondente a Custom string pattern #14.Il valore della chiave di metadati.
Errori
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundException
DeleteRegistry azione (Python: delete_registry)
Elimina l'intero registro, inclusi gli schemi e tutte le relative versioni. Per ottenere lo stato dell'operazione di eliminazione, è possibile chiamare l'API GetRegistry dopo la chiamata asincrona. L'eliminazione di un registro disattiverà tutte le operazioni online per il registro, comeUpdateRegistry,, CreateSchema e. UpdateSchema RegisterSchemaVersion APIs
Richiesta
-
RegistryId: obbligatorio: un oggetto RegistryId.Si tratta di una struttura wrapper che può contenere il nome del registro e l'Amazon Resource Name (ARN).
Risposta
-
RegistryName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome del registro in fase di eliminazione.
-
RegistryArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.L'Amazon Resource Name (ARN) del registro in fase di eliminazione.
-
Status: stringa UTF-8 (valori validi:AVAILABLE|DELETING).Lo stato del registro. Un'operazione riuscita restituirà lo stato
Deleting.
Errori
InvalidInputExceptionEntityNotFoundExceptionAccessDeniedExceptionConcurrentModificationException
DeleteSchema azione (Python: delete_schema)
Elimina l'intero set di schemi, inclusi il set di schemi e tutte le relative versioni. Per ottenere lo stato dell'operazione di eliminazione, è possibile chiamare l'API GetSchema dopo la chiamata asincrona. L'eliminazione di un registro disattiverà tutte le operazioni online per lo schema, ad esempio, e. GetSchemaByDefinition RegisterSchemaVersion APIs
Richiesta
-
SchemaId: obbligatorio: un oggetto SchemaId.Si tratta di una struttura wrapper che può contenere il nome dello schema e l'Amazon Resource Name (ARN).
Risposta
-
SchemaArn– stringa UTF-8, non inferiore a 1 o superiore a 10240 byte di lunghezza, corrispondente a Custom string pattern #49.L'Amazon Resource Name (ARN) dello schema in fase di eliminazione.
-
SchemaName: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Custom string pattern #45.Il nome dello schema in fase di eliminazione.
-
Status: stringa UTF-8 (valori validi:AVAILABLE|PENDING|DELETING).Lo stato dello schema.
Errori
InvalidInputExceptionEntityNotFoundExceptionAccessDeniedExceptionConcurrentModificationException
DeleteSchemaVersions azione (Python: delete_schema_versions)
Rimuove le versioni dallo schema specificato. Può essere fornito un numero di versione o un intervallo. Se la modalità di compatibilità impedisce l'eliminazione di una versione necessaria, ad esempio BACKWARDS_FULL, viene restituito un errore. Chiamare l'API GetSchemaVersions dopo questa chiamata elencherà lo stato delle versioni eliminate.
Quando l'intervallo di numeri di versione contiene la versione di checkpoint, l'API restituirà un conflitto 409 e non procederà con l'eliminazione. Prima di utilizzare questa API è necessario rimuovere il checkpoint usando l'API DeleteSchemaCheckpoint
Non è possibile utilizzare l'API DeleteSchemaVersions per eliminare la prima versione dello schema nel set di schemi. La prima versione dello schema può essere eliminata solo dall'API DeleteSchema. Questa operazione eliminerà anche i SchemaVersionMetadata collegati nelle versioni dello schema. Le eliminazioni definitive verranno applicate al database.
Se la modalità di compatibilità impedisce l'eliminazione di una versione necessaria, ad esempio BACKWARDS_FULL, viene restituito un errore.
Richiesta
-
SchemaId: obbligatorio: un oggetto SchemaId.Si tratta di una struttura wrapper che può contenere il nome dello schema e l'Amazon Resource Name (ARN).
-
Versions: obbligatorio: stringa UTF-8, non inferiore a 1 o superiore a 100000 byte di lunghezza, corrispondente a Custom string pattern #15.Può essere fornita un intervallo di versioni nel formato:
-
un unico numero di versione, 5
-
un intervallo, 5-8: elimina le versioni 5, 6, 7, 8
-
Risposta
-
SchemaVersionErrors: una matrice di oggetti SchemaVersionErrorItem.Un elenco di oggetti
SchemaVersionErrorItem, ciascuno contenente un errore e una versione dello schema.
Errori
InvalidInputExceptionEntityNotFoundExceptionAccessDeniedExceptionConcurrentModificationException
