スキーマレジストリ - AWS Glue
 – データ型 –RegistryIdRegistryListItemMetadataInfoOtherMetadataValueListItemSchemaListItemSchemaVersionListItemMetadataKeyValuePairSchemaVersionErrorItemErrorDetailsSchemaVersionNumberSchemaId —  操作  —CreateRegistry (create_registry)CreateSchema (create_schema)GetSchema (get_schema)ListSchemaVersions (list_schema_versions)GetSchemaVersion (get_schema_version)GetSchemaVersionsDiff (get_schema_versions_diff)ListRegistries (list_registries)ListSchemas (list_schemas)RegisterSchemaVersion (register_schema_version)UpdateSchema (update_schema)CheckSchemaVersionValidity (check_schema_version_validity)UpdateRegistry (update_registry)GetSchemaByDefinition (get_schema_by_definition)GetRegistry (get_registry)PutSchemaVersionMetadata (put_schema_version_metadata)QuerySchemaVersionMetadata (query_schema_version_metadata)RemoveSchemaVersionMetadata (remove_schema_version_metadata)DeleteRegistry (delete_registry)DeleteSchema (delete_schema)DeleteSchemaVersions (delete_schema_versions)

スキーマレジストリ

スキーマレジストリ API では、AWS Glue でのスキーマの操作に関連するデータ型と API について説明します。

データ型

RegistryId 構造

レジストリ名と Amazon リソースネーム (ARN) を含むことができるラッパー構造体。

フィールド

  • RegistryName – UTF-8 文字列、1～255 バイト長、Custom string pattern #18 に一致。

    レジストリの名前。ルックアップにのみ使用されます。RegistryArn または RegistryName のいずれかを指定する必要があります。

  • RegistryArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    更新するレジストリの ARN。RegistryArn または RegistryName のいずれかを指定する必要があります。

RegistryListItem 構造

レジストリの詳細を含む構造。

フィールド

  • RegistryName – UTF-8 文字列、1～255 バイト長、Custom string pattern #18 に一致。

    レジストリの名前。

  • RegistryArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    レジストリの Amazon リソースネーム (ARN)

  • Description – 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。

    レジストリの説明。

  • Status – UTF-8 文字列 (有効な値: AVAILABLE | DELETING)。

    レジストリのステータス。

  • CreatedTime – UTF-8 文字列。

    レジストリが作成されたデータ。

  • UpdatedTime – UTF-8 文字列。

    レジストリが更新された日付。

MetadataInfo 構造

スキーマバージョンのメタデータ情報を含む構造。

フィールド

  • MetadataValue – UTF-8 文字列。1～256 バイト長。Custom string pattern #34 に一致。

    メタデータキーの対応する値。

  • CreatedTime – UTF-8 文字列。

    エントリの作成時刻。

  • OtherMetadataValueList – OtherMetadataValueListItem オブジェクトの配列。

    同じメタデータキーに属する他のメタデータ。

OtherMetadataValueListItem 構造

同じメタデータキーに属するスキーマバージョンの他のメタデータが含まれる構造。

フィールド

  • MetadataValue – UTF-8 文字列。1～256 バイト長。Custom string pattern #34 に一致。

    同じメタデータキーに属する他のメタデータ用の、それらに対応したメタデータキーの値。

  • CreatedTime – UTF-8 文字列。

    エントリの作成時刻。

SchemaListItem 構造

スキーマに対する最小限の詳細が含まれるオブジェクト。

フィールド

  • RegistryName – UTF-8 文字列、1～255 バイト長、Custom string pattern #18 に一致。

    スキーマが存在するレジストリの名前。

  • SchemaName – UTF-8 文字列、1～255 バイト長、Custom string pattern #18 に一致。

    スキーマの名前。

  • SchemaArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    スキーマの Amazon リソースネーム (ARN)。

  • Description – 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。

    スキーマの説明。

  • SchemaStatus – UTF-8 文字列 (有効な値: AVAILABLE | PENDING | DELETING)。

    スキーマのステータス。

  • CreatedTime – UTF-8 文字列。

    スキーマが作成された日時。

  • UpdatedTime – UTF-8 文字列。

    スキーマが更新された日時。

SchemaVersionListItem 構造

スキーマのバージョンに関する詳細を含むオブジェクト。

フィールド

  • SchemaArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    スキーマの Amazon リソースネーム (ARN)。

  • SchemaVersionId – UTF-8 文字列。36 バイト長ちょうど。Custom string pattern #17 に一致。

    スキーマバージョンの一意の識別子。

  • VersionNumber – 数値 (long)。1～100000。

    スキーマのバージョン番号。

  • Status – UTF-8 文字列 (有効な値: AVAILABLE | PENDING | FAILURE | DELETING)。

    スキーマバージョンのステータス。

  • CreatedTime – UTF-8 文字列。

    スキーマバージョンが作成された日時。

MetadataKeyValuePair 構造

メタデータのキーバリューペアが含まれる構造。

フィールド

  • MetadataKey – UTF-8 文字列。1～128 バイト長。Custom string pattern #34 に一致。

    メタデータキー。

  • MetadataValue – UTF-8 文字列。1～256 バイト長。Custom string pattern #34 に一致。

    メタデータキーの対応する値。

SchemaVersionErrorItem 構造

スキーマバージョンに対するオペレーションに対するエラーの詳細が含まれるオブジェクト。

