架构注册表 - Amazon连接词
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

架构注册表

架构注册 API 介绍与在 AWS Glue 中使用架构相关的数据类型和 API。

数据类型

RegistryId 结构

包装结构,可能包含注册表名称和 Amazon 资源名称 (ARN)。

Fields

  • RegistryName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    注册表的名称。仅用于查找。必须提供 RegistryNameRegistryArn 中的一个。

  • RegistryArn— UTF-8 字符串,不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    要更新的注册表的 arn。必须提供 RegistryNameRegistryArn 中的一个。

注册表结构

包含注册表详细信息的结构。

Fields

  • RegistryName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    注册表的名称。

  • RegistryArn— UTF-8 字符串,不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    注册表的 Amazon 资源名称 (ARN)。

  • Description – 描述字符串,长度不超过 2048 个字节,与 URI address multi-line string pattern 匹配。

    注册表的描述。

  • Status – UTF-8 字符串(有效值:AVAILABLE | DELETING)。

    注册表的状态。

  • CreatedTime – UTF-8 字符串。

    创建注册表的数据。

  • UpdatedTime – UTF-8 字符串。

    更新注册表的日期。

元数据信息结构

包含架构版本元数据信息的结构。

Fields

  • MetadataValue— UTF-8 字符串,不少于 1 个字节或超过 256 个字节,与匹配。Custom string pattern #21

    元数据键的相应值。

  • CreatedTime – UTF-8 字符串。

    创建条目的时间。

  • OtherMetadataValueList其他元数据 对象的数组。

    属于同一元数据键的其他元数据。

其他元数据结构

包含属于同一元数据键的架构版本的其他元数据的结构。

Fields

  • MetadataValue— UTF-8 字符串,不少于 1 个字节或超过 256 个字节,与匹配。Custom string pattern #21

    元数据键对于属于同一元数据键的其他元数据的对应值。

  • CreatedTime – UTF-8 字符串。

    创建条目的时间。

架构结构

包含架构的最小详细信息的对象。

Fields

  • RegistryName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    架构所在的注册表的名称。

  • SchemaName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    架构的名称。

  • SchemaArn— UTF-8 字符串,不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    架构的 Amazon 资源名称 (ARN)。

  • Description – 描述字符串,长度不超过 2048 个字节,与 URI address multi-line string pattern 匹配。

    架构描述。

  • SchemaStatus – UTF-8 字符串(有效值:AVAILABLE | PENDING | DELETING)。

    架构的状态。

  • CreatedTime – UTF-8 字符串。

    架构的创建日期和时间。

  • UpdatedTime – UTF-8 字符串。

    架构的更新日期和时间。

架构版本结构

包含有关架构版本的详细信息的对象。

Fields

  • SchemaArn— UTF-8 字符串,不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    架构的 Amazon 资源名称 (ARN)。

  • SchemaVersionId— UTF-8 字符串,不少于 36 个字节或超过 36 个字节,与匹配。Custom string pattern #11

    架构版本的唯一标识符。

  • VersionNumber— 数字(长),不小于 1 或大于 10 万。

    架构的版本号。

  • Status— UTF-8 字符串(有效值:AVAILABLE|PENDING|FAILURE|DELETING)。

    架构版本的状态。

  • CreatedTime – UTF-8 字符串。

    架构版本的创建日期和时间。

元数据键值对结构

包含元数据键值对的结构。

Fields

  • MetadataKey— UTF-8 字符串,不少于 1 个字节或超过 128 个字节,与匹配。Custom string pattern #21

    元数据密钥。

  • MetadataValue— UTF-8 字符串,不少于 1 个字节或超过 256 个字节,与匹配。Custom string pattern #21

    元数据键的相应值。

架构版本错误项结构

包含模式版本操作错误详细信息的对象。

Fields

  • VersionNumber— 数字(长),不小于 1 或大于 10 万。

    架构的版本号。

  • ErrorDetails – 一个 ErrorDetails 对象。

    架构版本的错误的详细信息。

ErrorDetails 结构

包含错误详细信息的对象。

Fields

  • ErrorCode – UTF-8 字符串。

    错误的错误代码。

  • ErrorMessage – UTF-8 字符串。

    错误的错误消息。

架构版本数字结构

包含架构版本信息的结构。

Fields

  • LatestVersion – Boolean.

    可用于架构的最新版本。

  • VersionNumber— 数字(长),不小于 1 或大于 10 万。

    架构的版本号。

SchemaId 结构

AWS Glue Schema Registry 中的架构的唯一 ID。

