結構描述登錄檔 - AWS Glue
 —  資料類型  —RegistryIdRegistryListItemMetadataInfoOtherMetadataValueListItemSchemaListItemSchemaVersionListItemMetadataKeyValuePairSchemaVersionErrorItemErrorDetailsSchemaVersionNumberSchemaId —  operations  —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說明與使用結構描述API相關的資料類型和 AWS Glue。

資料類型

RegistryId 結構

可能包含登錄檔名稱和 Amazon Resource Name () 的包裝函式結構ARN。

欄位

  • RegistryName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    登錄檔的名稱。僅用於查閱。必須提供其中一個 RegistryArn 或 RegistryName。

  • RegistryArn – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 10240 個位元組，需符合 Custom string pattern #49。

    要更新的登錄檔的 arn。必須提供其中一個 RegistryArn 或 RegistryName。

RegistryListItem 結構

包含登錄檔詳細資訊的結構。

欄位

  • RegistryName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    登錄的名稱。

  • RegistryArn – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 10240 個位元組，需符合 Custom string pattern #49。

    登錄檔的 Amazon Resource Name (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 #14。

    中繼資料索引鍵的對應值。

  • CreatedTime – UTF-8 字串。

    項目建立的時間。

  • OtherMetadataValueList – 一個 OtherMetadataValueListItem 物件陣列。

    屬於相同中繼資料索引鍵的其他中繼資料。

OtherMetadataValueListItem 結構

包含屬於相同中繼資料索引鍵之結構描述版本的其他中繼資料的結構。

欄位

  • MetadataValue – UTF-8 個字串，長度不可小於 1 個位元組，也不可以超過 256 個位元組，且需符合 Custom string pattern #14。

    屬於相同中繼資料索引鍵的其他中繼資料的中繼資料索引鍵的對應值。

  • CreatedTime – UTF-8 字串。

    項目建立的時間。

SchemaListItem 結構

包含結構描述最少詳細資訊的物件。

欄位

  • RegistryName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    結構描述所在的登錄檔名稱。

  • SchemaName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    結構描述的名稱。

  • SchemaArn – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 10240 個位元組，且需符合 Custom string pattern #49。

    結構描述的 Amazon Resource Name (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 #49。

    結構描述的 Amazon Resource Name (ARN)。

  • SchemaVersionId – UTF-8 字串，長度不可小於 36 個位元組，也不可以超過 36 個位元組，需符合 Custom string pattern #44。

    結構描述版本的唯一識別碼。

  • VersionNumber – 數字 (長整數)，不可小於 1，也不可以大於 100000。

    結構描述的版本編號。

  • Status – UTF-8 字串 （有效值： AVAILABLE | PENDING | FAILURE | DELETING)。

    結構描述版本的狀態。

  • CreatedTime – UTF-8 字串。

    建立結構描述版本的日期和時間。

MetadataKeyValuePair 結構

包含中繼資料的索引鍵值組的結構。

欄位

  • MetadataKey – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組，需符合 Custom string pattern #14。

    中繼資料金鑰。

  • MetadataValue – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 256 個位元組，需符合 Custom string pattern #14。

    中繼資料索引鍵的對應值。

SchemaVersionErrorItem 結構

包含結構描述版本上操作之錯誤詳細資訊的物件。

欄位

  • VersionNumber – 數字 (長整數)，不可小於 1，也不可以大於 100000。

    結構描述的版本編號。

  • ErrorDetails – ErrorDetails 物件。

    結構描述版本的錯誤詳細資訊。

ErrorDetails 結構

包含錯誤詳細資訊的物件。

欄位

  • ErrorCode – UTF-8 字串。

    錯誤的錯誤碼。

  • ErrorMessage – UTF-8 字串。

    錯誤的錯誤訊息。

SchemaVersionNumber 結構

包含結構描述版本資訊的結構。

欄位

  • LatestVersion – 布林值。

    可用於結構描述的最新版本。

  • VersionNumber – 數字 (長整數)，不可小於 1，也不可以大於 100000。

    結構描述的版本編號。

SchemaId 結構

結構描述登錄檔中 AWS Glue 結構描述的唯一 ID。

欄位

  • SchemaArn – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 10240 個位元組，需符合 Custom string pattern #49。

    結構描述的 Amazon Resource Name (ARN)。必須提供其中一個 SchemaArn 或 SchemaName。

  • SchemaName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    結構描述的名稱。必須提供其中一個 SchemaArn 或 SchemaName。

  • RegistryName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    包含結構描述的結構描述登錄檔的名稱。

作業

CreateRegistry 動作 (Python：create_registry)

建立一個新的登錄檔，可用於儲存結構描述的集合。

請求

  • RegistryName – 必要：UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    要建立的登錄檔名稱最長為 255 個字元，並且只能包含字母、數字、連字號、下劃線、美元符號或雜湊符號。沒有空格。

  • Description – 描述字串，長度不可超過 2048 個位元組，需符合URI address multi-line string pattern。

    登錄檔描述。如果未提供描述，則此項不會有任何預設值。

  • Tags – 金鑰值對的對應陣列，不超過 50 對。

    每個金鑰都是 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。

    每個值都是 UTF-8 字串，長度不可超過 256 個位元組。

    AWS 包含索引鍵值對的標籤，可依主控台、命令列或 進行搜尋API。

回應

  • RegistryArn – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 10240 個位元組，需符合 Custom string pattern #49。

    新建立之登錄檔的 Amazon Resource Name (ARN)。

  • RegistryName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    登錄的名稱。

  • 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」會限制在第一個結構描述版本之後新增任何其他結構描述版本。對於所有其他相容性模式，只有在RegisterSchemaVersionAPI使用 時，才會從第二個版本開始套用相容性設定的驗證。

如果API沒有 呼叫此 RegistryId，如果登錄資料庫資料表尚未存在，則會在登錄資料庫中為「預設登錄」建立項目。

請求

  • RegistryId – RegistryId 物件。

    這是包含登錄檔識別欄位的包裝函式圖形。如果未提供此項，則會使用預設登錄檔。相同的ARN格式為：arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id。

  • SchemaName – 必要：UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    要建立的結構描述名稱最長為 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 個位元組。

    AWS 包含索引鍵值對的標籤，可依主控台、命令列或 進行搜尋API。如果指定， 會遵循 AWS tags-on-create 模式。

  • SchemaDefinition – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 170000 個位元組，且需符合 Custom string pattern #13。

    為 SchemaName 使用 DataFormat 設定的結構描述定義。

回應

  • RegistryName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    登錄的名稱。

  • RegistryArn – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 10240 個位元組，需符合 Custom string pattern #49。

    登錄檔的 Amazon Resource Name (ARN)。

  • SchemaName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    結構描述的名稱。

  • SchemaArn – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 10240 個位元組，且需符合 Custom string pattern #49。

    結構描述的 Amazon Resource Name (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 – 數字 (長整數)，不可小於 1，也不可以大於 100000。

    檢查點的版本號碼 (上次變更相容性模式)。

  • LatestSchemaVersion – 數字 (長整數)，不可小於 1，也不可以大於 100000。

    與傳回結構描述定義相關聯結構描述的最新版本。

  • NextSchemaVersion – 數字 (長整數)，不可小於 1，也不可以大於 100000。

    與傳回結構描述定義相關聯結構描述的下一個版本。

  • SchemaStatus – UTF-8 字串 （有效值： AVAILABLE | PENDING | DELETING)。

    結構描述的狀態。

  • Tags – 金鑰值對的對應陣列，不超過 50 對。

    每個金鑰都是 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。

    每個值都是 UTF-8 字串，長度不可超過 256 個位元組。

    結構描述的標籤。

  • SchemaVersionId – UTF-8 個字串，長度不可小於 36 個位元組，也不可以超過 36 個位元組，且需符合 Custom string pattern #44。

    第一個結構描述版本的唯一識別碼。

  • SchemaVersionStatus – UTF-8 字串 （有效值： AVAILABLE | PENDING | FAILURE | DELETING)。

    建立的第一個結構描述版本的狀態。