フィールド

  • VersionNumber – 数値 (long)。1～100000。

    スキーマのバージョン番号。

  • ErrorDetails – ErrorDetails オブジェクト。

    スキーマバージョンのエラーの詳細。

ErrorDetails 構造

エラーの詳細を含むオブジェクト。

フィールド

  • ErrorCode – UTF-8 文字列。

    エラーのエラーコード。

  • ErrorMessage – UTF-8 文字列。

    エラーのエラーメッセージ。

SchemaVersionNumber 構造

スキーマのバージョン情報を含む構造。

フィールド

  • LatestVersion – ブール。

    スキーマで利用可能な最新バージョン。

  • VersionNumber – 数値 (long)。1～100000。

    スキーマのバージョン番号。

SchemaId 構造

AWS Glue スキーマレジストリ内のスキーマの一意の ID。

フィールド

  • SchemaArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    スキーマの Amazon リソースネーム (ARN)。SchemaArn または SchemaName のいずれかを指定する必要があります。

  • SchemaName – UTF-8 文字列、1～255 バイト長、Custom string pattern #18 に一致。

    スキーマの名前。SchemaArn または SchemaName のいずれかを指定する必要があります。

  • RegistryName – UTF-8 文字列、1～255 バイト長、Custom string pattern #18 に一致。

    スキーマを含むスキーマレジストリの名前。

操作

CreateRegistry アクション (Python: create_registry)

スキーマのコレクションを保持するために使用できる新しいレジストリを作成します。

リクエスト

  • RegistryName – 必須: UTF-8 文字列、1～255 バイト長、「Custom string pattern #18」に一致。

    作成するスキーマの名前の最大長は 255 で、英字、数字、ハイフン、アンダースコア、ドル記号、ハッシュ記号のみを使用できます。空白はありません。

  • Description – 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。

    レジストリの説明。説明がない場合、これに対するデフォルト値はありません。

  • Tags – キーと値のペアのマップ配列。50 ペア以下。

    各キーは UTF-8 文字列で、1～128 バイト長です。

    各値は UTF-8 文字列で、256 バイト長以下です。

    キーと値のペアを含み、コンソール、コマンドライン、または API で検索できる AWS タグ。

レスポンス

  • RegistryArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    新たに作成されたレジストリの Amazon リソースネーム (ARN)。

  • RegistryName – UTF-8 文字列、1～255 バイト長、Custom string pattern #18 に一致。

    レジストリの名前。

  • Description – 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。

    レジストリの説明。

  • Tags – キーと値のペアのマップ配列。50 ペア以下。

    各キーは UTF-8 文字列で、1～128 バイト長です。

    各値は UTF-8 文字列で、256 バイト長以下です。

    レジストリのタグ。

エラー

  • InvalidInputException

  • AccessDeniedException

  • AlreadyExistsException

  • ResourceNumberLimitExceededException

  • ConcurrentModificationException

  • InternalServiceException

CreateSchema アクション (Python: create_schema)

新しいスキーマセットを作成し、スキーマ定義を登録します。スキーマセットがすでに存在する場合は、実際にバージョンを登録せずにエラーを返します。

スキーマセットが作成されると、バージョンチェックポイントが最初のバージョンに設定されます。互換モードが「DISABLED」であると、最初のスキーマバージョンの後に追加のスキーマバージョンが追加されないように制限されます。他のすべての互換モードでは、RegisterSchemaVersion API が使用された場合、2 番目以降のバージョンでのみ互換性設定の検証が適用されます。

この API が RegistryId なしで呼び出されたとき、レジストリデータベーステーブルに「default-registry」のエントリがまだ存在しなければ、エントリが作成されます。