Fields

  • SchemaArn— UTF-8 字符串,不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    架构的 Amazon 资源名称 (ARN)。必须提供 SchemaNameSchemaArn 中的一个。

  • SchemaName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    架构的名称。必须提供 SchemaNameSchemaArn 中的一个。

  • RegistryName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    包含该架构的架构注册表的名称。

Operations

CreateCreate_registry 操作 (Python: create_registry)

创建可用于保存架构集合的新注册表。

Request

  • RegistryName:必需 UTF-8 字符串,不少于 1 个字节或超过 255 个字节,与匹配。Custom string pattern #12

    要创建的注册表的名称,其最大长度不得超过 255 个字符,且只能包含字母、数字、连字符、下划线、美元符号或哈希标记。无空格。

  • Description – 描述字符串,长度不超过 2048 个字节,与 URI address multi-line string pattern 匹配。

    注册表的描述。如果未提供描述,则不会有任何默认值。

  • Tags— 键值对的映射数组,不超过 50 对。

    每个键都是一个 UTF-8 字符串,长度不少于 1 个字节或超过 128 个字节。

    每个值是一个 UTF-8 字符串,不超过 256 个字节。

    AWS 标签,其中包含密钥值对,并可以通过控制台、命令行或 API 进行搜索。

Response

  • RegistryArn— UTF-8 字符串,不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    新创建的注册表的 Amazon 资源名称 (ARN)。

  • RegistryName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    注册表的名称。

  • Description – 描述字符串,长度不超过 2048 个字节,与 URI address multi-line string pattern 匹配。

    注册表的描述。

  • Tags— 键值对的映射数组,不超过 50 对。

    每个键都是一个 UTF-8 字符串,长度不少于 1 个字节或超过 128 个字节。

    每个值是一个 UTF-8 字符串,不超过 256 个字节。

    注册表的标签。

Errors

  • InvalidInputException

  • AccessDeniedException

  • AlreadyExistsException

  • ResourceNumberLimitExceededException

  • InternalServiceException

CreateSchemsions 操作 (Python: create_schema)

创建新的架构集并注册模式定义。如果模式集已经存在,但没有实际注册版本,则返回错误。

创建架构集时,版本检查点将设置为第一个版本。兼容模式 “禁用” 限制在第一个架构版本之后添加任何其他架构版本。对于所有其他兼容模式,兼容性设置的验证将仅从第二个版本开始应用RegisterSchemaVersion使用 API。

当调用此 API 时,没有RegistryId,这将为注册表数据库表中的 “默认注册表” 创建一个条目(如果它尚未存在)。

Request

  • 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 #12

    要创建的架构的名称,其最大长度不得超过 255 个字符,且只能包含字母、数字、连字符、下划线、美元符号或哈希标记。无空格。

  • DataFormat:必需 UTF-8 字符串(有效值:AVRO)。

    架构定义的数据格式。目前仅支持 AVRO

  • Compatibility – UTF-8 字符串(有效值:NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL)。

    架构的兼容模式。可能的值包括:

    • :不适用兼容模式。您可以在开发方案中使用此选项,或者如果您不知道要应用于架构的兼容性模式。添加的任何新版本都将被接受,而无需进行兼容性检查。

    • 已禁用:此兼容性选项可防止对特定架构进行版本控制。您可以使用此选项来防止将来对架构进行版本控制。

    • FORWORD:建议使用此兼容性选择,因为它允许数据接收器读取当前和先前的架构版本。这意味着,例如,新架构版本不能删除数据字段或更改这些字段的类型,因此使用先前版本的读者无法读取这些字段。

    • 向后 _ 全部:此兼容性选择允许数据接收器读取当前和所有以前的架构版本。当您需要删除字段或添加可选字段以及检查所有以前架构版本的兼容性时,您可以使用此选项。

    • FORWARD:此兼容性选择允许数据接收器读取当前和下一个架构版本,但不一定是更高版本。当您需要添加字段或删除可选字段时,您可以使用此选项,但仅检查上一个架构版本的兼容性。

    • 转发全部:此兼容性选择允许数据接收器读取任何新注册模式的生产者写入的内容。当您需要添加字段或删除可选字段以及检查所有以前架构版本的兼容性时,您可以使用此选项。

    • FULL:此兼容性选择允许数据接收器读取使用先前版本或下一版本的架构(但不一定是早期版本或更高版本)编写的数据。当您需要添加或删除可选字段时,您可以使用此选项,但仅检查最后一个架构版本的兼容性。

    • 全部:此兼容性选择允许数据接收器读取生产者使用所有以前的架构版本写入的数据。如果需要添加或删除可选字段,并检查所有先前架构版本的兼容性,则可以使用此选项。

  • Description – 描述字符串,长度不超过 2048 个字节,与 URI address multi-line string pattern 匹配。

    架构描述(可选)。如果未提供描述,则不会有任何自动默认值。

  • Tags— 键值对的映射数组,不超过 50 对。

    每个键都是一个 UTF-8 字符串,长度不少于 1 个字节或超过 128 个字节。

    每个值是一个 UTF-8 字符串,不超过 256 个字节。

    AWS 标签,其中包含密钥值对,并可以通过控制台、命令行或 API 进行搜索。如果指定,请遵循创建时 AWS 标记模式。

  • SchemaDefinition— UTF-8 字符串,长度不少于 1 个字节或超过 170000 个字节,与匹配。Custom string pattern #20

    使用 DataFormat 设置 SchemaName 的架构定义。