錯誤

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • AlreadyExistsException

  • ResourceNumberLimitExceededException

  • ConcurrentModificationException

  • InternalServiceException

GetSchema 動作 (Python：get_schema)

詳細描述指定的結構描述。

請求

  • SchemaId – 必要：SchemaId 物件。

    這是包含結構描述身分欄位的包裝函式結構。結構包含：

    • SchemaId$SchemaArn：結構描述的 Amazon Resource Name (ARN)。必須提供 SchemaArn 或 SchemaName 和 RegistryName。

    • SchemaId$SchemaName：結構描述的名稱。必須提供 SchemaArn 或 SchemaName 和 RegistryName。

回應

  • RegistryName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    登錄的名稱。

  • RegistryArn – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 10240 個位元組，且需符合 Custom string pattern #49。

    登錄檔的 Amazon Resource Name (ARN)。

  • SchemaName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    結構描述的名稱。

  • SchemaArn – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 10240 個位元組，需符合 Custom string pattern #49。

    結構描述的 Amazon Resource Name (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 – 數字 (長整數)，不可小於 1，也不可以大於 100000。

    檢查點的版本號碼 (上次變更相容性模式)。

  • LatestSchemaVersion – 數字 (長整數)，不可小於 1，也不可以大於 100000。

    與傳回結構描述定義相關聯結構描述的最新版本。

  • NextSchemaVersion – 數字 (長整數)，不可小於 1，也不可以大於 100000。

    與傳回結構描述定義相關聯結構描述的下一個版本。

  • SchemaStatus – UTF-8 字串 （有效值： AVAILABLE | PENDING | DELETING)。

    結構描述的狀態。

  • CreatedTime – UTF-8 字串。

    建立結構描述的日期和時間。

  • UpdatedTime – UTF-8 字串。

    結構描述的更新日期和時間。