リクエスト

  • RegistryId – RegistryId オブジェクト。

    これは、レジストリ ID フィールドを含むラッパー図形です。これを指定しない場合、デフォルトのレジストリが使用されます。同じものの ARN 形式は次のようになります: arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id。

  • SchemaName – 必須: UTF-8 文字列、1～255 バイト長、Custom string pattern #18 に一致。

    作成するスキーマの名前の最大長は 255 で、文字、数字、ハイフン、アンダースコア、ドル記号、またはハッシュ記号のみを使用できます。空白はありません。

  • DataFormat – 必須: UTF-8 文字列 (有効な値: AVRO | JSON | PROTOBUF)。

    スキーマ定義のデータ形式。現在サポートされている形式は、AVRO、JSON、および PROTOBUF です。

  • Compatibility – UTF-8 文字列 (有効な値: NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL)。

    スキーマの互換モード。指定できる値は以下のとおりです。

    • NONE: 互換モードは適用されません。この選択は、開発シナリオで使用するか、スキーマに適用する互換モードがわからない場合に使用できます。新しいバージョンが追加されたとき、互換性チェックを受けずに受け入れられます。

    • DISABLED: 互換性についてこの選択をすると、特定のスキーマのバージョン管理が不要になります。この選択を使用して、スキーマの今後のバージョン管理を不要にできます。

    • BACKWARD: データ受信者が現在のスキーマバージョンと直前のスキーマバージョンの両方を読み取ることができるため、この互換性の選択をお勧めします。つまり、例えば、以前のバージョンを使用して読み取れなくならないように、新しいスキーマバージョンでデータフィールドを削除したり、これらのフィールドのタイプを変更したりできなくなります。

    • BACKWARD_ALL: この互換性の選択により、データ受信者は、現在および以前のすべてのスキーマバージョンの両方を読み取ることができます。この選択は、フィールドを削除したり、オプションのフィールドを追加したり、以前のすべてのスキーマバージョンとの互換性を確認する必要がある場合に使用できます。

    • FORWARD: この互換性の選択により、データ受信者は、現在のスキーマバージョンとすぐ次のスキーマバージョンの両方を読み取ることができますが、それより後のバージョンは必ずしも読み取れません。この選択は、フィールドを追加したり、オプションフィールドを削除したりする必要があり、最後のスキーマバージョンとの互換性だけをチェックする必要がある場合に使用できます。

    • FORWARD_ALL: この互換性の選択により、データ受信者は、新しく登録されるすべてのスキーマのプロデューサーによって書き込まれたデータを読み取ることができます。この選択は、フィールドを追加したり、オプションフィールドを削除したり、以前のすべてのスキーマバージョンとの互換性を確認したりする必要がある場合に使用できます。

    • FULL: この互換性の選択により、データ受信者は、スキーマの直前または直後のバージョンを使用してプロデューサーによって書き込まれたデータを読み取ることができますが、それより前または後のバージョンは必ずしも読み取れません。この選択は、オプションフィールドを追加または削除する必要があり、最後のスキーマバージョンとの互換性だけをチェックする必要がある場合に使用できます。

    • FULL_ALL: この互換性の選択により、データ受信者は、すべての以前のスキーマバージョンを使用してプロデューサーによって書き込まれたデータを読み取ることができます。この選択は、オプションのフィールドを追加または削除したり、以前のすべてのスキーマバージョンとの互換性を確認したりする必要がある場合に使用できます。

  • Description – 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。

    スキーマの説明 (省略可能)。説明がない場合、これに自動的に適用されるデフォルト値はありません。

  • Tags – キーと値のペアのマップ配列。50 ペア以下。

    各キーは UTF-8 文字列で、1～128 バイト長です。

    各値は UTF-8 文字列で、256 バイト長以下です。

    キーと値のペアを含み、コンソール、コマンドライン、または API で検索できる AWS タグ。指定した場合、AWS tags-on-create パターンに従います。

  • SchemaDefinition – UTF-8 文字列。1～170000 バイト長。Custom string pattern #33 に一致。

    SchemaName の DataFormat 設定を使用したスキーマ定義。

レスポンス

  • RegistryName – UTF-8 文字列、1～255 バイト長、「Custom string pattern #18」に一致。

    レジストリの名前。

  • RegistryArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    レジストリの Amazon リソースネーム (ARN)

  • SchemaName – UTF-8 文字列、1～255 バイト長、Custom string pattern #18 に一致。

    スキーマの名前。

  • SchemaArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    スキーマの Amazon リソースネーム (ARN)。

  • Description – 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。

    スキーマの説明 (作成時に指定されている場合)。

  • DataFormat – UTF-8 文字列 (有効な値: AVRO | JSON | PROTOBUF)。

    スキーマ定義のデータ形式。現在サポートされている形式は、AVRO、JSON、および PROTOBUF です。

  • Compatibility – UTF-8 文字列 (有効な値: NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL)。

    スキーマの互換モード。

  • SchemaCheckpoint – 数値 (long)。1～100000。

    チェックポイントのバージョン番号 (互換モードが最後に変更されたときの変更回数)。

  • LatestSchemaVersion – 数値 (long)。1～100000。

    返されるスキーマ定義に関連付けられたスキーマの最新バージョン。

  • NextSchemaVersion – 数値 (long)。1～100000。

    返されたスキーマ定義に関連付けられたスキーマの次のバージョン。

  • SchemaStatus – UTF-8 文字列 (有効な値: AVAILABLE | PENDING | DELETING)。

    スキーマのステータス。

  • Tags – キーと値のペアのマップ配列。50 ペア以下。

    各キーは UTF-8 文字列で、1～128 バイト長です。

    各値は UTF-8 文字列で、256 バイト長以下です。

    スキーマのタグ。

  • SchemaVersionId – UTF-8 文字列。36 バイト長ちょうど。Custom string pattern #17 に一致。

    最初のスキーマバージョンの一意の識別子。

  • SchemaVersionStatus – UTF-8 文字列 (有効な値: AVAILABLE | PENDING | FAILURE | DELETING)。

    最初に作成されたスキーマバージョンのステータス。

エラー

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • AlreadyExistsException

  • ResourceNumberLimitExceededException

  • ConcurrentModificationException

  • InternalServiceException

GetSchema アクション (Python: get_schema)

指定されたスキーマについて詳細に説明します。

リクエスト

  • SchemaId – 必須: SchemaId オブジェクト。

    スキーマ ID フィールドを含むラッパー構造体です。構造体には以下が含まれています。

    • SchemaId$SchemaArn: スキーマの Amazon リソースネーム (ARN)。SchemaArn または SchemaName、および RegistryName を指定する必要があります。

    • SchemaId$SchemaName: スキーマの名前。SchemaArn または SchemaName、および RegistryName を指定する必要があります。