Response

  • RegistryName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    注册表的名称。

  • RegistryArn— UTF-8 字符串,不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    注册表的 Amazon 资源名称 (ARN)。

  • SchemaName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    架构的名称。

  • SchemaArn— UTF-8 字符串,不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    架构的 Amazon 资源名称 (ARN)。

  • Description – 描述字符串,长度不超过 2048 个字节,与 URI address multi-line string pattern 匹配。

    对架构(如果在创建时指定)的描述。

  • DataFormat – UTF-8 字符串(有效值:AVRO)。

    架构定义的数据格式。目前仅支持 AVRO

  • Compatibility – UTF-8 字符串(有效值:NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL)。

    架构兼容模式。

  • SchemaCheckpoint— 数字(长),不小于 1 或大于 10 万。

    检查点的版本号(上次更改兼容模式时)。

  • LatestSchemaVersion— 数字(长),不小于 1 或大于 10 万。

    与返回的架构定义相关联的架构的最新版本。

  • NextSchemaVersion— 数字(长),不小于 1 或大于 10 万。

    与返回的模式定义相关联的架构的下一个版本。

  • SchemaStatus – UTF-8 字符串(有效值:AVAILABLE | PENDING | DELETING)。

    架构的状态。

  • Tags— 键值对的映射数组,不超过 50 对。

    每个键都是一个 UTF-8 字符串,长度不少于 1 个字节或超过 128 个字节。

    每个值是一个 UTF-8 字符串,不超过 256 个字节。

    架构的标签。

  • SchemaVersionId— UTF-8 字符串,不少于 36 个字节或超过 36 个字节,与匹配。Custom string pattern #11

    第一架构版本的唯一标识符。

  • SchemaVersionStatus— UTF-8 字符串(有效值:AVAILABLE|PENDING|FAILURE|DELETING)。

    创建的第一架构版本的状态。

Errors

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • AlreadyExistsException

  • ResourceNumberLimitExceededException

  • InternalServiceException

GetSchema 操作(Python:get_schema)

详细描述指定的方案。

Request

  • SchemaId:必需 一个 SchemaId 对象。

    这是包含架构标识字段的封装结构。结构包含:

    • 计划迈德美元舍马恩:架构的 Amazon 资源名称 (ARN)。要么SchemaArn或者SchemaNameRegistryName必须提供。

    • 计划美元计划名称:架构的名称。要么SchemaArn或者SchemaNameRegistryName必须提供。

Response

  • RegistryName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    注册表的名称。

  • RegistryArn— UTF-8 字符串,不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    注册表的 Amazon 资源名称 (ARN)。

  • SchemaName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    架构的名称。

  • SchemaArn— UTF-8 字符串,不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    架构的 Amazon 资源名称 (ARN)。

  • Description – 描述字符串,长度不超过 2048 个字节,与 URI address multi-line string pattern 匹配。

    架构(如果在创建时指定)的架构描述

  • DataFormat – UTF-8 字符串(有效值:AVRO)。

    架构定义的数据格式。目前仅支持 AVRO

  • Compatibility – UTF-8 字符串(有效值:NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL)。

    架构的兼容模式。

  • SchemaCheckpoint— 数字(长),不小于 1 或大于 10 万。

    检查点的版本号(上次更改兼容模式时)。

  • LatestSchemaVersion— 数字(长),不小于 1 或大于 10 万。

    与返回的架构定义相关联的架构的最新版本。

  • NextSchemaVersion— 数字(长),不小于 1 或大于 10 万。

    与返回的模式定义相关联的架构的下一个版本。

  • SchemaStatus – UTF-8 字符串(有效值:AVAILABLE | PENDING | DELETING)。

    架构的状态。

  • CreatedTime – UTF-8 字符串。

    创建架构的日期和时间。

  • UpdatedTime – UTF-8 字符串。

    架构的更新日期和时间。