錯誤

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

ListSchemaVersions 動作 (Python：list_schema_versions)

以最少的資訊傳回您所建立的結構描述版本清單。結果中不會包含處於 [已刪除] 狀態的結構描述版本。如果沒有可用的結構描述版本，則會傳回空的結果。

請求

  • SchemaId – 必要：SchemaId 物件。

    這是包含結構描述身分欄位的包裝函式結構。結構包含：

    • SchemaId$SchemaArn：結構描述的 Amazon Resource Name (ARN)。必須提供 SchemaArn 或 SchemaName 和 RegistryName。

    • SchemaId$SchemaName：結構描述的名稱。必須提供 SchemaArn 或 SchemaName 和 RegistryName。

  • MaxResults – 數字 (整數)，不可小於 1，也不可以大於 100。

    每頁要求結果的數量上限。如果未提供該值，這將預設為每頁 25 個。

  • NextToken – UTF-8 字串。

    接續符記，如果這是接續呼叫。

回應

  • Schemas – 一個 SchemaVersionListItem 物件陣列。

    包含每個結構描述版本詳細資訊的 SchemaVersionList 物件陣列。

  • NextToken – UTF-8 字串。

    為一種接續符記，用於將傳回的符記清單分頁，而如果清單目前的區段不是最後區段就會傳回。

錯誤

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

GetSchemaVersion 動作 (Python：get_schema_version)

根據建立或註冊結構描述的版本時指派的唯一 ID，取得指定的結構描述。結果中不會包含處於 [已刪除] 狀態的結構描述版本。

請求

  • SchemaId – SchemaId 物件。

    這是包含結構描述身分欄位的包裝函式結構。結構包含：

    • SchemaId$SchemaArn：結構描述的 Amazon Resource Name (ARN)。必須提供 SchemaArn 或 SchemaName 和 RegistryName。

    • SchemaId$SchemaName：結構描述的名稱。必須提供 SchemaArn 或 SchemaName 和 RegistryName。

  • SchemaVersionId – UTF-8 個字串，長度不可小於 36 個位元組，也不可以超過 36 個位元組，需符合 Custom string pattern #44。

    結構描述版本的 SchemaVersionId。透過結構描述 ID 擷取時，此欄位是必要欄位。必須提供此項目或 SchemaId 包裝函式。

  • SchemaVersionNumber – SchemaVersionNumber 物件。

    結構描述的版本編號。

回應

  • SchemaVersionId – UTF-8 個字串，長度不可小於 36 個位元組，也不可以超過 36 個位元組，需符合 Custom string pattern #44。

    結構描述版本的 SchemaVersionId。

  • SchemaDefinition – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 170000 個位元組，且需符合 Custom string pattern #13。

    結構描述 ID 的結構描述定義。

  • DataFormat – UTF-8 字串 （有效值： AVRO | JSON | PROTOBUF)。

    結構描述定義的資料格式。目前支援 AVRO、JSON 和 PROTOBUF。

  • SchemaArn – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 10240 個位元組，需符合 Custom string pattern #49。

    結構描述的 Amazon Resource Name (ARN)。

  • VersionNumber – 數字 (長整數)，不可小於 1，也不可以大於 100000。

    結構描述的版本編號。

  • Status – UTF-8 字串 （有效值： AVAILABLE | PENDING | FAILURE | DELETING)。

    結構描述版本的狀態。

  • CreatedTime – UTF-8 字串。

    建立結構描述版本的日期和時間。