レスポンス

  • RegistryName – UTF-8 文字列、1～255 バイト長、「Custom string pattern #18」に一致。

    レジストリの名前。

  • RegistryArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    レジストリの Amazon リソースネーム (ARN)

  • SchemaName – UTF-8 文字列、1～255 バイト長、Custom string pattern #18 に一致。

    スキーマの名前。

  • SchemaArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    スキーマの Amazon リソースネーム (ARN)。

  • Description – 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。

    スキーマの説明 (作成時に指定されている場合)。

  • DataFormat – UTF-8 文字列 (有効な値: AVRO | JSON | PROTOBUF)。

    スキーマ定義のデータ形式。現在サポートされている形式は、AVRO、JSON、および PROTOBUF です。

  • Compatibility – UTF-8 文字列 (有効な値: NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL)。

    スキーマの互換モード。

  • SchemaCheckpoint – 数値 (long)。1～100000。

    チェックポイントのバージョン番号 (互換モードが最後に変更されたときの変更回数)。

  • LatestSchemaVersion – 数値 (long)。1～100000。

    返されるスキーマ定義に関連付けられたスキーマの最新バージョン。

  • NextSchemaVersion – 数値 (long)。1～100000。

    返されたスキーマ定義に関連付けられたスキーマの次のバージョン。

  • SchemaStatus – UTF-8 文字列 (有効な値: AVAILABLE | PENDING | DELETING)。

    スキーマのステータス。

  • CreatedTime – UTF-8 文字列。

    スキーマが作成された日時。

  • UpdatedTime – UTF-8 文字列。

    スキーマが更新された日時。

エラー

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

ListSchemaVersions アクション (Python: list_schema_versions)

作成したスキーマバージョンのリストを、最小限の情報とともに返します。Deleted ステータスのスキーマのバージョンは、結果に含まれません。使用可能なスキーマバージョンがない場合、空の結果が返されます。

リクエスト

  • SchemaId – 必須: SchemaId オブジェクト。

    スキーマ ID フィールドを含むラッパー構造体です。構造体には以下が含まれています。

    • SchemaId$SchemaArn: スキーマの Amazon リソースネーム (ARN)。SchemaArn または SchemaName、および RegistryName を指定する必要があります。

    • SchemaId$SchemaName: スキーマの名前。SchemaArn または SchemaName、および RegistryName を指定する必要があります。

  • MaxResults – 数値 (integer)。1～100。

    1 ページあたりに必要な結果の最大数。値が指定されていない場合、これはデフォルトで 1 ページあたり 25 に設定されます。

  • NextToken – UTF-8 文字列。

    継続トークン (これが継続呼び出しの場合)。

応答

  • Schemas – SchemaVersionListItem オブジェクトの配列。

    各スキーマのバージョンの詳細を含む SchemaVersionList オブジェクトの配列。

  • NextToken – UTF-8 文字列。

    返されたトークンのリストをページ分割するための継続トークン。リストの現在のセグメントが最後のセグメントではない場合に返されます。

エラー

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

GetSchemaVersion アクション (Python: get_schema_version)

スキーマのバージョンの作成または登録時に割り当てられた一意の ID によって指定されたスキーマを取得します。Deleted ステータスのスキーマのバージョンは、結果に含まれません。

リクエスト

  • SchemaId – SchemaId オブジェクト。

    スキーマ ID フィールドを含むラッパー構造体です。構造体には以下が含まれています。

    • SchemaId$SchemaArn: スキーマの Amazon リソースネーム (ARN)。SchemaArn または SchemaName、および RegistryName を指定する必要があります。

    • SchemaId$SchemaName: スキーマの名前。SchemaArn または SchemaName、および RegistryName を指定する必要があります。

  • SchemaVersionId – UTF-8 文字列。36 バイト長ちょうど。Custom string pattern #17 に一致。

    スキーマバージョンの SchemaVersionId。このフィールドは、スキーマ ID による取得に必須です。このスキーマ ID か SchemaId ラッパーのいずれかを指定する必要があります。

  • SchemaVersionNumber – SchemaVersionNumber オブジェクト。

    スキーマのバージョン番号。

レスポンス

  • SchemaVersionId – UTF-8 文字列。36 バイト長ちょうど。Custom string pattern #17 に一致。

    スキーマバージョンの SchemaVersionId。

  • SchemaDefinition – UTF-8 文字列。1～170000 バイト長。Custom string pattern #33 に一致。

    スキーマ ID のスキーマ定義。

  • DataFormat – UTF-8 文字列 (有効な値: AVRO | JSON | PROTOBUF)。

    スキーマ定義のデータ形式。現在サポートされている形式は、AVRO、JSON、および PROTOBUF です。

  • SchemaArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    スキーマの Amazon リソースネーム (ARN)。

  • VersionNumber – 数値 (long)。1～100000。

    スキーマのバージョン番号。

  • Status – UTF-8 文字列 (有効な値: AVAILABLE | PENDING | FAILURE | DELETING)。

    スキーマバージョンのステータス。

  • CreatedTime – UTF-8 文字列。

    スキーマバージョンが作成された日時。

エラー

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

GetSchemaVersionsDiff アクション (Python: get_schema_versions_diff)

スキーマレジストリに格納された 2 つのスキーマバージョン間で、指定された差分タイプによるスキーマバージョンの差分を取得します。

この API を使用すると、同じスキーマの下にある 2 つのスキーマ定義間で 2 つのスキーマバージョンを比較できます。