Errors

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

ListSchemma_version 操作 (Python: list_schema _version)

返回已创建的架构版本列表,其中包含最少信息。处于 DeleteTeleteStatus 状态的架构版本将不会包含在结果中。如果没有可用的架构版本,则返回空结果。

Request

  • SchemaId:必需 一个 SchemaId 对象。

    这是包含架构标识字段的封装结构。结构包含:

    • 计划迈德美元舍马恩:架构的 Amazon 资源名称 (ARN)。要么SchemaArn或者SchemaNameRegistryName必须提供。

    • 计划美元计划名称:架构的名称。要么SchemaArn或者SchemaNameRegistryName必须提供。

  • MaxResults— 数字(整数),不小于 1 或大于 100。

    每页所需的最大结果数量。如果未提供该值,则默认值为每页 25。

  • NextToken – UTF-8 字符串。

    延续标记 (如果这是延续调用)。

Response

  • Schemas方案版本列表 对象的数组。

    数组SchemaVersionList对象,包含每个架构版本的详细信息。

  • NextToken – UTF-8 字符串。

    对返回的标记列表进行分页的延续令牌 (如果列表的当前片段不是最后一个,则返回)。

Errors

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

GetSchemma_schema 操作 (Python: get_schema _version)

通过在创建或注册模式版本时分配的唯一 ID 获取指定架构。处于 DeleteTeleteStatus 状态的架构版本将不会包含在结果中。

Request

  • SchemaId – 一个 SchemaId 对象。

    这是包含架构标识字段的封装结构。结构包含:

    • 计划迈德美元舍马恩:架构的 Amazon 资源名称 (ARN)。要么SchemaArn或者SchemaNameRegistryName必须提供。

    • 计划美元计划名称:架构的名称。要么SchemaArn或者SchemaNameRegistryName必须提供。

  • SchemaVersionId— UTF-8 字符串,不少于 36 个字节或超过 36 个字节,与匹配。Custom string pattern #11

    这些区域有:SchemaVersionIdschema 版本的日期和时间。此字段是按模式 ID 进行读取的必填字段。这个或SchemaId必须提供包装器。

  • SchemaVersionNumber – 一个 SchemaVersionNumber 对象。

    架构的版本号。

Response

  • SchemaVersionId— UTF-8 字符串,不少于 36 个字节或超过 36 个字节,与匹配。Custom string pattern #11

    这些区域有:SchemaVersionIdschema 版本的日期和时间。

  • SchemaDefinition— UTF-8 字符串,长度不少于 1 个字节或超过 170000 个字节,与匹配。Custom string pattern #20

    架构 ID 的架构定义。

  • DataFormat – UTF-8 字符串(有效值:AVRO)。

    架构定义的数据格式。目前仅支持 AVRO

  • SchemaArn— UTF-8 字符串,不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    架构的 Amazon 资源名称 (ARN)。

  • VersionNumber— 数字(长),不小于 1 或大于 10 万。

    架构的版本号。

  • Status— UTF-8 字符串(有效值:AVAILABLE|PENDING|FAILURE|DELETING)。

    架构版本的状态。

  • CreatedTime – UTF-8 字符串。

    架构版本的创建日期和时间。

Errors

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

Get架构版本比较操作(Python: get_schema _version _version _diff)

获取模式注册表中两个存储模式版本之间指定差异类型的模式版本差异。

此 API 允许您比较同一架构下的两个架构定义之间的两个架构版本。

Request

  • SchemaId:必需 一个 SchemaId 对象。

    这是包含架构标识字段的封装结构。结构包含:

    • 计划迈德美元舍马恩:架构的 Amazon 资源名称 (ARN)。必须提供 SchemaNameSchemaArn 中的一个。

    • 计划美元计划名称:架构的名称。必须提供 SchemaNameSchemaArn 中的一个。

  • FirstSchemaVersionNumber:必需 一个 SchemaVersionNumber 对象。

    要比较的两个架构版本中的第一个版本。

  • SecondSchemaVersionNumber:必需 一个 SchemaVersionNumber 对象。

    要比较的两个架构版本中的第二个版本。

  • SchemaDiffType:必需 UTF-8 字符串(有效值:SYNTAX_DIFF)。

    参考SYNTAX_DIFF,这是当前支持的差异类型。