錯誤

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

GetSchemaVersionsDiff 動作 (Python：get_schema_versions_diff)

擷取結構描述登錄檔中兩個預存結構描述版本之間指定差異類型的結構描述版本差異。

這API可讓您在相同結構描述下的兩個結構描述定義之間比較兩個結構描述版本。

請求

  • SchemaId – 必要：SchemaId 物件。

    這是包含結構描述身分欄位的包裝函式結構。結構包含：

    • SchemaId$SchemaArn：結構描述的 Amazon Resource Name (ARN)。必須提供其中一個 SchemaArn 或 SchemaName。

    • SchemaId$SchemaName：結構描述的名稱。必須提供其中一個 SchemaArn 或 SchemaName。

  • FirstSchemaVersionNumber – 必要：SchemaVersionNumber 物件。

    要比較的兩個結構描述版本中的第一個。

  • SecondSchemaVersionNumber – 必要：SchemaVersionNumber 物件。

    要比較的兩個結構描述版本中的第二個。

  • SchemaDiffType – 必要：UTF-8 字串 （有效值：SYNTAX_DIFF)。

    參考 SYNTAX_DIFF，這是目前支援的差異類型。

回應

  • Diff – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 340000 個位元組，需符合 Custom string pattern #13。

    格式的結構描述與字串之間的差異 JsonPatch 。

錯誤

  • InvalidInputException

  • EntityNotFoundException

  • AccessDeniedException

  • InternalServiceException

ListRegistries 動作 (Python：list_registries)

以最少的登錄檔資訊傳回您所建立的登錄檔清單。狀態為 Deleting 的登錄檔將不會包含在結果中。如果沒有可用的登錄檔，將傳回空白的結果。

請求

  • MaxResults – 數字 (整數)，不可小於 1，也不可以大於 100。

    每頁要求結果的數量上限。如果未提供該值，這將預設為每頁 25 個。

  • NextToken – UTF-8 字串。

    接續符記，如果這是接續呼叫。

回應

  • Registries – 一個 RegistryListItem 物件陣列。

    包含每個登錄檔最少詳細資訊的 RegistryDetailedListItem 物件陣列。

  • NextToken – UTF-8 字串。

    為一種接續符記，用於將傳回的符記清單分頁，而如果清單目前的區段不是最後區段就會傳回。

錯誤

  • InvalidInputException

  • AccessDeniedException

  • InternalServiceException

ListSchemas 動作 (Python：list_schemas)

傳回具有最少詳細資訊的結構描述清單。結果中不會包含處於 [正在刪除] 狀態的結構描述。如果沒有可用的結構描述，將傳回空的結果。

RegistryId 未提供 時，跨登錄檔的所有結構描述都會成為API回應的一部分。

請求

  • RegistryId – RegistryId 物件。

    可能包含登錄檔名稱和 Amazon Resource Name () 的包裝函式結構ARN。

  • MaxResults – 數字 (整數)，不可小於 1，也不可以大於 100。

    每頁要求結果的數量上限。如果未提供該值，這將預設為每頁 25 個。

  • NextToken – UTF-8 字串。

    接續符記，如果這是接續呼叫。

回應

  • Schemas – 一個 SchemaListItem 物件陣列。

    包含每個結構描述詳細資訊的 SchemaListItem 物件陣列。

  • NextToken – UTF-8 字串。

    為一種接續符記，用於將傳回的符記清單分頁，而如果清單目前的區段不是最後區段就會傳回。

錯誤

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

RegisterSchemaVersion 動作 (Python：register_schema_version)

將新版本加入至現有的結構描述。如果新版結構描述不符合結構描述集的相容性需求，則傳回錯誤。這API不會建立新的結構描述集，如果結構描述集不存在於結構描述登錄檔中，則將傳回 404 錯誤。

如果這是要在結構描述登錄檔中註冊的第一個結構描述定義，API這會存放結構描述版本並立即傳回。否則，由於相容性模式，此呼叫可能會比其他操作執行更長的時間。您可以使用 呼叫 GetSchemaVersion API SchemaVersionId，以檢查相容性模式。