リクエスト

  • SchemaId – 必須: SchemaId オブジェクト。

    スキーマ ID フィールドを含むラッパー構造体です。構造体には以下が含まれています。

    • SchemaId$SchemaArn: スキーマの Amazon リソースネーム (ARN)。SchemaArn または SchemaName のいずれかを指定する必要があります。

    • SchemaId$SchemaName: スキーマの名前。SchemaArn または SchemaName のいずれかを指定する必要があります。

  • FirstSchemaVersionNumber – 必須: SchemaVersionNumber オブジェクト。

    比較する 2 つのスキーマバージョンのうち、1 番目のスキーマバージョンです。

  • SecondSchemaVersionNumber – 必須: SchemaVersionNumber オブジェクト。

    比較する 2 つのスキーマバージョンのうち、2 番目のスキーマバージョンです。

  • SchemaDiffType – 必須: UTF-8 文字列 (有効な値: SYNTAX_DIFF)。

    現在サポートされている差分タイプである SYNTAX_DIFF が参照されます。

レスポンス

  • Diff – UTF-8 文字列。1～340000 バイト長。Custom string pattern #33 に一致。

    JsonPatch 形式の文字列としてのスキーマの違い。

エラー

  • InvalidInputException

  • EntityNotFoundException

  • AccessDeniedException

  • InternalServiceException

ListRegistries アクション (Python: list_registries)

作成したレジストリの一覧を、最小限のレジストリ情報とともに返します。Deleting ステータスのレジストリは結果に含まれません。利用可能なレジストリがない場合、空の結果が返されます。

リクエスト

  • MaxResults – 数値 (integer)。1～100。

    1 ページあたりに必要な結果の最大数。値が指定されていない場合、これはデフォルトで 1 ページあたり 25 に設定されます。

  • NextToken – UTF-8 文字列。

    継続トークン (これが継続呼び出しの場合)。

応答

  • Registries – RegistryListItem オブジェクトの配列。

    各レジストリの最小の詳細を含む RegistryDetailedListItem オブジェクトの配列。

  • NextToken – UTF-8 文字列。

    返されたトークンのリストをページ分割するための継続トークン。リストの現在のセグメントが最後のセグメントではない場合に返されます。

エラー

  • InvalidInputException

  • AccessDeniedException

  • InternalServiceException

ListSchemas アクション (Python: list_schemas)

スキーマのリストを最小限の詳細とともに返します。Deleting ステータスのスキーマは結果に含まれません。使用可能なスキーマがない場合、空の結果が返されます。

RegistryId が指定されていない場合、レジストリ間のすべてのスキーマは API レスポンスの一部になります。

リクエスト

  • RegistryId – RegistryId オブジェクト。

    レジストリ名と Amazon リソースネーム (ARN) を含むことができるラッパー構造体。

  • MaxResults – 数値 (integer)。1～100。

    1 ページあたりに必要な結果の最大数。値が指定されていない場合、これはデフォルトで 1 ページあたり 25 に設定されます。

  • NextToken – UTF-8 文字列。

    継続トークン (これが継続呼び出しの場合)。

応答

  • Schemas – SchemaListItem オブジェクトの配列。

    各スキーマの詳細を含む SchemaListItem オブジェクトの配列。

  • NextToken – UTF-8 文字列。

    返されたトークンのリストをページ分割するための継続トークン。リストの現在のセグメントが最後のセグメントではない場合に返されます。

エラー

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

RegisterSchemaVersion アクション (Python: register_schema_version)

既存のスキーマに新しいバージョンを追加します。スキーマの新しいバージョンがスキーマセットの互換性要件を満たしていない場合、エラーを返します。この API では、スキーマセットがまだスキーマレジストリに存在しない場合、新しいスキーマセットは作成されず、404 エラーが返されます。

これがスキーマレジストリに登録される最初のスキーマ定義である場合、この API はスキーマバージョンを保存し、すぐに戻ります。それ以外の場合、この呼び出しは、互換モードのために他のオペレーションよりも長時間実行される可能性があります。SchemaVersionId を使用して GetSchemaVersion API を呼び出して、互換モードをチェックできます。

同じスキーマ定義がすでにバージョンとして Schema Registry に格納されている場合は、既存のスキーマのスキーマ ID が呼び出し元に返されます。

リクエスト

  • SchemaId – 必須: SchemaId オブジェクト。

    スキーマ ID フィールドを含むラッパー構造体です。構造体には以下が含まれています。

    • SchemaId$SchemaArn: スキーマの Amazon リソースネーム (ARN)。SchemaArn または SchemaName、および RegistryName を指定する必要があります。

    • SchemaId$SchemaName: スキーマの名前。SchemaArn または SchemaName、および RegistryName を指定する必要があります。

  • SchemaDefinition – 必須: UTF-8 文字列。1～170000 バイト長。Custom string pattern #33 に一致。

    SchemaName の DataFormat 設定を使用したスキーマ定義。

レスポンス

  • SchemaVersionId – UTF-8 文字列。36 バイト長ちょうど。Custom string pattern #17 に一致。

    このスキーマのバージョンを表す一意の ID。

  • VersionNumber – 数値 (long)。1～100000。

    このスキーマのバージョン (これが最初のバージョンの場合、同期フローのみ)。

  • Status – UTF-8 文字列 (有効な値: AVAILABLE | PENDING | FAILURE | DELETING)。

    スキーマバージョンのステータス。

エラー

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • ResourceNumberLimitExceededException

  • ConcurrentModificationException

  • InternalServiceException

UpdateSchema アクション (Python: update_schema)