Response

  • Diff— UTF-8 字符串,长度不少于 1 个字节或超过 340000 个字节,与匹配。Custom string pattern #20

    作为 JSONPatch 格式的字符串的架构之间的区别。

Errors

  • InvalidInputException

  • EntityNotFoundException

  • AccessDeniedException

  • InternalServiceException

ListCrestCreate_registry 操作 (Python: list_注册表)

返回您已创建的注册表列表,其中包含最少的注册表信息。注册表Deleting状态将不会包含在结果中。如果没有可用的注册表,将返回空结果。

Request

  • MaxResults— 数字(整数),不小于 1 或大于 100。

    每页所需的最大结果数量。如果未提供该值,则默认值为每页 25。

  • NextToken – UTF-8 字符串。

    延续标记 (如果这是延续调用)。

Response

  • Registries注册表项 对象的数组。

    数组RegistryDetailedListItem对象,其中包含每个注册表的最小细节。

  • NextToken – UTF-8 字符串。

    对返回的标记列表进行分页的延续令牌 (如果列表的当前片段不是最后一个,则返回)。

Errors

  • InvalidInputException

  • AccessDeniedException

  • InternalServiceException

ListSchemas 操作 (Python: list_schema)

返回具有最小详细信息的架构列表。处于 “删除” 状态的架构将不会包含在结果中。如果没有可用的架构,则返回空结果。

RegistryId,则跨注册表的所有模式都将成为 API 响应的一部分。

Request

  • RegistryId – 一个 RegistryId 对象。

    包装结构,可能包含注册表名称和 Amazon 资源名称 (ARN)。

  • MaxResults— 数字(整数),不小于 1 或大于 100。

    每页所需的最大结果数量。如果未提供该值,则默认值为每页 25。

  • NextToken – UTF-8 字符串。

    延续标记 (如果这是延续调用)。

Response

  • Schemas架构 对象的数组。

    数组SchemaListItem对象,包含每个模式的详细信息。

  • NextToken – UTF-8 字符串。

    对返回的标记列表进行分页的延续令牌 (如果列表的当前片段不是最后一个,则返回)。

Errors

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

注册表架构版本操作 (Python: 注册_schema _version)

将新版本添加到现有架构。如果新版本的架构不符合架构集的兼容性要求,则返回错误。如果架构集尚未存在于架构注册表中,此 API 将不会创建新的架构集,并返回 404 错误。

如果这是要在模式注册表中注册的第一个模式定义,则此 API 将存储架构版本并立即返回。否则,由于兼容模式,此调用可能会比其他操作运行时间长。您可以调用GetSchemaVersion使用的 APISchemaVersionId来检查兼容性模式。

如果同一架构定义已作为版本存储在架构注册表中,则现有架构的架构 ID 将返回给调用者。

Request

  • SchemaId:必需 一个 SchemaId 对象。

    这是包含架构标识字段的封装结构。结构包含:

    • 计划迈德美元舍马恩:架构的 Amazon 资源名称 (ARN)。要么SchemaArn或者SchemaNameRegistryName必须提供。

    • 计划美元计划名称:架构的名称。要么SchemaArn或者SchemaNameRegistryName必须提供。

  • SchemaDefinition:必需 UTF-8 字符串,不少于 1 个字节或超过 170000 个字节,与匹配。Custom string pattern #20

    使用DataFormat设置SchemaName

Response

  • SchemaVersionId— UTF-8 字符串,不少于 36 个字节或超过 36 个字节,与匹配。Custom string pattern #11

    表示此架构版本的唯一 ID。

  • VersionNumber— 数字(长),不小于 1 或大于 10 万。

    此架构的版本(仅适用于同步流,以防这是第一个版本)。

  • Status— UTF-8 字符串(有效值:AVAILABLE|PENDING|FAILURE|DELETING)。

    架构版本的状态。

Errors

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • ResourceNumberLimitExceededException

  • ConcurrentModificationException

  • InternalServiceException

Update架构操作 (Python: update_schema)

更新架构集的描述、兼容性设置或版本检查点。

为了更新兼容性设置,调用不会验证整个架构版本集与新兼容性设置的兼容性。如果CompatibilityVersionNumber(检查站) 也是必需的. API 将验证检查点版本号以保持一致性。

如果VersionNumber(检查站),Compatibility是可选的,这可用于设置/重置架构的检查点。

