Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
Die Schemaregistrierungs-API beschreibt die Datentypen und die API für die Arbeit mit Schemas in AWS Glue.
Datentypen
RegistryId Struktur
Eine Wrapper-Struktur, die den Registrierungsnamen und den Amazon-Ressourcennamen (ARN) enthält.
Felder
-
RegistryName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Name der Registrierung. Wird nur für die Suche verwendet. Eine
RegistryArnoderRegistryNamemuss angegeben werden. -
RegistryArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.ARN der zu aktualisierenden Registrierung. Eine
RegistryArnoderRegistryNamemuss angegeben werden.
RegistryListItem Struktur
Eine Struktur, die Details für eine Registrierung enthält.
Felder
-
RegistryName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name der Registrierung.
-
RegistryArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.Der Amazon-Ressourcenname (ARN) der Registrierung.
-
Description– Beschreibende Zeichenfolge, nicht mehr als 2048 Bytes lang, passend zum URI address multi-line string pattern.Eine Beschreibung der Registrierung.
-
Status– UTF-8-Zeichenfolge (zulässige Werte:AVAILABLE|DELETING).Der Status der Registrierung.
-
CreatedTime– UTF-8-Zeichenfolge.Das Datum, an dem die Registrierung erstellt wurde.
-
UpdatedTime– UTF-8-Zeichenfolge.Das Datum, an dem die Registrierung aktualisiert wurde.
MetadataInfo Struktur
Eine Struktur, die Metadateninformationen für eine Schemaversion enthält.
Felder
-
MetadataValue– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 256 Bytes lang, passend zum Custom string pattern #14.Der entsprechende Wert eines Metadatenschlüssels.
-
CreatedTime– UTF-8-Zeichenfolge.Die Uhrzeit, zu der der Eintrag erstellt wurde.
-
OtherMetadataValueList– Ein Array mit OtherMetadataValueListItem-Objekten.Andere Metadaten, die zum gleichen Metadatenschlüssel gehören.
OtherMetadataValueListItem Struktur
Eine Struktur, die andere Metadaten für eine Schemaversion enthält, die zu demselben Metadatenschlüssel gehört.
Felder
-
MetadataValue– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 256 Bytes lang, passend zum Custom string pattern #14.Der entsprechende Wert des Metadatenschlüssels für die anderen Metadaten, die zum selben Metadatenschlüssel gehören.
-
CreatedTime– UTF-8-Zeichenfolge.Die Uhrzeit, zu der der Eintrag erstellt wurde.
SchemaListItem Struktur
Ein Objekt, das minimale Details für ein Schema enthält.
Felder
-
RegistryName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name der Registrierung, in der sich das Schema befindet.
-
SchemaName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name des Schemas.
-
SchemaArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.Der Amazon-Ressourcenname (ARN) für das Schema.
-
Description– Beschreibende Zeichenfolge, nicht mehr als 2048 Bytes lang, passend zum URI address multi-line string pattern.Eine Beschreibung für das Schema.
-
SchemaStatus– UTF-8-Zeichenfolge (zulässige Werte:AVAILABLE|PENDING|DELETING).Der Status des Schemas.
-
CreatedTime– UTF-8-Zeichenfolge.Datum und Uhrzeit, an denen das Schema angelegt wurde.
-
UpdatedTime– UTF-8-Zeichenfolge.Datum und Uhrzeit, an denen das Schema aktualisiert wurde.
SchemaVersionListItem Struktur
Ein Objekt, das die Details zu einer Schemaversion enthält.
Felder
-
SchemaArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.Der Amazon-Ressourcenname (ARN) des Schemas.
-
SchemaVersionId– UTF-8-Zeichenfolge, nicht weniger als 36 oder mehr als 36 Bytes lang, passend zum Custom string pattern #44.Die eindeutige Kennung der Schemaversion.
-
VersionNumber– Zahl (lang), nicht kleiner als 1 oder größer als 100 000.Die Versionsnummer des Schemas.
-
Status– UTF-8-Zeichenfolge (zulässige Werte:AVAILABLE|PENDING|FAILURE|DELETING).Der Status der Schemaversion.
-
CreatedTime– UTF-8-Zeichenfolge.Das Datum und die Uhrzeit, zu denen die Schemaversion erstellt wurde.
MetadataKeyValuePair Struktur
Eine Struktur, die Schlüssel-Wert-Paare für Metadaten enthält.
Felder
-
MetadataKey– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 128 Bytes lang, passend zum Custom string pattern #14.Ein Metadatenschlüssel.
-
MetadataValue– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 256 Bytes lang, passend zum Custom string pattern #14.Der entsprechende Wert eines Metadatenschlüssels.
SchemaVersionErrorItem Struktur
Ein Objekt, das die Fehlerdetails für einen Vorgang in einer Schemaversion enthält.
Felder
-
VersionNumber– Zahl (lang), nicht kleiner als 1 oder größer als 100 000.Die Versionsnummer des Schemas.
-
ErrorDetails– Ein ErrorDetails-Objekt.Die Fehlerdetails für die Schemaversion.
ErrorDetails Struktur
Ein Objekt, das Fehlerdetails enthält.
Felder
-
ErrorCode– UTF-8-Zeichenfolge.Der Fehlercode für einen Fehler.
-
ErrorMessage– UTF-8-Zeichenfolge.Die Fehlermeldung für einen Fehler.
SchemaVersionNumber Struktur
Eine Struktur, die Informationen für eine Schemaversion enthält.
Felder
-
LatestVersion– Boolesch.Die neueste Version, die für das Schema verfügbar ist.
-
VersionNumber– Zahl (lang), nicht kleiner als 1 oder größer als 100 000.Die Versionsnummer des Schemas.
SchemaId Struktur
Die eindeutige ID des Schemas in der AWS Glue Schemaregistrierung.
Felder
-
SchemaArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.Der Amazon-Ressourcenname (ARN) des Schemas. Eine
SchemaArnoderSchemaNamemuss angegeben werden. -
SchemaName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name des Schemas. Eine
SchemaArnoderSchemaNamemuss angegeben werden. -
RegistryName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name der Schema Registry, die das Schema enthält
Operationen
GetSchemaVersionsDiff Aktion (Python: get_schema_versions_diff)
RegisterSchemaVersion Aktion (Python: register_schema_version)
CheckSchemaVersionValidity Aktion (Python: check_schema_version_validity)
GetSchemaByDefinition Aktion (Python: get_schema_by_definition)
PutSchemaVersionMetadata Aktion (Python: put_schema_version_metadata)
QuerySchemaVersionMetadata Aktion (Python: query_schema_version_metadata)
RemoveSchemaVersionMetadata Aktion (Python: remove_schema_version_metadata)
DeleteSchemaVersions Aktion (Python: delete_schema_versions)
CreateRegistry Aktion (Python: create_registry)
Erstellt eine neue Registrierung, mit der eine Schemasammlung gespeichert werden kann.
Anforderung
-
RegistryName– Erforderlich: UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name der zu erstellenden Registrierung. Darf höchstens 255 Zeichen enthalten und nur aus Buchstaben, Ziffern, Bindestrichen, Unterstrichen, Dollarzeichen und Hash-Zeichen bestehen. Keine Leerzeichen.
-
Description– Beschreibende Zeichenfolge, nicht mehr als 2048 Bytes lang, passend zum URI address multi-line string pattern.Eine Beschreibung der Registrierung. Wenn keine Beschreibung angegeben wird, gibt es dafür keinen Standardwert.
-
Tags– Ein Map-Array von Schlüssel-Wert-Paaren, nicht mehr als 50 Paare.Jeder Schlüssel ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Jeder Wert ist eine UTF-8-Zeichenfolge, die nicht mehr als 256 Bytes lang ist.
AWS Tags, die ein Schlüssel-Wert-Paar enthalten und über die Konsole, Befehlszeile oder API durchsucht werden können.
Antwort
-
RegistryArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.Der Amazon-Ressourcenname (ARN) der neu erstellten Registrierung.
-
RegistryName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name der Registrierung.
-
Description– Beschreibende Zeichenfolge, nicht mehr als 2048 Bytes lang, passend zum URI address multi-line string pattern.Eine Beschreibung der Registrierung.
-
Tags– Ein Map-Array von Schlüssel-Wert-Paaren, nicht mehr als 50 Paare.Jeder Schlüssel ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Jeder Wert ist eine UTF-8-Zeichenfolge, die nicht mehr als 256 Bytes lang ist.
Die Tags für die Registrierung.
Fehler
InvalidInputExceptionAccessDeniedExceptionAlreadyExistsExceptionResourceNumberLimitExceededExceptionConcurrentModificationExceptionInternalServiceException
CreateSchema Aktion (Python: create_schema)
Erstellt einen neuen Schemasatz und registriert die Schemadefinition. Gibt einen Fehler zurück, wenn der Schemasatz bereits vorhanden ist, ohne die Version tatsächlich zu registrieren.
Wenn der Schemasatz erstellt wird, wird ein Versionsprüfpunkt auf die erste Version gesetzt. Der Kompatibilitätsmodus „DISABLED“ (DEAKTIVIERT) schränkt das Hinzufügen zusätzlicher Schemaversionen nach der ersten Schemaversion ein. Für alle anderen Kompatibilitätsmodi wird die Validierung von Kompatibilitätseinstellungen erst ab der zweiten Version angewendet, wenn die RegisterSchemaVersion API verwendet wird.
Wird diese API ohne RegistryId aufgerufen, wird ein Eintrag für eine „default-registry“ (Standardregistrierung) in den Registry-Datenbanktabellen erstellt, sofern nicht bereits vorhanden.
Anforderung
-
RegistryId– Ein RegistryId-Objekt.Das ist ein Wrapper-Shape, das die Registry-Identitätsfelder enthält. Falls dieses nicht angegeben wird, wird die Standardregistrierung verwendet. Das ARN-Format dafür lautet:
arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id. -
SchemaName– Erforderlich: UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name des zu erstellenden Schemas darf höchstens 255 Zeichen enthalten und nur aus Buchstaben, Ziffern, Bindestrichen, Unterstrichen, Dollarzeichen und Hash-Zeichen bestehen. Keine Leerzeichen.
-
DataFormat– Erforderlich: UTF-8-Zeichenfolge (zulässige Werte:AVRO|JSON|PROTOBUF).Das Datenformat der Schemadefinition. Derzeit werden
AVRO,JSONundPROTOBUFunterstützt. -
Compatibility– UTF-8-Zeichenfolge (zulässige Werte:NONE|DISABLED|BACKWARD|BACKWARD_ALL|FORWARD|FORWARD_ALL|FULL|FULL_ALL).Der Kompatibilitätsmodus des Schemas. Die möglichen Werte sind:
-
NONE (KEINE): Es gibt keinen Kompatibilitätsmodus. Sie können diese Option in Entwicklungsszenarien verwenden, oder wenn Sie den Kompatibilitätsmodus, den Sie auf Schemata anwenden möchten, nicht kennen. Jede neue Version, die hinzugefügt wird, wird ohne Kompatibilitätsprüfung akzeptiert.
-
DISABLED (DEAKTIVIERT): Diese Kompatibilitätsoption verhindert das Versioning für ein bestimmtes Schema. Sie können diese Option verwenden, um zukünftiges Versioning eines Schemas zu verhindern.
-
BACKWARD (ABWÄRTS): Diese Kompatibilitätsoption wird empfohlen, damit Daten-Receiver sowohl die aktuelle als auch die vorherige Schemaversion lesen können. Das bedeutet, dass beispielsweise eine neue Schemaversion Datenfelder nicht löschen oder den Typ dieser Felder ändern kann, sodass sie von Readern mit der vorherigen Version nicht gelesen werden können.
-
BACKWARD_ALL (ABWÄRTS_ALLE): Diese Kompatibilitätsoption ermöglicht den Daten-Receivern sowohl die aktuelle als auch alle vorherigen Schemaversionen zu lesen. Sie können diese Option verwenden, wenn Sie Felder löschen oder optionale Felder hinzufügen und die Kompatibilität mit allen vorherigen Schemaversionen überprüfen möchten.
-
FORWARD (AUFWÄRTS): Diese Kompatibilitätsoption ermöglicht Daten-Receivern, sowohl die aktuelle als auch die nachfolgende Schemaversion zu lesen, aber nicht unbedingt spätere Versionen. Sie können diese Option verwenden, wenn Sie Felder hinzufügen oder optionale Felder löschen und nur die Kompatibilität mit der letzten vorherigen Schemaversion überprüfen möchten.
-
FORWARD_ALL (AUFWÄRTS_ALLE): Diese Kompatibilitätsoption ermöglicht Daten-Receivern, Daten zu lesen, die von Verfassern eines neuen registrierten Schemas geschrieben wurden. Sie können diese Option verwenden, wenn Sie Felder hinzufügen oder optionale Felder löschen und die Kompatibilität mit allen vorherigen Schemaversionen überprüfen möchten.
-
FULL (VOLL): Diese Kompatibilitätsoption ermöglicht Data-Receivern, Daten zu lesen, die von Verfassern geschrieben wurden, die die vorherige oder die nächste Version des Schemas verwenden, jedoch nicht unbedingt frühere oder spätere Versionen. Sie können diese Option verwenden, wenn Sie optionale Felder hinzufügen oder löschen und nur die Kompatibilität mit der letzten vorherigen Schemaversion überprüfen möchten.
-
FULL_ALL (VOLL_ALLE): Diese Kompatibilitätsoption ermöglicht Daten-Receiver, Daten zu lesen, die von Verfassern geschrieben wurden, die alle früheren Schemaversionen verwenden. Sie können diese Option verwenden, wenn Sie optionale Felder hinzufügen oder löschen und die Kompatibilität mit allen vorherigen Schemaversionen überprüfen möchten.
-
-
Description– Beschreibende Zeichenfolge, nicht mehr als 2048 Bytes lang, passend zum URI address multi-line string pattern.Eine optionale Beschreibung des Schemas. Wenn keine Beschreibung angegeben wird, gibt es dafür keinen automatischen Standardwert.
-
Tags– Ein Map-Array von Schlüssel-Wert-Paaren, nicht mehr als 50 Paare.Jeder Schlüssel ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Jeder Wert ist eine UTF-8-Zeichenfolge, die nicht mehr als 256 Bytes lang ist.
AWS Tags, die ein Schlüssel-Wert-Paar enthalten und über die Konsole, Befehlszeile oder API durchsucht werden können. Falls angegeben, folgt es dem AWS tags-on-create Muster.
-
SchemaDefinition– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 170 000 Bytes lang, passend zum Custom string pattern #13.Die Schemadefinition, die die
DataFormat-Einstellung fürSchemaNameverwendet.
Antwort
-
RegistryName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name der Registrierung.
-
RegistryArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.Der Amazon-Ressourcenname (ARN) der Registrierung.
-
SchemaName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name des Schemas.
-
SchemaArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.Der Amazon-Ressourcenname (ARN) des Schemas.
-
Description– Beschreibende Zeichenfolge, nicht mehr als 2048 Bytes lang, passend zum URI address multi-line string pattern.Eine Beschreibung des Schemas, das gegebenenfalls bei der Erstellung angegeben wurde.
-
DataFormat– UTF-8-Zeichenfolge (zulässige Werte:AVRO|JSON|PROTOBUF).Das Datenformat der Schemadefinition. Derzeit werden
AVRO,JSONundPROTOBUFunterstützt. -
Compatibility– UTF-8-Zeichenfolge (zulässige Werte:NONE|DISABLED|BACKWARD|BACKWARD_ALL|FORWARD|FORWARD_ALL|FULL|FULL_ALL).Der Schema-Kompatibilitätsmodus.
-
SchemaCheckpoint– Zahl (lang), nicht kleiner als 1 oder größer als 100 000.Die Versionsnummer des Checkpoints (das letzte Mal, als der Kompatibilitätsmodus geändert wurde).
-
LatestSchemaVersion– Zahl (lang), nicht kleiner als 1 oder größer als 100 000.Die aktuellste Version des Schemas, das der zurückgegebenen Schemadefinition zugewiesen ist.
-
NextSchemaVersion– Zahl (lang), nicht kleiner als 1 oder größer als 100 000.Die nächste Version des Schemas, das der zurückgegebenen Schemadefinition zugewiesen ist.
-
SchemaStatus– UTF-8-Zeichenfolge (zulässige Werte:AVAILABLE|PENDING|DELETING).Der Status des Schemas.
-
Tags– Ein Map-Array von Schlüssel-Wert-Paaren, nicht mehr als 50 Paare.Jeder Schlüssel ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Jeder Wert ist eine UTF-8-Zeichenfolge, die nicht mehr als 256 Bytes lang ist.
Die Tags für das Schema.
-
SchemaVersionId– UTF-8-Zeichenfolge, nicht weniger als 36 oder mehr als 36 Bytes lang, passend zum Custom string pattern #44.Die eindeutige Kennung der ersten Schemaversion.
-
SchemaVersionStatus– UTF-8-Zeichenfolge (zulässige Werte:AVAILABLE|PENDING|FAILURE|DELETING).Der Status der ersten erstellten Schemaversion.
Fehler
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionAlreadyExistsExceptionResourceNumberLimitExceededExceptionConcurrentModificationExceptionInternalServiceException
GetSchema Aktion (Python: get_schema)
Beschreibt das angegebene Schema im Detail.
Anforderung
-
SchemaId– Erforderlich: Ein SchemaId-Objekt.Das ist eine Wrapper-Struktur, die Schema-Identitätsfelder enthält. Die Struktur enthält:
-
SchemaId$SchemaArn: Der Amazon-Ressourcenname (ARN) des Schemas. Entweder
SchemaArnoderSchemaNameundRegistryNamemüssen zur Verfügung gestellt werden. -
SchemaId$SchemaName: Der Name des Schemas. Entweder
SchemaArnoderSchemaNameundRegistryNamemüssen zur Verfügung gestellt werden.
-
Antwort
-
RegistryName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name der Registrierung.
-
RegistryArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.Der Amazon-Ressourcenname (ARN) der Registrierung.
-
SchemaName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name des Schemas.
-
SchemaArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.Der Amazon-Ressourcenname (ARN) des Schemas.
-
Description– Beschreibende Zeichenfolge, nicht mehr als 2048 Bytes lang, passend zum URI address multi-line string pattern.Eine Beschreibung des Schemas, das gegebenenfalls bei der Erstellung angegeben wurde
-
DataFormat– UTF-8-Zeichenfolge (zulässige Werte:AVRO|JSON|PROTOBUF).Das Datenformat der Schemadefinition. Derzeit werden
AVRO,JSONundPROTOBUFunterstützt. -
Compatibility– UTF-8-Zeichenfolge (zulässige Werte:NONE|DISABLED|BACKWARD|BACKWARD_ALL|FORWARD|FORWARD_ALL|FULL|FULL_ALL).Der Kompatibilitätsmodus des Schemas.
-
SchemaCheckpoint– Zahl (lang), nicht kleiner als 1 oder größer als 100 000.Die Versionsnummer des Checkpoints (das letzte Mal, als der Kompatibilitätsmodus geändert wurde).
-
LatestSchemaVersion– Zahl (lang), nicht kleiner als 1 oder größer als 100 000.Die aktuellste Version des Schemas, das der zurückgegebenen Schemadefinition zugewiesen ist.
-
NextSchemaVersion– Zahl (lang), nicht kleiner als 1 oder größer als 100 000.Die nächste Version des Schemas, das der zurückgegebenen Schemadefinition zugewiesen ist.
-
SchemaStatus– UTF-8-Zeichenfolge (zulässige Werte:AVAILABLE|PENDING|DELETING).Der Status des Schemas.
-
CreatedTime– UTF-8-Zeichenfolge.Das Datum und die Uhrzeit, zu denen das Schema erstellt wurde.
-
UpdatedTime– UTF-8-Zeichenfolge.Datum und Uhrzeit, an denen das Schema aktualisiert wurde.
Fehler
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
ListSchemaVersions Aktion (Python: list_schema_versions)
Gibt eine Liste der von Ihnen erstellten Schemaversionen mit minimalen Informationen zurück. Der Status „Deleted“ (Gelöscht) wird nicht in die Ergebnisse aufgenommen. Leere Ergebnisse werden zurückgegeben, wenn keine Schemaversionen verfügbar sind.
Anforderung
-
SchemaId– Erforderlich: Ein SchemaId-Objekt.Das ist eine Wrapper-Struktur, die Schema-Identitätsfelder enthält. Die Struktur enthält:
-
SchemaId$SchemaArn: Der Amazon-Ressourcenname (ARN) des Schemas. Entweder
SchemaArnoderSchemaNameundRegistryNamemüssen zur Verfügung gestellt werden. -
SchemaId$SchemaName: Der Name des Schemas. Entweder
SchemaArnoderSchemaNameundRegistryNamemüssen zur Verfügung gestellt werden.
-
-
MaxResults– Zahl (Ganzzahl), nicht kleiner als 1 oder größer als 100.Maximale Anzahl der erforderlichen Ergebnisse pro Seite. Wenn der Wert nicht angegeben wird, wird der Standardwert auf 25 pro Seite gesetzt.
-
NextToken– UTF-8-Zeichenfolge.Ein Fortsetzungs-Token, wenn dies ein Fortsetzungsaufruf ist.
Antwort
-
Schemas– Ein Array mit SchemaVersionListItem-Objekten.Ein Array von
SchemaVersionList-Objekten, die Details jeder Schemaversion enthalten. -
NextToken– UTF-8-Zeichenfolge.Ein Fortsetzungs-Token zum Paginieren der zurückgegebenen Token-Liste. Wird zurückgegeben, wenn das aktuelle Segment der Liste nicht das letzte ist.
Fehler
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
GetSchemaVersion Aktion (Python: get_schema_version)
Ruft das angegebene Schema anhand seiner eindeutigen ID ab, die zugewiesen wird, wenn eine Version des Schemas erstellt oder registriert wird. Der Status „Deleted“ (Gelöscht) wird nicht in die Ergebnisse aufgenommen.
Anforderung
-
SchemaId– Ein SchemaId-Objekt.Das ist eine Wrapper-Struktur, die Schema-Identitätsfelder enthält. Die Struktur enthält:
-
SchemaId$SchemaArn: Der Amazon-Ressourcenname (ARN) des Schemas. Entweder
SchemaArnoderSchemaNameundRegistryNamemüssen zur Verfügung gestellt werden. -
SchemaId$SchemaName: Der Name des Schemas. Entweder
SchemaArnoderSchemaNameundRegistryNamemüssen zur Verfügung gestellt werden.
-
-
SchemaVersionId– UTF-8-Zeichenfolge, nicht weniger als 36 oder mehr als 36 Bytes lang, passend zum Custom string pattern #44.Die
SchemaVersionIdder Schemaversion. Dieses Feld ist für das Abrufen nach Schema-ID erforderlich. Entweder dies oder derSchemaId-Wrapper muss zur Verfügung gestellt werden. -
SchemaVersionNumber– Ein SchemaVersionNumber-Objekt.Die Versionsnummer des Schemas.
Antwort
-
SchemaVersionId– UTF-8-Zeichenfolge, nicht weniger als 36 oder mehr als 36 Bytes lang, passend zum Custom string pattern #44.Die
SchemaVersionIdder Schemaversion. -
SchemaDefinition– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 170 000 Bytes lang, passend zum Custom string pattern #13.Die Schemadefinition für die Schema-ID.
-
DataFormat– UTF-8-Zeichenfolge (zulässige Werte:AVRO|JSON|PROTOBUF).Das Datenformat der Schemadefinition. Derzeit werden
AVRO,JSONundPROTOBUFunterstützt. -
SchemaArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.Der Amazon-Ressourcenname (ARN) des Schemas.
-
VersionNumber– Zahl (lang), nicht kleiner als 1 oder größer als 100 000.Die Versionsnummer des Schemas.
-
Status– UTF-8-Zeichenfolge (zulässige Werte:AVAILABLE|PENDING|FAILURE|DELETING).Der Status der Schemaversion.
-
CreatedTime– UTF-8-Zeichenfolge.Das Datum und die Uhrzeit, zu denen die Schemaversion erstellt wurde.
Fehler
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
GetSchemaVersionsDiff Aktion (Python: get_schema_versions_diff)
Ruft die Abweichung der Schemaversion im angegebenen Differenztyp zwischen zwei gespeicherten Schemaversionen in der Schema Registry ab.
Mit dieser API können Sie zwei Schemaversionen zwischen zwei Schemadefinitionen unter demselben Schema vergleichen.
Anforderung
-
SchemaId– Erforderlich: Ein SchemaId-Objekt.Das ist eine Wrapper-Struktur, die Schema-Identitätsfelder enthält. Die Struktur enthält:
-
SchemaId$SchemaArn: Der Amazon-Ressourcenname (ARN) des Schemas. Eine
SchemaArnoderSchemaNamemuss angegeben werden. -
SchemaId$SchemaName: Der Name des Schemas. Eine
SchemaArnoderSchemaNamemuss angegeben werden.
-
-
FirstSchemaVersionNumber– Erforderlich: Ein SchemaVersionNumber-Objekt.Die erste der beiden zu vergleichenden Schemaversionen.
-
SecondSchemaVersionNumber– Erforderlich: Ein SchemaVersionNumber-Objekt.Die zweite der beiden zu vergleichenden Schemaversionen.
-
SchemaDiffType– Erforderlich: UTF-8-Zeichenfolge (zulässige Werte:SYNTAX_DIFF).Bezieht sich auf
SYNTAX_DIFF, bei dem es sich um den derzeit unterstützten Differenztyp handelt.
Antwort
-
Diff– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 340 000 Bytes lang, passend zum Custom string pattern #13.Der Unterschied zwischen Schemas als Zeichenfolge im JsonPatch Format.
Fehler
InvalidInputExceptionEntityNotFoundExceptionAccessDeniedExceptionInternalServiceException
ListRegistries Aktion (Python: list_registries)
Gibt eine Liste der von Ihnen erstellten Registrierungen mit minimalen Registrierungsinformationen zurück. Registrierungen im Deleting-Status werden nicht in die Ergebnisse einbezogen. Leere Ergebnisse werden zurückgegeben, wenn keine Registrierungen verfügbar sind.
Anforderung
-
MaxResults– Zahl (Ganzzahl), nicht kleiner als 1 oder größer als 100.Maximale Anzahl der erforderlichen Ergebnisse pro Seite. Wenn der Wert nicht angegeben wird, wird der Standardwert auf 25 pro Seite gesetzt.
-
NextToken– UTF-8-Zeichenfolge.Ein Fortsetzungs-Token, wenn dies ein Fortsetzungsaufruf ist.
Antwort
-
Registries– Ein Array mit RegistryListItem-Objekten.Ein Array von
RegistryDetailedListItem-Objekten, die minimale Details jeder Registrierung enthalten. -
NextToken– UTF-8-Zeichenfolge.Ein Fortsetzungs-Token zum Paginieren der zurückgegebenen Token-Liste. Wird zurückgegeben, wenn das aktuelle Segment der Liste nicht das letzte ist.
Fehler
InvalidInputExceptionAccessDeniedExceptionInternalServiceException
ListSchemas Aktion (Python: list_schemas)
Gibt eine Liste von Schemas mit minimalen Details zurück. Schemas mit dem Status „Deleting“ (Wird gelöscht) werden nicht in die Ergebnisse aufgenommen. Leere Ergebnisse werden zurückgegeben, wenn keine Schemas verfügbar sind.
Wenn die RegistryId nicht angegeben wird, sind alle Schemas in den Registry-Listen Teil der API-Antwort.
Anforderung
-
RegistryId– Ein RegistryId-Objekt.Eine Wrapper-Struktur, die den Registrierungsnamen und den Amazon-Ressourcennamen (ARN) enthält.
-
MaxResults– Zahl (Ganzzahl), nicht kleiner als 1 oder größer als 100.Maximale Anzahl der erforderlichen Ergebnisse pro Seite. Wenn der Wert nicht angegeben wird, wird der Standardwert auf 25 pro Seite gesetzt.
-
NextToken– UTF-8-Zeichenfolge.Ein Fortsetzungs-Token, wenn dies ein Fortsetzungsaufruf ist.
Antwort
-
Schemas– Ein Array mit SchemaListItem-Objekten.Ein Array von
SchemaListItem-Objekten, die Details jedes Schemas enthalten. -
NextToken– UTF-8-Zeichenfolge.Ein Fortsetzungs-Token zum Paginieren der zurückgegebenen Token-Liste. Wird zurückgegeben, wenn das aktuelle Segment der Liste nicht das letzte ist.
Fehler
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
RegisterSchemaVersion Aktion (Python: register_schema_version)
Fügt zum vorhandenen Schema eine neue Version hinzu. Gibt einen Fehler zurück, wenn die neue Version des Schemas die Kompatibilitätsanforderungen des Schemasatzes nicht erfüllt. Diese API erstellt keinen neuen Schemasatz und gibt einen 404-Fehler zurück, wenn der Schemasatz nicht bereits in der Schema Registry vorhanden ist.
Handelt es sich hierbei um die erste Schemadefinition, die in der Schema Registry registriert wird, speichert diese API die Schemaversion und gibt sie sofort zurück. Andernfalls kann dieser Aufruf aufgrund von Kompatibilitätsmodi länger als andere Vorgänge ausgeführt werden. Rufen Sie die GetSchemaVersion-API mit der SchemaVersionId auf, um die Kompatibilitätsmodi zu überprüfen.
Wenn dieselbe Schemadefinition bereits in der Schema Registry als Version gespeichert ist, wird die Schema-ID des vorhandenen Schemas zurückgegeben.
Anforderung
-
SchemaId– Erforderlich: Ein SchemaId-Objekt.Das ist eine Wrapper-Struktur, die Schema-Identitätsfelder enthält. Die Struktur enthält:
-
SchemaId$SchemaArn: Der Amazon-Ressourcenname (ARN) des Schemas. Entweder
SchemaArnoderSchemaNameundRegistryNamemüssen zur Verfügung gestellt werden. -
SchemaId$SchemaName: Der Name des Schemas. Entweder
SchemaArnoderSchemaNameundRegistryNamemüssen zur Verfügung gestellt werden.
-
-
SchemaDefinition– Erforderlich: UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 170 000 Bytes lang, passend zum Custom string pattern #13.Die Schemadefinition, die die
DataFormat-Einstellung fürSchemaNameverwendet.
Antwort
-
SchemaVersionId– UTF-8-Zeichenfolge, nicht weniger als 36 oder mehr als 36 Bytes lang, passend zum Custom string pattern #44.Die eindeutige ID, die die Version dieses Schemas darstellt.
-
VersionNumber– Zahl (lang), nicht kleiner als 1 oder größer als 100 000.Die Version dieses Schemas (nur für den Synchronisierungsfluss, falls es sich um die erste Version handelt).
-
Status– UTF-8-Zeichenfolge (zulässige Werte:AVAILABLE|PENDING|FAILURE|DELETING).Der Status der Schemaversion.
Fehler
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionResourceNumberLimitExceededExceptionConcurrentModificationExceptionInternalServiceException
UpdateSchema Aktion (Python: update_schema)
Aktualisiert die Beschreibung, die Kompatibilitätseinstellung oder den Versionsprüfpunkt für einen Schemasatz.
Beim Aktualisieren der Kompatibilitätseinstellung überprüft der Aufruf nicht die Kompatibilität für den gesamten Satz an Schemaversionen mit der neuen Kompatibilitätseinstellung. Wird der Wert für Compatibility bereitgestellt, wird die VersionNumber (ein Prüfpunkt) ebenfalls benötigt. Die API überprüft die Versionsnummer des Prüfpunkts aus Konsistenzgründen.
Wenn der Wert für die VersionNumber (Prüfpunkt) zur Verfügung gestellt wird, ist Compatibility optional und kann verwendet werden, um einen Prüfpunkt für das Schema festzulegen/zurückzusetzen.
Dieses Update wird nur durchgeführt, wenn sich das Schema im Status AVAILABLE (VERFÜGBAR) befindet.
Anforderung
-
SchemaId– Erforderlich: Ein SchemaId-Objekt.Das ist eine Wrapper-Struktur, die Schema-Identitätsfelder enthält. Die Struktur enthält:
-
SchemaId$SchemaArn: Der Amazon-Ressourcenname (ARN) des Schemas. Eine
SchemaArnoderSchemaNamemuss angegeben werden. -
SchemaId$SchemaName: Der Name des Schemas. Eine
SchemaArnoderSchemaNamemuss angegeben werden.
-
-
SchemaVersionNumber– Ein SchemaVersionNumber-Objekt.Versionsnummer für Prüfpunkt erforderlich. Eine
VersionNumberoderCompatibilitymuss angegeben werden. -
Compatibility– UTF-8-Zeichenfolge (zulässige Werte:NONE|DISABLED|BACKWARD|BACKWARD_ALL|FORWARD|FORWARD_ALL|FULL|FULL_ALL).Die neue Kompatibilitätseinstellung für das Schema.
-
Description– Beschreibende Zeichenfolge, nicht mehr als 2048 Bytes lang, passend zum URI address multi-line string pattern.Die neue Beschreibung für das Schema.
Antwort
-
SchemaArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.Der Amazon-Ressourcenname (ARN) des Schemas.
-
SchemaName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name des Schemas.
-
RegistryName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name der Registrierung, die das Schema enthält
Fehler
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionConcurrentModificationExceptionInternalServiceException
CheckSchemaVersionValidity Aktion (Python: check_schema_version_validity)
Validiert das bereitgestellte Schema. Dieser Aufruf hat keine Nebeneffekte, er validiert einfach nur mit dem bereitgestellten Schema und DataFormat als Format. Da kein Name eines Schemasatzes verwendet wird, werden keine Kompatibilitätsprüfungen durchgeführt.
Anforderung
-
DataFormat– Erforderlich: UTF-8-Zeichenfolge (zulässige Werte:AVRO|JSON|PROTOBUF).Das Datenformat der Schemadefinition. Derzeit werden
AVRO,JSONundPROTOBUFunterstützt. -
SchemaDefinition– Erforderlich: UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 170 000 Bytes lang, passend zum Custom string pattern #13.Die Definition des Schemas, das validiert werden muss.
Antwort
-
Valid– Boolesch.Gibt true zurück, wenn das Schema gültig ist, andernfalls false.
-
Error– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 5 000 Bytes lang.Eine Fehlermeldung für einen Validierungsfehler.
Fehler
InvalidInputExceptionAccessDeniedExceptionInternalServiceException
UpdateRegistry Aktion (Python: update_registry)
Aktualisiert eine vorhandene Registrierung, die zum Speichern einer Sammlung von Schemas verwendet wird. Die aktualisierten Eigenschaften beziehen sich auf die Registrierung und ändern keines der Schemas in der Registrierung.
Anforderung
-
RegistryId– Erforderlich: Ein RegistryId-Objekt.Das ist ein Wrapper-Struktur, die den Registrierungsnamen und den Amazon-Ressourcennamen (ARN) enthält.
-
Description– Erforderlich: Beschreibende Zeichenfolge, nicht mehr als 2 048 Bytes lang, passend zum URI address multi-line string pattern.Eine Beschreibung der Registrierung. Bei keiner Angabe einer Beschreibung wird dieses Feld nicht aktualisiert.
Antwort
-
RegistryName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name der aktualisierten Registrierung.
-
RegistryArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.Der Amazon-Ressourcenname (ARN) der aktualisierten Registrierung.
Fehler
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionConcurrentModificationExceptionInternalServiceException
GetSchemaByDefinition Aktion (Python: get_schema_by_definition)
Ruft ein Schema von der SchemaDefinition ab. Die Schemadefinition wird an die Schema Registry gesendet, kanonisiert und gehasht. Wenn der Hash innerhalb des Bereichs des SchemaName oder ARN (oder der Standardregistrierung, falls keine angegeben ist) abgeglichen wird, werden die Metadaten dieses Schemas zurückgegeben. Andernfalls wird ein 404-Fehler oder ein Fehler zurückgegeben. NotFound Schemaversionen mit dem Status Deleted werden nicht in die Ergebnisse aufgenommen.
Anforderung
-
SchemaId– Erforderlich: Ein SchemaId-Objekt.Das ist eine Wrapper-Struktur, die Schema-Identitätsfelder enthält. Die Struktur enthält:
-
SchemaId$SchemaArn: Der Amazon-Ressourcenname (ARN) des Schemas. Eine
SchemaArnoderSchemaNamemuss angegeben werden. -
SchemaId$SchemaName: Der Name des Schemas. Eine
SchemaArnoderSchemaNamemuss angegeben werden.
-
-
SchemaDefinition– Erforderlich: UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 170 000 Bytes lang, passend zum Custom string pattern #13.Die Definition des Schemas, für das Schemadetails erforderlich sind.
Antwort
-
SchemaVersionId– UTF-8-Zeichenfolge, nicht weniger als 36 oder mehr als 36 Bytes lang, passend zum Custom string pattern #44.Die Schema-ID der Schemaversion.
-
SchemaArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.Der Amazon-Ressourcenname (ARN) des Schemas.
-
DataFormat– UTF-8-Zeichenfolge (zulässige Werte:AVRO|JSON|PROTOBUF).Das Datenformat der Schemadefinition. Derzeit werden
AVRO,JSONundPROTOBUFunterstützt. -
Status– UTF-8-Zeichenfolge (zulässige Werte:AVAILABLE|PENDING|FAILURE|DELETING).Der Status der Schemaversion.
-
CreatedTime– UTF-8-Zeichenfolge.Das Datum und die Uhrzeit, zu denen das Schema erstellt wurde.
Fehler
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
GetRegistry Aktion (Python: get_registry)
Beschreibt die angegebene Registrierung im Detail.
Anforderung
-
RegistryId– Erforderlich: Ein RegistryId-Objekt.Das ist ein Wrapper-Struktur, die den Registrierungsnamen und den Amazon-Ressourcennamen (ARN) enthält.
Antwort
-
RegistryName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name der Registrierung.
-
RegistryArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.Der Amazon-Ressourcenname (ARN) der Registrierung.
-
Description– Beschreibende Zeichenfolge, nicht mehr als 2048 Bytes lang, passend zum URI address multi-line string pattern.Eine Beschreibung der Registrierung.
-
Status– UTF-8-Zeichenfolge (zulässige Werte:AVAILABLE|DELETING).Der Status der Registrierung.
-
CreatedTime– UTF-8-Zeichenfolge.Datum und Uhrzeit der Erstellung der Registrierung.
-
UpdatedTime– UTF-8-Zeichenfolge.Datum und Uhrzeit der Aktualisierung der Registrierung.
Fehler
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundExceptionInternalServiceException
PutSchemaVersionMetadata Aktion (Python: put_schema_version_metadata)
Legt das Metadaten-Schlüssel-Wert-Paar für eine angegebene Schemaversions-ID fest. Pro Schemaversion sind maximal 10 Schlüssel-Wert-Paare zulässig. Sie können über einen oder mehrere Aufrufe hinzugefügt werden.
Anforderung
-
SchemaId– Ein SchemaId-Objekt.Die eindeutige ID für das Schema.
-
SchemaVersionNumber– Ein SchemaVersionNumber-Objekt.Die Versionsnummer des Schemas.
-
SchemaVersionId– UTF-8-Zeichenfolge, nicht weniger als 36 oder mehr als 36 Bytes lang, passend zum Custom string pattern #44.Die eindeutige Versions-ID der Schemaversion.
-
MetadataKeyValue– Erforderlich: Ein MetadataKeyValuePair-Objekt.Der entsprechende Wert eines Metadatenschlüssels.
Antwort
-
SchemaArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.Der Amazon-Ressourcenname (ARN) für das Schema.
-
SchemaName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name des Schemas.
-
RegistryName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name für die Registrierung.
-
LatestVersion– Boolesch.Die neueste Version des Schemas.
-
VersionNumber– Zahl (lang), nicht kleiner als 1 oder größer als 100 000.Die Versionsnummer des Schemas.
-
SchemaVersionId– UTF-8-Zeichenfolge, nicht weniger als 36 oder mehr als 36 Bytes lang, passend zum Custom string pattern #44.Die eindeutige Versions-ID der Schemaversion.
-
MetadataKey– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 128 Bytes lang, passend zum Custom string pattern #14.Der Metadatenschlüssel.
-
MetadataValue– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 256 Bytes lang, passend zum Custom string pattern #14.Der Wert des Metadatenschlüssels.
Fehler
InvalidInputExceptionAccessDeniedExceptionAlreadyExistsExceptionEntityNotFoundExceptionResourceNumberLimitExceededException
QuerySchemaVersionMetadata Aktion (Python: query_schema_version_metadata)
Fragt die Metadateninformationen der Schemaversion ab.
Anforderung
-
SchemaId– Ein SchemaId-Objekt.Eine Wrapper-Struktur, die den Schemanamen und den Amazon-Ressourcennamen (ARN) enthält.
-
SchemaVersionNumber– Ein SchemaVersionNumber-Objekt.Die Versionsnummer des Schemas.
-
SchemaVersionId– UTF-8-Zeichenfolge, nicht weniger als 36 oder mehr als 36 Bytes lang, passend zum Custom string pattern #44.Die eindeutige Versions-ID der Schemaversion.
-
MetadataList– Ein Array mit MetadataKeyValuePair-Objekten.Durchsucht Schlüssel-Wert-Paare nach Metadaten, wenn sie nicht bereitgestellt werden, werden alle Metadateninformationen abgerufen.
-
MaxResults– Zahl (Ganzzahl), nicht kleiner als 1 oder größer als 50.Maximale Anzahl der erforderlichen Ergebnisse pro Seite. Wenn der Wert nicht angegeben wird, wird der Standardwert auf 25 pro Seite gesetzt.
-
NextToken– UTF-8-Zeichenfolge.Ein Fortsetzungs-Token, wenn dies ein Fortsetzungsaufruf ist.
Antwort
-
MetadataInfoMap– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 128 Bytes lang, und entspricht dem Custom string pattern #14.
Jeder Wert ist ein A MetadataInfo-Objekt.
Die Zuordnung eines Metadatenschlüssels und der zugehörigen Werte.
-
SchemaVersionId– UTF-8-Zeichenfolge, nicht weniger als 36 oder mehr als 36 Bytes lang, passend zum Custom string pattern #44.Die eindeutige Versions-ID der Schemaversion.
-
NextToken– UTF-8-Zeichenfolge.Ein Fortsetzungs-Token zum Paginieren der zurückgegebenen Token-Liste. Wird zurückgegeben, wenn das aktuelle Segment der Liste nicht das letzte ist.
Fehler
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundException
RemoveSchemaVersionMetadata Aktion (Python: remove_schema_version_metadata)
Entfernt ein Schlüssel-Wert-Paar aus den Metadaten der Schemaversion für die angegebene Schemaversions-ID.
Anforderung
-
SchemaId– Ein SchemaId-Objekt.Eine Wrapper-Struktur, die den Schemanamen und den Amazon-Ressourcennamen (ARN) enthält.
-
SchemaVersionNumber– Ein SchemaVersionNumber-Objekt.Die Versionsnummer des Schemas.
-
SchemaVersionId– UTF-8-Zeichenfolge, nicht weniger als 36 oder mehr als 36 Bytes lang, passend zum Custom string pattern #44.Die eindeutige Versions-ID der Schemaversion.
-
MetadataKeyValue– Erforderlich: Ein MetadataKeyValuePair-Objekt.Der Wert des Metadatenschlüssels.
Antwort
-
SchemaArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.Der Amazon-Ressourcenname (ARN) des Schemas.
-
SchemaName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name des Schemas.
-
RegistryName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name der Registrierung.
-
LatestVersion– Boolesch.Die neueste Version des Schemas.
-
VersionNumber– Zahl (lang), nicht kleiner als 1 oder größer als 100 000.Die Versionsnummer des Schemas.
-
SchemaVersionId– UTF-8-Zeichenfolge, nicht weniger als 36 oder mehr als 36 Bytes lang, passend zum Custom string pattern #44.Die Versions-ID für die Schemaversion.
-
MetadataKey– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 128 Bytes lang, passend zum Custom string pattern #14.Der Metadatenschlüssel.
-
MetadataValue– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 256 Bytes lang, passend zum Custom string pattern #14.Der Wert des Metadatenschlüssels.
Fehler
InvalidInputExceptionAccessDeniedExceptionEntityNotFoundException
DeleteRegistry Aktion (Python: delete_registry)
Löscht die gesamte Registrierung einschließlich Schema und aller Versionen. Um den Status des Löschvorgangs zu erhalten, können Sie die GetRegistry-API nach dem asynchronen Aufruf aufrufen. Durch das Löschen einer Registrierung werden alle Online-Operationen für die Registrierung deaktiviert, z. B. dasUpdateRegistry,CreateSchema, UpdateSchema und. RegisterSchemaVersion APIs
Anforderung
-
RegistryId– Erforderlich: Ein RegistryId-Objekt.Das ist ein Wrapper-Struktur, die den Registrierungsnamen und den Amazon-Ressourcennamen (ARN) enthält.
Antwort
-
RegistryName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name der Registrierung, die gelöscht wird.
-
RegistryArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.Der Amazon-Ressourcenname (ARN) der zu löschenden Registrierung.
-
Status– UTF-8-Zeichenfolge (zulässige Werte:AVAILABLE|DELETING).Der Status der Registrierung. Ein erfolgreicher Vorgang gibt den Status
Deletingzurück.
Fehler
InvalidInputExceptionEntityNotFoundExceptionAccessDeniedExceptionConcurrentModificationException
DeleteSchema Aktion (Python: delete_schema)
Löscht den gesamten Schemasatz, einschließlich des Schemasatzes und aller zugehörigen Versionen. Um den Status des Löschvorgangs zu erhalten, können Sie GetSchema-API nach dem asynchronen Aufruf aufrufen. Durch das Löschen einer Registrierung werden alle Online-Operationen für das Schema deaktiviert, z. B. dasGetSchemaByDefinition, und. RegisterSchemaVersion APIs
Anforderung
-
SchemaId– Erforderlich: Ein SchemaId-Objekt.Das ist eine Wrapper-Struktur, die den Schemanamen und den Amazon-Ressourcennamen (ARN) enthält.
Antwort
-
SchemaArn– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 10 240 Bytes lang, passend zum Custom string pattern #49.Der Amazon-Ressourcenname (ARN) des zu löschenden Schemas.
-
SchemaName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Custom string pattern #45.Der Name des Schemas, das gelöscht wird.
-
Status– UTF-8-Zeichenfolge (zulässige Werte:AVAILABLE|PENDING|DELETING).Der Status des Schemas.
Fehler
InvalidInputExceptionEntityNotFoundExceptionAccessDeniedExceptionConcurrentModificationException
DeleteSchemaVersions Aktion (Python: delete_schema_versions)
Entfernt Versionen aus dem angegebenen Schema. Eine Versionsnummer oder ein Bereich kann angegeben werden. Wenn der Kompatibilitätsmodus das Löschen einer benötigten Version wie BACKWARDS_FULL (ABWÄRTS_VOLL) verbietet, wird ein Fehler zurückgegeben. Das Aufrufen der GetSchemaVersions-API nach diesem Aufruf listet den Status der gelöschten Versionen auf.
Wenn der Bereich der Versionsnummern eine Version mit Prüfpunkt enthält, gibt die API einen 409-Konflikt zurück und fährt nicht mit dem Löschen fort. Sie müssen den Prüfpunkt zuerst mit der DeleteSchemaCheckpoint-API entfernen, bevor Sie diese API verwenden können.
Sie können mit der DeleteSchemaVersions-API nicht die erste Schemaversion im Schemasatz löschen. Die erste Schemaversion kann nur durch die DeleteSchema-API gelöscht werden. Dieser Vorgang löscht auch die unter den Schemaversionen angehängten SchemaVersionMetadata. Feste Löschungen werden für die Datenbank erzwungen.
Wenn der Kompatibilitätsmodus das Löschen einer benötigten Version wie BACKWARDS_FULL (ABWÄRTS_VOLL) verbietet, wird ein Fehler zurückgegeben.
Anforderung
-
SchemaId– Erforderlich: Ein SchemaId-Objekt.Das ist eine Wrapper-Struktur, die den Schemanamen und den Amazon-Ressourcennamen (ARN) enthält.
-
Versions– Erforderlich: UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 100 000 Bytes lang, passend zum Custom string pattern #15.Es kann ein Versionsbereich im folgenden Format angegeben werden:
-
eine einzelne Versionsnummer, 5
-
ein Bereich, 5-8: löscht die Versionen 5, 6, 7, 8
-
Antwort
-
SchemaVersionErrors– Ein Array mit SchemaVersionErrorItem-Objekten.Eine Liste von
SchemaVersionErrorItem-Objekten, die jeweils eine Fehler- und Schemaversion enthalten.
Fehler
InvalidInputExceptionEntityNotFoundExceptionAccessDeniedExceptionConcurrentModificationException