スキーマセットの説明、互換性設定、またはバージョンチェックポイントを更新します。

互換性設定を更新する場合、その呼び出しでは、新しい互換性設定を持つスキーマバージョンのセット全体の互換性は検証されません。Compatibility の値が指定されている場合、VersionNumber (チェックポイント) も指定する必要があります。APIは、整合性のためにチェックポイントのバージョン番号を検証します。

VersionNumber (チェックポイント) の値が指定されている場合、Compatibility はオプションであり、スキーマのチェックポイントを設定/リセットするために使用できます。

この更新は、スキーマが AVAILABLE 状態である場合にのみ発生します。

リクエスト

  • SchemaId – 必須: SchemaId オブジェクト。

    スキーマ ID フィールドを含むラッパー構造体です。構造体には以下が含まれています。

    • SchemaId$SchemaArn: スキーマの Amazon リソースネーム (ARN)。SchemaArn または SchemaName のいずれかを指定する必要があります。

    • SchemaId$SchemaName: スキーマの名前。SchemaArn または SchemaName のいずれかを指定する必要があります。

  • SchemaVersionNumber – SchemaVersionNumber オブジェクト。

    チェックポイントに必要なバージョン番号。VersionNumber または Compatibility のいずれかを指定する必要があります。

  • Compatibility – UTF-8 文字列 (有効な値: NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL)。

    スキーマの新しい互換性設定。

  • Description – 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。

    スキーマの新しい説明。

レスポンス

  • SchemaArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    スキーマの Amazon リソースネーム (ARN)。

  • SchemaName – UTF-8 文字列、1～255 バイト長、Custom string pattern #18 に一致。

    スキーマの名前。

  • RegistryName – UTF-8 文字列、1～255 バイト長、Custom string pattern #18 に一致。

    スキーマを含むレジストリの名前。

エラー

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • ConcurrentModificationException

  • InternalServiceException

CheckSchemaVersionValidity アクション (Python: check_schema_version_validity)

指定されたスキーマを検証します。この呼び出しには副作用はなく、指定されたスキーマを使用して DataFormat を形式として使用して単に検証します。スキーマセット名を取らないため、互換性チェックは実行されません。

リクエスト

  • DataFormat – 必須: UTF-8 文字列 (有効な値: AVRO | JSON | PROTOBUF)。

    スキーマ定義のデータ形式。現在サポートされている形式は、AVRO、JSON、および PROTOBUF です。

  • SchemaDefinition – 必須: UTF-8 文字列。1～170000 バイト長。Custom string pattern #33 に一致。

    検証する必要があるスキーマの定義。

レスポンス

  • Valid – ブール。

    スキーマが有効な場合は true を返し、そうでない場合は false を返します。

  • Error – UTF-8 文字列。1～5000 バイト長。

    検証失敗のエラーメッセージ。

エラー

  • InvalidInputException

  • AccessDeniedException

  • InternalServiceException

UpdateRegistry アクション (Python: update_registry)

スキーマのコレクションを保持するために使用される既存のレジストリを更新します。更新されたプロパティはレジストリに関連づけられており、レジストリ内のスキーマは変更されません。

リクエスト

  • RegistryId – 必須: RegistryId オブジェクト。

    これは、レジストリ名と Amazon リソースネーム (ARN) を含む可能性があるラッパー構造です。

  • Description – 必須: 説明文字列。2048 バイト長以下。URI address multi-line string pattern に一致。

    レジストリの説明。説明が指定されていない場合、このフィールドは更新されません。

レスポンス

  • RegistryName – UTF-8 文字列、1～255 バイト長、「Custom string pattern #18」に一致。

    更新されたレジストリの名前。

  • RegistryArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    更新されたレジストリの Amazon リソースネーム (ARN)

エラー

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • ConcurrentModificationException

  • InternalServiceException

GetSchemaByDefinition アクション (Python: get_schema_by_definition)

SchemaDefinition によってスキーマを取得します。スキーマ定義は、スキーマレジストリに送信され、正規化され、ハッシュされます。ハッシュが SchemaName または ARN (指定されていない場合はデフォルトのレジストリ) のスコープ内で一致する場合、そのスキーマのメタデータが返されます。一致しない場合は、404 すなわち NotFound エラーが返されます。Deleted ステータスのスキーマバージョンは結果に含まれません。

リクエスト

  • SchemaId – 必須: SchemaId オブジェクト。

    スキーマ ID フィールドを含むラッパー構造体です。構造体には以下が含まれています。

    • SchemaId$SchemaArn: スキーマの Amazon リソースネーム (ARN)。SchemaArn または SchemaName のいずれかを指定する必要があります。

    • SchemaId$SchemaName: スキーマの名前。SchemaArn または SchemaName のいずれかを指定する必要があります。

  • SchemaDefinition – 必須: UTF-8 文字列。1～170000 バイト長。Custom string pattern #33 に一致。

    スキーマの詳細が必要なスキーマの定義。

レスポンス

  • SchemaVersionId – UTF-8 文字列。36 バイト長ちょうど。Custom string pattern #17 に一致。

    スキーマバージョンのスキーマ ID。

  • SchemaArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    スキーマの Amazon リソースネーム (ARN)。

  • DataFormat – UTF-8 文字列 (有効な値: AVRO | JSON | PROTOBUF)。

    スキーマ定義のデータ形式。現在サポートされている形式は、AVRO、JSON、および PROTOBUF です。

  • Status – UTF-8 文字列 (有効な値: AVAILABLE | PENDING | FAILURE | DELETING)。

    スキーマバージョンのステータス。

  • CreatedTime – UTF-8 文字列。

    スキーマが作成された日時。