仅当架构处于 “可用” 状态时,才会发生此更新。

Request

  • SchemaId:必需 一个 SchemaId 对象。

    这是包含架构标识字段的封装结构。结构包含:

    • 计划迈德美元舍马恩:架构的 Amazon 资源名称 (ARN)。必须提供 SchemaNameSchemaArn 中的一个。

    • 计划美元计划名称:架构的名称。必须提供 SchemaNameSchemaArn 中的一个。

  • SchemaVersionNumber – 一个 SchemaVersionNumber 对象。

    检查指向所需的版本号。必须提供 CompatibilityVersionNumber 中的一个。

  • Compatibility – UTF-8 字符串(有效值:NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL)。

    架构的新兼容性设置。

  • Description – 描述字符串,长度不超过 2048 个字节,与 URI address multi-line string pattern 匹配。

    架构的新描述。

Response

  • SchemaArn— UTF-8 字符串,长度不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    架构的 Amazon 资源名称 (ARN)。

  • SchemaName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    架构的名称。

  • RegistryName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    包含该架构的注册表的名称。

Errors

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • ConcurrentModificationException

  • InternalServiceException

检查模式版本有效性操作(Python:检查方案版本有效性)

验证提供的模式。这个调用没有副作用,它只是使用DataFormat作为格式。由于它不采用架构集名称,因此不会执行兼容性检查。

Request

  • DataFormat:必需 UTF-8 字符串(有效值:AVRO)。

    架构定义的数据格式。目前仅支持 AVRO

  • SchemaDefinition:必需 UTF-8 字符串,不少于 1 个字节或超过 170000 个字节,与匹配。Custom string pattern #20

    必须验证的架构的定义。

Response

  • Valid – Boolean.

    如果模式有效,则返回 true,否则返回 false。

  • Error— UTF-8 字符串,不少于 1 个字节或超过 5000 个字节。

    验证失败错误消息。

Errors

  • InvalidInputException

  • AccessDeniedException

  • InternalServiceException

UpdateCreate_注册表操作 (Python: update_registry)

更新用于保存架构集合的现有注册表。更新的属性与注册表相关,并且不会修改注册表中的任何模式。

Request

  • RegistryId:必需 一个 RegistryId 对象。

    这是一个包装结构,其中可能包含注册表名称和 Amazon 资源名称 (ARN)。

  • Description:必需 Description 字符串,长度不超过 2048 个字节,与匹配。URI address multi-line string pattern

    注册表的描述。如果未提供描述,则不会更新此字段。

Response

  • RegistryName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    更新后的注册表的名称。

  • RegistryArn— UTF-8 字符串,长度不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    已更新的注册表的 Amazon 资源名称 (ARN)。

Errors

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • ConcurrentModificationException

  • InternalServiceException

GetSchemyFin义操作 (Python: get_schema)

通过SchemaDefinition。架构定义将发送到架构注册表、规范化和散列。如果哈希在SchemaName或 ARN(或默认注册表,如果未提供),则返回该架构的元数据。否则,将返回 404 或未找到错误。中的架构版本Deleted状态将不会包含在结果中。

Request

  • SchemaId:必需 一个 SchemaId 对象。

    这是包含架构标识字段的封装结构。结构包含:

    • 计划迈德美元舍马恩:架构的 Amazon 资源名称 (ARN)。必须提供 SchemaNameSchemaArn 中的一个。

    • 计划美元计划名称:架构的名称。必须提供 SchemaNameSchemaArn 中的一个。

  • SchemaDefinition:必需 UTF-8 字符串,不少于 1 个字节或超过 170000 个字节,与匹配。Custom string pattern #20

    需要方案详细信息的方案的定义。

Response

  • SchemaVersionId— UTF-8 字符串,不少于 36 个字节或超过 36 个字节,与匹配。Custom string pattern #11

    架构版本的架构 ID。

  • SchemaArn— UTF-8 字符串,长度不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    架构的 Amazon 资源名称 (ARN)。

  • DataFormat – UTF-8 字符串(有效值:AVRO)。

    架构定义的数据格式。目前仅支持 AVRO

  • Status— UTF-8 字符串(有效值:AVAILABLE|PENDING|FAILURE|DELETING)。

    架构版本的状态。

  • CreatedTime – UTF-8 字符串。

    架构的创建日期和时间。

Errors

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

GetTimtes 操作 (Python: get_registry)

详细描述指定的注册表。

Request

  • RegistryId:必需 一个 RegistryId 对象。

    这是一个包装结构,其中可能包含注册表名称和 Amazon 资源名称 (ARN)。