如果相同的結構描述定義已儲存在結構描述登錄檔作為版本，現有結構描述的結構描述 ID 會傳回給呼叫者。

請求

  • SchemaId – 必要：SchemaId 物件。

    這是包含結構描述身分欄位的包裝函式結構。結構包含：

    • SchemaId$SchemaArn：結構描述的 Amazon Resource Name (ARN)。必須提供 SchemaArn 或 SchemaName 和 RegistryName。

    • SchemaId$SchemaName：結構描述的名稱。必須提供 SchemaArn 或 SchemaName 和 RegistryName。

  • SchemaDefinition – 必要：UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 170000 個位元組，需符合 Custom string pattern #13。

    為 SchemaName 使用 DataFormat 設定的結構描述定義。

回應

  • SchemaVersionId – UTF-8 字串，長度不可小於 36 個位元組，也不可以超過 36 個位元組，需符合 Custom string pattern #44。

    代表此結構描述版本的唯一 ID。

  • VersionNumber – 數字 (長整數)，不可小於 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 物件。

    這是包含結構描述身分欄位的包裝函式結構。結構包含：

    • SchemaId$SchemaArn：結構描述的 Amazon Resource Name (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 #49。

    結構描述的 Amazon Resource Name (ARN)。

  • SchemaName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    結構描述的名稱。

  • RegistryName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    包含結構描述的登錄檔的名稱。

錯誤

  • 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 #13。

    必須驗證結構描述的定義。

回應

  • Valid – 布林值。

    如果結構描述是有效的則傳回 true，否則為 false。

  • Error – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 5000 個位元組。

    驗證失敗錯誤訊息。

錯誤

  • InvalidInputException

  • AccessDeniedException

  • InternalServiceException

UpdateRegistry 動作 (Python： update_registry)

更新用於儲存結構描述集合的現有登錄檔。更新的屬性與登錄檔相關，並且不會修改任何登錄檔內的結構描述。

請求

  • RegistryId – 必要：RegistryId 物件。

    這是包裝函式結構，可能包含登錄檔名稱和 Amazon Resource Name (ARN)。

  • Description – 必要：描述字串，長度不可超過 2048 個位元組，需符合 URI address multi-line string pattern。

    登錄檔描述。如果未提供描述，則不會更新此欄位。

回應

  • RegistryName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    更新登錄檔的名稱。

  • RegistryArn – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 10240 個位元組，需符合 Custom string pattern #49。

    更新登錄檔的 Amazon Resource 名稱 (ARN)。

錯誤

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • ConcurrentModificationException

  • InternalServiceException

GetSchemaByDefinition 動作 (Python：get_schema_by_definition)

由檢索結構描述SchemaDefinition。結構描述定義會傳送至結構描述登錄檔、進行標準化和雜湊。如果雜湊在 SchemaName或 ARN（或預設登錄檔，如果未提供） 的範圍內相符，則會傳回該結構描述的中繼資料。否則，會傳回 404 或 NotFound 錯誤。處於 Deleted 狀態的結構描述版本將不會包含在結果中。

請求

  • SchemaId – 必要：SchemaId 物件。

    這是包含結構描述身分欄位的包裝函式結構。結構包含：

    • SchemaId$SchemaArn：結構描述的 Amazon Resource Name (ARN)。必須提供其中一個 SchemaArn 或 SchemaName。

    • SchemaId$SchemaName：結構描述的名稱。必須提供其中一個 SchemaArn 或 SchemaName。

  • SchemaDefinition – 必要：UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 170000 個位元組，需符合 Custom string pattern #13。

    需要結構描述詳細資訊之結構描述的定義。

回應

  • SchemaVersionId – UTF-8 字串，長度不可小於 36 個位元組，也不可以超過 36 個位元組，需符合 Custom string pattern #44。

    結構描述版本的結構描述 ID。

  • SchemaArn – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 10240 個位元組，且需符合 Custom string pattern #49。

    結構描述的 Amazon Resource Name (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 Resource Name (ARN)。

回應

  • RegistryName – UTF-8 個字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合 Custom string pattern #45。

    登錄的名稱。

  • RegistryArn – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 10240 個位元組，且需符合 Custom string pattern #49。

    登錄檔的 Amazon Resource Name (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 個索引鍵值配對。它們可以透過一個或多個呼叫來新增。

請求

  • SchemaId – SchemaId 物件。

    結構描述的唯一 ID。

  • SchemaVersionNumber – SchemaVersionNumber 物件。

    結構描述的版本編號。

  • SchemaVersionId – UTF-8 個字串，長度不可小於 36 個位元組，也不可以超過 36 個位元組，需符合 Custom string pattern #44。

    結構描述版本的唯一版本 ID。

  • MetadataKeyValue – 必要：MetadataKeyValuePair 物件。

    中繼資料索引鍵的對應值。

回應

  • SchemaArn – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 10240 個位元組，且需符合 Custom string pattern #49。

    結構描述的 Amazon Resource Name (ARN)。

  • SchemaName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    結構描述的名稱。

  • RegistryName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    登錄檔的名稱。

  • LatestVersion – 布林值。

    結構描述的最新版本。

  • VersionNumber – 數字 (長整數)，不可小於 1，也不可以大於 100000。

    結構描述的版本編號。

  • SchemaVersionId – UTF-8 字串，長度不可小於 36 個位元組，也不可以超過 36 個位元組，需符合 Custom string pattern #44。

    結構描述版本的唯一版本 ID。

  • MetadataKey – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組，需符合 Custom string pattern #14。

    中繼資料索引鍵。

  • MetadataValue – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 256 個位元組，需符合 Custom string pattern #14。

    中繼資料索引鍵的值。

錯誤

  • InvalidInputException

  • AccessDeniedException

  • AlreadyExistsException

  • EntityNotFoundException

  • ResourceNumberLimitExceededException

QuerySchemaVersionMetadata 動作 (Python： query_schema_version_metadata)

查詢結構描述版本的中繼資料資訊。

請求

  • SchemaId – SchemaId 物件。

    可能包含結構描述名稱和 Amazon Resource Name () 的包裝函式結構ARN。

  • SchemaVersionNumber – SchemaVersionNumber 物件。

    結構描述的版本編號。

  • SchemaVersionId – UTF-8 字串，長度不可小於 36 個位元組，也不可以超過 36 個位元組，需符合 Custom string pattern #44。

    結構描述版本的唯一版本 ID。

  • MetadataList – 一個 MetadataKeyValuePair 物件陣列。

    搜尋鍵-值對中繼資料，如果他們沒有提供所有中繼資料訊息將被提取。

  • MaxResults – 數字 (整數)，不可小於 1，也不可以大於 50。

    每頁要求結果的數量上限。如果未提供該值，這將預設為每頁 25 個。

  • NextToken – UTF-8 字串。

    接續符記，如果這是接續呼叫。

回應

  • MetadataInfoMap – 金鑰值對的映射陣列。

    每個金鑰都是 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組，且需符合 Custom string pattern #14。

    每個值都是 MetadataInfo 物件。

    中繼資料索引鍵和關聯值的映射。

  • SchemaVersionId – UTF-8 個字串，長度不可小於 36 個位元組，也不可以超過 36 個位元組，需符合 Custom string pattern #44。

    結構描述版本的唯一版本 ID。

  • NextToken – UTF-8 字串。

    為一種接續符記，用於將傳回的符記清單分頁，而如果清單目前的區段不是最後區段就會傳回。

錯誤

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

RemoveSchemaVersionMetadata 動作 (Python： remove_schema_version_metadata)

從指定的結構描述版本 ID 的結構描述版本中繼資料中移除索引鍵值配對。

請求

  • SchemaId – SchemaId 物件。

    可能包含結構描述名稱和 Amazon Resource Name () 的包裝函式結構ARN。

  • SchemaVersionNumber – SchemaVersionNumber 物件。

    結構描述的版本編號。

  • SchemaVersionId – UTF-8 個字串，長度不可小於 36 個位元組，也不可以超過 36 個位元組，需符合 Custom string pattern #44。

    結構描述版本的唯一版本 ID。

  • MetadataKeyValue – 必要：MetadataKeyValuePair 物件。

    中繼資料索引鍵的值。

回應

  • SchemaArn – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 10240 個位元組，需符合 Custom string pattern #49。

    結構描述的 Amazon Resource Name (ARN)。

  • SchemaName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    結構描述的名稱。

  • RegistryName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    登錄的名稱。

  • LatestVersion – 布林值。

    結構描述的最新版本。

  • VersionNumber – 數字 (長整數)，不可小於 1，也不可以大於 100000。

    結構描述的版本編號。

  • SchemaVersionId – UTF-8 字串，長度不可小於 36 個位元組，也不可以超過 36 個位元組，需符合 Custom string pattern #44。

    結構描述版本的版本 ID。

  • MetadataKey – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組，需符合 Custom string pattern #14。

    中繼資料索引鍵。

  • MetadataValue – UTF-8 個字串，長度不可小於 1 個位元組，也不可以超過 256 個位元組，且需符合 Custom string pattern #14。

    中繼資料索引鍵的值。

錯誤

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

DeleteRegistry 動作 (Python：Delete_registry)

刪除包含結構描述及其所有版本的整個登錄檔。若要取得刪除操作的狀態，您可以在非同步呼叫GetRegistryAPI之後呼叫 。刪除登錄檔會停用登錄檔的所有線上操作CreateSchema，例如 UpdateRegistry、UpdateSchema、 和 RegisterSchemaVersion APIs。

請求

  • RegistryId – 必要：RegistryId 物件。

    這是包裝函式結構，可能包含登錄檔名稱和 Amazon Resource Name (ARN)。

回應

  • RegistryName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    要刪除之登錄檔的名稱。

  • RegistryArn – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 10240 個位元組，且需符合 Custom string pattern #49。

    要刪除之登錄檔的 Amazon Resource Name (ARN)。

  • Status – UTF-8 字串 （有效值： AVAILABLE | DELETING)。

    登錄檔的狀態。成功的操作將傳回 Deleting 狀態。

錯誤

  • InvalidInputException

  • EntityNotFoundException

  • AccessDeniedException

  • ConcurrentModificationException

DeleteSchema 動作 (Python：Delete_schema)

刪除整個結構描述集，包括結構描述集及其所有版本。若要取得刪除操作的狀態，您可以在非同步呼叫GetSchemaAPI之後呼叫 。刪除登錄檔會停用結構描述的所有線上操作，例如 GetSchemaByDefinition、 和 RegisterSchemaVersion APIs。

請求

  • SchemaId – 必要：SchemaId 物件。

    這是包裝函式結構，可能包含結構描述名稱和 Amazon Resource Name (ARN)。

回應

  • SchemaArn – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 10240 個位元組，需符合 Custom string pattern #49。

    要刪除之結構描述的 Amazon Resource Name (ARN)。

  • SchemaName – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合 Custom string pattern #45。

    要刪除之結構描述的名稱。

  • Status – UTF-8 字串 （有效值： AVAILABLE | PENDING | DELETING)。

    結構描述的狀態。

錯誤

  • InvalidInputException

  • EntityNotFoundException

  • AccessDeniedException

  • ConcurrentModificationException

DeleteSchemaVersions 動作 (Python：Delete_schema_versions)

從指定的結構描述移除版本。可能會提供版本號碼或範圍。如果相容性模式禁止刪除必要的版本，例如 BACKWARDS_FULL，則會傳回錯誤。在此呼叫GetSchemaVersionsAPI之後呼叫 會列出已刪除版本的狀態。

當版本編號的範圍包含檢查指標版本時， API將傳回 409 衝突，且不會繼續刪除。您必須先使用 移除檢查點，DeleteSchemaCheckpointAPI再使用此 API。

您無法使用 DeleteSchemaVersionsAPI刪除結構描述集中的第一個結構描述版本。第一個結構描述版本只能由 DeleteSchema 刪除API。此操作也將刪除結構描述版本下連接的 SchemaVersionMetadata。將在資料庫上強制執行硬式刪除。

如果相容性模式禁止刪除必要的版本，例如 BACKWARDS_FULL，則會傳回錯誤。

請求

  • SchemaId – 必要：SchemaId 物件。

    這是包裝函式結構，可能包含結構描述名稱和 Amazon Resource Name (ARN)。

  • Versions – 必要：UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 100000 個位元組，需符合 Custom string pattern #15。

    可以提供一個版本範圍，其格式可能是：

    • 單一版本號碼，5

    • 範圍：5-8：刪除版本 5、6、7、8

回應

  • SchemaVersionErrors – 一個 SchemaVersionErrorItem 物件陣列。

    SchemaVersionErrorItem 物件的清單，每個物件都包含一個錯誤和結構描述版本。

錯誤

  • InvalidInputException

  • EntityNotFoundException

  • AccessDeniedException

  • ConcurrentModificationException