エラー

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

GetRegistry アクション (Python: get_registry)

指定されたレジストリの詳細について説明します。

リクエスト

  • RegistryId – 必須: RegistryId オブジェクト。

    これは、レジストリ名と Amazon リソースネーム (ARN) を含む可能性があるラッパー構造です。

レスポンス

  • RegistryName – UTF-8 文字列、1～255 バイト長、「Custom string pattern #18」に一致。

    レジストリの名前。

  • RegistryArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    レジストリの Amazon リソースネーム (ARN)

  • Description – 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。

    レジストリの説明。

  • Status – UTF-8 文字列 (有効な値: AVAILABLE | DELETING)。

    レジストリのステータス。

  • CreatedTime – UTF-8 文字列。

    レジストリが作成された日時。

  • UpdatedTime – UTF-8 文字列。

    レジストリが更新された日時。

エラー

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

PutSchemaVersionMetadata アクション (Python: put_schema_version_metadata)

指定されたスキーマバージョン ID のメタデータのキーバリューペアを配置します。各スキーマバージョンに対して最大 10 個のキーバリューペアを持つことができます。これらは、1 つ以上の呼び出しで追加できます。

リクエスト

  • SchemaId – SchemaId オブジェクト。

    スキーマの一意の ID。

  • SchemaVersionNumber – SchemaVersionNumber オブジェクト。

    スキーマのバージョン番号。

  • SchemaVersionId – UTF-8 文字列。36 バイト長ちょうど。Custom string pattern #17 に一致。

    スキーマバージョンの一意のバージョン ID。

  • MetadataKeyValue – 必須: MetadataKeyValuePair オブジェクト。

    メタデータキーの対応する値。

レスポンス

  • SchemaArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    スキーマの Amazon リソースネーム (ARN)。

  • SchemaName – UTF-8 文字列、1～255 バイト長、Custom string pattern #18 に一致。

    スキーマの名前。

  • RegistryName – UTF-8 文字列、1～255 バイト長、Custom string pattern #18 に一致。

    レジストリの名前。

  • LatestVersion – ブール。

    スキーマの最新バージョン。

  • VersionNumber – 数値 (long)。1～100000。

    スキーマのバージョン番号。

  • SchemaVersionId – UTF-8 文字列。36 バイト長ちょうど。Custom string pattern #17 に一致。

    スキーマバージョンの一意のバージョン ID。

  • MetadataKey – UTF-8 文字列。1～128 バイト長。Custom string pattern #34 に一致。

    メタデータキー。

  • MetadataValue – UTF-8 文字列。1～256 バイト長。Custom string pattern #34 に一致。

    メタデータキーの値。

エラー

  • InvalidInputException

  • AccessDeniedException

  • AlreadyExistsException

  • EntityNotFoundException

  • ResourceNumberLimitExceededException

QuerySchemaVersionMetadata アクション (Python: query_schema_version_metadata)

スキーマバージョンのメタデータ情報をクエリします。

リクエスト

  • SchemaId – SchemaId オブジェクト。

    スキーマ名と Amazon リソースネーム (ARN) を含む可能性のあるラッパー構造体。

  • SchemaVersionNumber – SchemaVersionNumber オブジェクト。

    スキーマのバージョン番号。

  • SchemaVersionId – UTF-8 文字列。36 バイト長ちょうど。Custom string pattern #17 に一致。

    スキーマバージョンの一意のバージョン ID。

  • MetadataList – MetadataKeyValuePair オブジェクトの配列。

    キーバリューペアからメタデータを検索します。キーバリューペアが指定されていない場合は、すべてのメタデータ情報がフェッチされます。

  • MaxResults – 数値 (整数)。1～50。

    1 ページあたりに必要な結果の最大数。値が指定されていない場合、これはデフォルトで 1 ページあたり 25 に設定されます。

  • NextToken – UTF-8 文字列。

    継続トークン (これが継続呼び出しの場合)。

応答

  • MetadataInfoMap – キーバリューペアのマップ配列。

    各キーは UTF-8 文字列、1～128 バイト長で、Custom string pattern #34 に一致します。

    各値は MetadataInfo オブジェクトです。

    メタデータキーおよび関連する値のマップ。

  • SchemaVersionId – UTF-8 文字列。36 バイト長ちょうど。Custom string pattern #17 に一致。

    スキーマバージョンの一意のバージョン ID。

  • NextToken – UTF-8 文字列。

    返されたトークンのリストをページ分割するための継続トークン。リストの現在のセグメントが最後のセグメントではない場合に返されます。

エラー

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

RemoveSchemaVersionMetadata アクション (Python: remove_schema_version_metadata)

指定されたスキーマバージョン ID のスキーマバージョンメタデータからキーバリューペアを削除します。

リクエスト

  • SchemaId – SchemaId オブジェクト。

    スキーマ名と Amazon リソースネーム (ARN) を含む可能性のあるラッパー構造体。

  • SchemaVersionNumber – SchemaVersionNumber オブジェクト。

    スキーマのバージョン番号。

  • SchemaVersionId – UTF-8 文字列。36 バイト長ちょうど。Custom string pattern #17 に一致。

    スキーマバージョンの一意のバージョン ID。

  • MetadataKeyValue – 必須: MetadataKeyValuePair オブジェクト。

    メタデータキーの値。