Response

  • RegistryName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    注册表的名称。

  • RegistryArn— UTF-8 字符串,长度不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    注册表的 Amazon 资源名称 (ARN)。

  • Description – 描述字符串,长度不超过 2048 个字节,与 URI address multi-line string pattern 匹配。

    注册表的描述。

  • Status – UTF-8 字符串(有效值:AVAILABLE | DELETING)。

    注册表的状态。

  • CreatedTime – UTF-8 字符串。

    创建注册表的日期和时间。

  • UpdatedTime – UTF-8 字符串。

    注册表的更新日期和时间。

Errors

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

Put架构版本控制元数据操作 (Python: put_schema _version _version)

放置指定架构版本 ID 的元数据密钥值对。每个架构版本最多允许 10 个密钥值对。它们可以通过一个或多个呼叫添加。

Request

  • SchemaId – 一个 SchemaId 对象。

    架构的唯一 ID。

  • SchemaVersionNumber – 一个 SchemaVersionNumber 对象。

    架构的版本号。

  • SchemaVersionId— UTF-8 字符串,不少于 36 个字节或超过 36 个字节,与匹配。Custom string pattern #11

    架构版本的唯一版本 ID。

  • MetadataKeyValue:必需 一个 元数据密钥值对 对象。

    元数据键的相应值。

Response

  • SchemaArn— UTF-8 字符串,长度不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    架构的 Amazon 资源名称 (ARN)。

  • SchemaName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    架构的名称。

  • RegistryName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    注册表的名称。

  • LatestVersion – Boolean.

    架构的最新版本。

  • VersionNumber— 数字(长),不小于 1 或大于 10 万。

    架构的版本号。

  • SchemaVersionId— UTF-8 字符串,不少于 36 个字节或超过 36 个字节,与匹配。Custom string pattern #11

    架构版本的唯一版本 ID。

  • MetadataKey— UTF-8 字符串,不少于 1 个字节或超过 128 个字节,与匹配。Custom string pattern #21

    元数据密钥。

  • MetadataValue— UTF-8 字符串,不少于 1 个字节或超过 256 个字节,与匹配。Custom string pattern #21

    元数据键的值。

Errors

  • InvalidInputException

  • AccessDeniedException

  • AlreadyExistsException

  • EntityNotFoundException

  • ResourceNumberLimitExceededException

查询版本元数据操作(Python:查询方案版本元数据)

查询架构版本元数据信息。

Request

  • SchemaId – 一个 SchemaId 对象。

    包装结构,可能包含架构名称和 Amazon 资源名称 (ARN)。

  • SchemaVersionNumber – 一个 SchemaVersionNumber 对象。

    架构的版本号。

  • SchemaVersionId— UTF-8 字符串,不少于 36 个字节或超过 36 个字节,与匹配。Custom string pattern #11

    架构版本的唯一版本 ID。

  • MetadataList元数据密钥值对 对象的数组。

    搜索元数据的键值对,如果未提供元数据,则将获取所有元数据信息。

  • MaxResults— 数字(整数),不小于 1 或大于 50。

    每页所需的最大结果数量。如果未提供该值,则默认值为每页 25。

  • NextToken – UTF-8 字符串。

    延续标记 (如果这是延续调用)。

Response

  • MetadataInfoMap – 键值对的映射数组。

    每个键是一个 UTF-8 字符串,长度不少于 1 个字节或超过 128 个字节,与匹配。Custom string pattern #21

    每个值是一个元数据信息对象。

    元数据键和关联值的映射。

  • SchemaVersionId— UTF-8 字符串,不少于 36 个字节或超过 36 个字节,与匹配。Custom string pattern #11

    架构版本的唯一版本 ID。

  • NextToken – UTF-8 字符串。

    对返回的标记列表进行分页的延续令牌 (如果列表的当前片段不是最后一个,则返回)。

Errors

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

删除版本元数据操作(Python:删除模式版本元数据)

从指定架构版本 ID 的架构版本元数据中删除键值对。

Request

  • SchemaId – 一个 SchemaId 对象。

    包装结构,可能包含架构名称和 Amazon 资源名称 (ARN)。

  • SchemaVersionNumber – 一个 SchemaVersionNumber 对象。

    架构的版本号。

  • SchemaVersionId— UTF-8 字符串,不少于 36 个字节或超过 36 个字节,与匹配。Custom string pattern #11

    架构版本的唯一版本 ID。

  • MetadataKeyValue:必需 一个 元数据密钥值对 对象。

    元数据键的值。

Response

  • SchemaArn— UTF-8 字符串,长度不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    架构的 Amazon 资源名称 (ARN)。

  • SchemaName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    架构的名称。

  • RegistryName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    注册表的名称。

  • LatestVersion – Boolean.

    架构的最新版本。

  • VersionNumber— 数字(长),不小于 1 或大于 10 万。

    架构的版本号。

  • SchemaVersionId— UTF-8 字符串,不少于 36 个字节或超过 36 个字节,与匹配。Custom string pattern #11

    架构版本的版本 ID。

  • MetadataKey— UTF-8 字符串,不少于 1 个字节或超过 128 个字节,与匹配。Custom string pattern #21

    元数据密钥。

  • MetadataValue— UTF-8 字符串,不少于 1 个字节或超过 256 个字节,与匹配。Custom string pattern #21

    元数据键的值。

Errors

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

DeleteCreateCreate_registry 操作 (Python: delete_registry)

删除包含架构及其所有版本的整个注册表。要获取删除操作的状态,您可以调用GetRegistryAPI 在异步调用后。删除注册表将停用注册表的所有联机操作,如UpdateRegistryCreateSchemaUpdateSchema, 和RegisterSchemaVersionAPI。

Request

  • RegistryId:必需 一个 RegistryId 对象。

    这是一个包装结构,其中可能包含注册表名称和 Amazon 资源名称 (ARN)。

Response

  • RegistryName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    正在删除的注册表的名称。

  • RegistryArn— UTF-8 字符串,长度不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    要删除的注册表的 Amazon 资源名称 (ARN)。

  • Status – UTF-8 字符串(有效值:AVAILABLE | DELETING)。

    注册表的状态。成功的操作将返回Deleting状态。

Errors

  • InvalidInputException

  • EntityNotFoundException

  • AccessDeniedException

  • ConcurrentModificationException

DeleteSchema sions 操作 (Python: delete_schema)

删除整个架构集,包括架构集及其所有版本。要获取 DeleteDelete 操作的状态,您可以调用GetSchemaAPI 在异步调用后。删除注册表将停用模式的所有联机操作,例如GetSchemaByDefinition, 和RegisterSchemaVersionAPI。

Request

  • SchemaId:必需 一个 SchemaId 对象。

    这是一个包装结构,可能包含架构名称和 Amazon 资源名称 (ARN)。

Response

  • SchemaArn— UTF-8 字符串,长度不少于 1 个字节或超过 10240 个字节,与匹配。AWS Glue ARN string pattern

    要删除的架构的 Amazon 资源名称 (ARN)。

  • SchemaName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Custom string pattern #12 匹配。

    正在删除的架构的名称。

  • Status – UTF-8 字符串(有效值:AVAILABLE | PENDING | DELETING)。

    架构的状态。

Errors

  • InvalidInputException

  • EntityNotFoundException

  • AccessDeniedException

  • ConcurrentModificationException

DeleteSchemmaVersion 操作 (Python: delete_schema)

从指定架构中删除版本。可以提供版本号或范围。如果兼容模式禁止删除必要的版本(如 BACKWARDS_FULL),则返回错误。调用GetSchemaVersions此调用后的 API 将列出已删除版本的状态。

当版本号范围包含检查指向版本时,API 将返回 409 冲突,并且不会继续删除操作。您必须首先使用DeleteSchemaCheckpointAPI,然后再使用此 API。

您无法使用DeleteSchemaVersionsAPI 删除架构集中的第一个架构版本。第一个架构版本只能通过DeleteSchemaAPI。此操作还将删除附加的SchemaVersionMetadata在架构版本下。硬删除将在数据库上强制执行。

如果兼容模式禁止删除必要的版本(如 BACKWARDS_FULL),则返回错误。

Request

  • SchemaId:必需 一个 SchemaId 对象。

    这是一个包装结构,可能包含架构名称和 Amazon 资源名称 (ARN)。

  • Versions:必需 UTF-8 字符串,不少于 1 个字节或超过 100000 个字节,与匹配。Custom string pattern #22

    可以提供一个版本范围,其格式可能为:

    • 单个版本号,5

    • 5-8:删除版本 5、6、7、8

Response

  • SchemaVersionErrors方案版本错误项目 对象的数组。

    列表SchemaVersionErrorItem对象,每个对象都包含错误和架构版本。

Errors

  • InvalidInputException

  • EntityNotFoundException

  • AccessDeniedException

  • ConcurrentModificationException