レスポンス

  • SchemaArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    スキーマの Amazon リソースネーム (ARN)。

  • SchemaName – UTF-8 文字列、1～255 バイト長、Custom string pattern #18 に一致。

    スキーマの名前。

  • RegistryName – UTF-8 文字列、1～255 バイト長、Custom string pattern #18 に一致。

    レジストリの名前。

  • LatestVersion – ブール。

    スキーマの最新バージョン。

  • VersionNumber – 数値 (long)。1～100000。

    スキーマのバージョン番号。

  • SchemaVersionId – UTF-8 文字列。36 バイト長ちょうど。Custom string pattern #17 に一致。

    スキーマバージョンのバージョン ID。

  • MetadataKey – UTF-8 文字列。1～128 バイト長。Custom string pattern #34 に一致。

    メタデータキー。

  • MetadataValue – UTF-8 文字列。1～256 バイト長。Custom string pattern #34 に一致。

    メタデータキーの値。

エラー

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

DeleteRegistry アクション (Python: delete_registry)

スキーマとそのすべてのバージョンを含め、レジストリ全体を削除します。削除オペレーションのステータスを取得するには、非同期呼び出し後に GetRegistry API を呼び出します。レジストリを削除すると、レジストリに対する UpdateRegistry、CreateSchema、UpdateSchema、および RegisterSchemaVersion API など、すべてのオンラインオペレーションが非アクティブ化されます。

リクエスト

  • RegistryId – 必須: RegistryId オブジェクト。

    これは、レジストリ名と Amazon リソースネーム (ARN) を含む可能性があるラッパー構造です。

レスポンス

  • RegistryName – UTF-8 文字列、1～255 バイト長、「Custom string pattern #18」に一致。

    削除されるレジストリの名前。

  • RegistryArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    削除されるレジストリの Amazon リソースネーム (ARN)。

  • Status – UTF-8 文字列 (有効な値: AVAILABLE | DELETING)。

    レジストリのステータス。オペレーションが正常終了すると、Deleting ステータスを返します。

エラー

  • InvalidInputException

  • EntityNotFoundException

  • AccessDeniedException

  • ConcurrentModificationException

DeleteSchema アクション (Python: delete_schema)

スキーマセットとそのすべてのバージョンを含め、スキーマセット全体を削除します。削除オペレーションのステータスを取得するには、非同期呼び出し後に GetSchema API を呼び出します。レジストリを削除すると、スキーマに対するGetSchemaByDefinition および RegisterSchemaVersion API など、すべてのオンライン操作が非アクティブ化されます。

リクエスト

  • SchemaId – 必須: SchemaId オブジェクト。

    これは、スキーマ名と Amazon リソースネーム (ARN) を含む可能性のあるラッパー構造です。

レスポンス

  • SchemaArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。

    削除されるスキーマの Amazon リソースネーム (ARN)。

  • SchemaName – UTF-8 文字列、1～255 バイト長、Custom string pattern #18 に一致。

    削除されるスキーマの名前。

  • Status – UTF-8 文字列 (有効な値: AVAILABLE | PENDING | DELETING)。

    スキーマのステータス。

エラー

  • InvalidInputException

  • EntityNotFoundException

  • AccessDeniedException

  • ConcurrentModificationException

DeleteSchemaVersions アクション (Python: delete_schema_versions)

指定したスキーマからバージョンを削除します。バージョン番号または範囲を指定できます。互換モードが BACKWARDS_FULL など、必要なバージョンの削除を禁止している場合、エラーが返されます。この呼び出しの後に GetSchemaVersions API を呼び出すと、削除されたバージョンのステータスが一覧表示されます。

バージョン番号の範囲にチェックポイントが付加されたバージョンが含まれている場合、APIは 409 の競合を返し、削除を続行しません。このAPIを使用する前に、まず、DeleteSchemaCheckpoint APIを使用してチェックポイントを削除する必要があります。

DeleteSchemaVersions API を使用して、スキーマセット内の最初のスキーマバージョンを削除することはできません。最初のスキーマバージョンは、DeleteSchema API でのみ削除できます。この操作により、スキーマバージョンの下にアタッチされた SchemaVersionMetadata も削除されます。データベースでは必ず物理削除 (ハード削除) となります。

互換モードが BACKWARDS_FULL など、必要なバージョンの削除を禁止している場合、エラーが返されます。

リクエスト

  • SchemaId – 必須: SchemaId オブジェクト。

    これは、スキーマ名と Amazon リソースネーム (ARN) を含む可能性のあるラッパー構造です。

  • Versions – 必須: UTF-8 文字列。1～100000 バイト長。Custom string pattern #35 に一致。

    バージョン範囲は、次のような形式で指定することができます。

    • 単一のバージョン番号、5

    • 範囲、5-8: deletes versions 5, 6, 7, 8

応答

  • SchemaVersionErrors – SchemaVersionErrorItem オブジェクトの配列。

    SchemaVersionErrorItem オブジェクトのリスト。それぞれにはエラーとスキーマのバージョンが含まれています。

エラー

  • InvalidInputException

  • EntityNotFoundException

  • AccessDeniedException

  • ConcurrentModificationException