# AWS Glue API
<a name="aws-glue-api"></a>

本节介绍 AWS Glue 软件开发工具包 (SDK) 和工具所使用的数据类型和原语。有三种通用方法可在 AWS Glue 之外以编程方式与 AWS 管理控制台 交互，每种方法都有自己的文档：
+  语言软件开发工具包 (SDK) 库允许您访问来自常用编程语言的 AWS 资源。请在[用于在 AWS 上进行构建的工具](https://aws.amazon.com/tools/)查找更多信息。
+  AWS CLI 允许您访问来自命令行的 AWS 资源。请在 [AWS CLI命令参考](https://docs.aws.amazon.com/cli/latest/reference/)查找更多信息。
+  CloudFormation 允许您定义一组要一致地共同预调配的 AWS 资源。请在 [CloudFormation：AWS Glue 资源类型参考](https://docs.aws.amazon.com/en_us/AWSCloudFormation/latest/UserGuide/AWS_Glue.html)查找更多信息。

 本节记录了独立于这些软件开发工具包 (SDK) 和工具的共享原语。工具使用 [AWS Glue Web API 参考](https://docs.aws.amazon.com/glue/latest/webapi/WebAPI_Welcome.html)与 AWS 通信。

**Contents**
+ [AWS Glue 中的安全性 API](aws-glue-api-jobs-security.md)
  + [数据类型](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-objects)
  + [DataCatalogEncryptionSettings 结构](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-DataCatalogEncryptionSettings)
  + [EncryptionAtRest 结构](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-EncryptionAtRest)
  + [ConnectionPasswordEncryption 结构](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-ConnectionPasswordEncryption)
  + [EncryptionConfiguration 结构](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-EncryptionConfiguration)
  + [S3Encryption 结构](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-S3Encryption)
  + [CloudWatchEncryption 结构](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-CloudWatchEncryption)
  + [JobBookmarksEncryption 结构](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-JobBookmarksEncryption)
  + [SecurityConfiguration 结构](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-SecurityConfiguration)
  + [GluePolicy 结构](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-GluePolicy)
  + [DataQualityEncryption 结构](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-DataQualityEncryption)
  + [操作](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-actions)
  + [GetDataCatalogEncryptionSettings 操作（Python：get\$1data\$1catalog\$1encryption\$1settings）](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-GetDataCatalogEncryptionSettings)
  + [PutDataCatalogEncryptionSettings 操作（Python： put\$1data\$1catalog\$1encryption\$1settings）](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-PutDataCatalogEncryptionSettings)
  + [PutResourcePolicy 操作（Python：put\$1resource\$1policy）](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-PutResourcePolicy)
  + [GetResourcePolicy 操作（Python：get\$1resource\$1policy）](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-GetResourcePolicy)
  + [DeleteResourcePolicy 操作（Python：delete\$1resource\$1policy）](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-DeleteResourcePolicy)
  + [CreateSecurityConfiguration 操作（Python：create\$1security\$1configuration）](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-CreateSecurityConfiguration)
  + [DeleteSecurityConfiguration 操作（Python：delete\$1security\$1configuration）](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-DeleteSecurityConfiguration)
  + [GetSecurityConfiguration 操作（Python：get\$1security\$1configuration）](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-GetSecurityConfiguration)
  + [GetSecurityConfigurations 操作（Python：get\$1security\$1configurations）](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-GetSecurityConfigurations)
  + [GetResourcePolicies 操作（Python：get\$1resource\$1policie）](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-GetResourcePolicies)
+ [目录对象 API](aws-glue-api-catalog.md)
  + [目录 API](aws-glue-api-catalog-catalogs.md)
    + [数据类型](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-objects)
    + [目录结构](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-Catalog)
    + [CatalogInput 结构](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-CatalogInput)
    + [TargetRedshiftCatalog 结构](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-TargetRedshiftCatalog)
    + [CatalogProperties 结构](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-CatalogProperties)
    + [CatalogPropertiesOutput 结构](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-CatalogPropertiesOutput)
    + [DataLakeAccessProperties 结构](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-DataLakeAccessProperties)
    + [IcebergOptimizationProperties 结构](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-IcebergOptimizationProperties)
    + [DataLakeAccessPropertiesOutput 结构](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-DataLakeAccessPropertiesOutput)
    + [IcebergOptimizationPropertiesOutput 结构](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-IcebergOptimizationPropertiesOutput)
    + [FederatedCatalog 结构](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-FederatedCatalog)
    + [操作](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-actions)
    + [CreateCatalog 操作（Python：create\$1catalog）](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-CreateCatalog)
    + [UpdateCatalog 操作（Python：update\$1catalog）](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-UpdateCatalog)
    + [DeleteCatalog 操作（Python：delete\$1catalog）](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-DeleteCatalog)
    + [GetCatalog 操作（Python：get\$1catalog）](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-GetCatalog)
    + [GetCatalogs 操作（Python：get\$1catalogs）](aws-glue-api-catalog-catalogs.md#aws-glue-api-catalog-catalogs-GetCatalogs)
  + [数据库 API](aws-glue-api-catalog-databases.md)
    + [数据类型](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-objects)
    + [Database 结构](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-Database)
    + [DatabaseInput 结构](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-DatabaseInput)
    + [PrincipalPermissions 结构](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions)
    + [DataLakePrincipal 结构](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-DataLakePrincipal)
    + [DatabaseIdentifier 结构](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-DatabaseIdentifier)
    + [联合数据库结构](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-FederatedDatabase)
    + [操作](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-actions)
    + [CreateDatabase 操作（Python：create\$1database）](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-CreateDatabase)
    + [UpdateDatabase 操作（Python：update\$1database）](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-UpdateDatabase)
    + [DeleteDatabase 操作（Python：delete\$1database）](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-DeleteDatabase)
    + [GetDatabase 操作（Python：get\$1database）](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-GetDatabase)
    + [GetDatabases 操作（Python：get\$1databases）](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-GetDatabases)
  + [表 API](aws-glue-api-catalog-tables.md)
    + [数据类型](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-objects)
    + [Table 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-Table)
    + [TableInput 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-TableInput)
    + [联合表结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-FederatedTable)
    + [列结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-Column)
    + [StorageDescriptor 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-StorageDescriptor)
    + [SchemaReference 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-SchemaReference)
    + [SerDeInfo 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-SerDeInfo)
    + [Order 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-Order)
    + [SkewedInfo 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-SkewedInfo)
    + [TableVersion 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-TableVersion)
    + [TableError 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-TableError)
    + [TableVersionError 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-TableVersionError)
    + [SortCriterion 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-SortCriterion)
    + [TableIdentifier 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-TableIdentifier)
    + [KeySchemaElement 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-KeySchemaElement)
    + [PartitionIndex 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-PartitionIndex)
    + [PartitionIndexDescriptor 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-PartitionIndexDescriptor)
    + [BackfillError 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-BackfillError)
    + [IcebergInput 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-IcebergInput)
    + [OpenTableFormatInput 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-OpenTableFormatInput)
    + [ViewDefinition 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-ViewDefinition)
    + [ViewDefinitionInput 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-ViewDefinitionInput)
    + [ViewRepresentation 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-ViewRepresentation)
    + [ViewRepresentationInput 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-ViewRepresentationInput)
    + [UpdateOpenTableFormatInput 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-UpdateOpenTableFormatInput)
    + [UpdateIcebergInput 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-UpdateIcebergInput)
    + [CreateIcebergTableInput 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-CreateIcebergTableInput)
    + [UpdateIcebergTableInput 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-UpdateIcebergTableInput)
    + [IcebergSortOrder 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-IcebergSortOrder)
    + [IcebergSortField 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-IcebergSortField)
    + [IcebergPartitionSpec 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-IcebergPartitionSpec)
    + [IcebergPartitionField 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-IcebergPartitionField)
    + [IcebergSchema 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-IcebergSchema)
    + [IcebergStructField 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-IcebergStructField)
    + [IcebergTableUpdate 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-IcebergTableUpdate)
    + [AuditContext 结构](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-AuditContext)
    + [操作](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-actions)
    + [CreateTable 操作（Python：create\$1table）](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-CreateTable)
    + [UpdateTable 操作（Python：update\$1table）](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-UpdateTable)
    + [DeleteTable 操作（Python：delete\$1table）](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-DeleteTable)
    + [BatchDeleteTable 操作（Python：batch\$1delete\$1table）](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-BatchDeleteTable)
    + [GetTable 操作（Python：get\$1table）](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-GetTable)
    + [GetTables 操作（Python：get\$1tables）](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-GetTables)
    + [GetTableVersion 操作（Python：get\$1table\$1version）](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-GetTableVersion)
    + [GetTableVersions 操作（Python：get\$1table\$1versions）](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-GetTableVersions)
    + [DeleteTableVersion 操作（Python：delete\$1table\$1version）](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-DeleteTableVersion)
    + [BatchDeleteTableVersion 操作（Python：batch\$1delete\$1table\$1version）](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-BatchDeleteTableVersion)
    + [SearchTables 操作（Python：search\$1tables）](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-SearchTables)
    + [GetPartitionIndexes 操作（Python：get\$1partition\$1indexes）](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-GetPartitionIndexes)
    + [CreatePartitionIndex 操作（Python：create\$1partition\$1index）](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-CreatePartitionIndex)
    + [DeletePartitionIndex 操作（Python：delete\$1partition\$1index）](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-DeletePartitionIndex)
    + [GetColumnStatisticsForTable 操作（Python：get\$1column\$1statistics\$1for\$1table）](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-GetColumnStatisticsForTable)
    + [UpdateColumnStatisticsForTable 操作（Python：update\$1column\$1statistics\$1for\$1table）](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-UpdateColumnStatisticsForTable)
    + [DeleteColumnStatisticsForTable 操作（Python：delete\$1column\$1statistics\$1for\$1table）](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-DeleteColumnStatisticsForTable)
  + [分区 API](aws-glue-api-catalog-partitions.md)
    + [数据类型](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-objects)
    + [Partition 结构](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-Partition)
    + [PartitionInput 结构](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-PartitionInput)
    + [PartitionSpecWithSharedStorageDescriptor 结构](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-PartitionSpecWithSharedStorageDescriptor)
    + [PartitionListComposingSpec 结构](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-PartitionListComposingSpec)
    + [PartitionSpecProxy 结构](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-PartitionSpecProxy)
    + [PartitionValueList 结构](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-PartitionValueList)
    + [Segment 结构](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-Segment)
    + [PartitionError 结构](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-PartitionError)
    + [BatchUpdatePartitionFailureEntry 结构](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-BatchUpdatePartitionFailureEntry)
    + [BatchUpdatePartitionRequestEntry 结构](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-BatchUpdatePartitionRequestEntry)
    + [StorageDescriptor 结构](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-StorageDescriptor)
    + [SchemaReference 结构](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SchemaReference)
    + [SerDeInfo 结构](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SerDeInfo)
    + [SkewedInfo 结构](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SkewedInfo)
    + [操作](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-actions)
    + [CreatePartition 操作（Python：create\$1partition）](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-CreatePartition)
    + [BatchCreatePartition 操作（Python：batch\$1create\$1partition）](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-BatchCreatePartition)
    + [UpdatePartition 操作（Python：update\$1partition）](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-UpdatePartition)
    + [DeletePartition 操作（Python：delete\$1partition）](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-DeletePartition)
    + [BatchDeletePartition 操作（Python：batch\$1delete\$1partition）](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-BatchDeletePartition)
    + [GetPartition 操作（Python：get\$1partition）](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-GetPartition)
    + [GetPartitions 操作（Python：get\$1partitions）](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-GetPartitions)
    + [BatchGetPartition 操作（Python：batch\$1get\$1partition）](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-BatchGetPartition)
    + [BatchUpdatePartition 操作（Python：batch\$1update\$1partition）](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-BatchUpdatePartition)
    + [GetColumnStatisticsForPartition 操作（Python：get\$1column\$1statistics\$1for\$1partition）](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-GetColumnStatisticsForPartition)
    + [UpdateColumnStatisticsForPartition 操作（Python：update\$1column\$1statistics\$1for\$1partition）](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-UpdateColumnStatisticsForPartition)
    + [DeleteColumnStatisticsForPartition 操作（Python：delete\$1column\$1statistics\$1for\$1partition）](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-DeleteColumnStatisticsForPartition)
  + [连接 API](aws-glue-api-catalog-connections.md)
    + [连接 API](aws-glue-api-catalog-connections-connections.md)
      + [数据类型](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-objects)
      + [Connection 结构](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-Connection)
      + [ConnectionInput 结构](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-ConnectionInput)
      + [TestConnectionInput 结构](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-TestConnectionInput)
      + [PhysicalConnectionRequirements 结构](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements)
      + [GetConnectionsFilter 结构](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-GetConnectionsFilter)
      + [AuthenticationConfiguration 结构](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-AuthenticationConfiguration)
      + [AuthenticationConfigurationInput 结构](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput)
      + [OAuth2Properties 结构](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-OAuth2Properties)
      + [OAuth2PropertiesInput 结构](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput)
      + [OAuth2ClientApplication 结构](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication)
      + [AuthorizationCodeProperties 结构](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties)
      + [BasicAuthenticationCredentials 结构](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials)
      + [OAuth2Credentials 结构](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-OAuth2Credentials)
      + [操作](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-actions)
      + [CreateConnection 操作（Python：create\$1connection）](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-CreateConnection)
      + [DeleteConnection 操作（Python：delete\$1connection）](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-DeleteConnection)
      + [GetConnection 操作（Python：get\$1connection）](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-GetConnection)
      + [GetConnections 操作（Python：get\$1connections）](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-GetConnections)
      + [UpdateConnection 操作（Python：update\$1connection）](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-UpdateConnection)
      + [TestConnection 操作（Python：test\$1connection）](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-TestConnection)
      + [BatchDeleteConnection 操作（Python：batch\$1delete\$1connection）](aws-glue-api-catalog-connections-connections.md#aws-glue-api-catalog-connections-connections-BatchDeleteConnection)
    + [连接类型 API](aws-glue-api-catalog-connections-connections-type.md)
      + [连接管理 API](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-connection-management)
      + [DescribeConnectionType 操作（Python：describe\$1connection\$1type）](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-DescribeConnectionType)
      + [ListConnectionTypes 操作（Python：list\$1connection\$1types）](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-ListConnectionTypes)
      + [ConnectionTypeBrief 结构](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief)
      + [ConnectionTypeVariant 结构](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant)
      + [数据类型](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-connection-types)
      + [验证结构](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-Validation)
      + [AuthConfiguration 结构](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-AuthConfiguration)
      + [功能结构](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-Capabilities)
      + [属性结构](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-Property)
      + [AllowedValue 结构](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-AllowedValue)
      + [ComputeEnvironmentConfiguration 结构](aws-glue-api-catalog-connections-connections-type.md#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration)
    + [连接元数据和预览 API](aws-glue-api-catalog-connections-connections-metadata.md)
      + [数据类型](aws-glue-api-catalog-connections-connections-metadata.md#aws-glue-api-catalog-connections-connections-metadata-objects)
      + [元数据](aws-glue-api-catalog-connections-connections-metadata.md#aws-glue-api-catalog-connections-connections-metadata-Entity)
      + [字段结构](aws-glue-api-catalog-connections-connections-metadata.md#aws-glue-api-catalog-connections-connections-metadata-Field)
      + [操作](aws-glue-api-catalog-connections-connections-metadata.md#aws-glue-api-catalog-connections-connections-metadata-actions)
      + [ListEntities 操作（Python：list\$1entities）](aws-glue-api-catalog-connections-connections-metadata.md#aws-glue-api-catalog-connections-connections-metadata-ListEntities)
      + [DescribeEntity 操作（Python：describe\$1entity)](aws-glue-api-catalog-connections-connections-metadata.md#aws-glue-api-catalog-connections-connections-metadata-DescribeEntity)
      + [GetEntityRecords 操作（Python：get\$1entity\$1records）](aws-glue-api-catalog-connections-connections-metadata.md#aws-glue-api-catalog-connections-connections-metadata-GetEntityRecords)
  + [用户定义的函数 API](aws-glue-api-catalog-functions.md)
    + [数据类型](aws-glue-api-catalog-functions.md#aws-glue-api-catalog-functions-objects)
    + [UserDefinedFunction 结构](aws-glue-api-catalog-functions.md#aws-glue-api-catalog-functions-UserDefinedFunction)
    + [UserDefinedFunctionInput 结构](aws-glue-api-catalog-functions.md#aws-glue-api-catalog-functions-UserDefinedFunctionInput)
    + [操作](aws-glue-api-catalog-functions.md#aws-glue-api-catalog-functions-actions)
    + [CreateUserDefinedFunction 操作（Python：create\$1user\$1defined\$1function）](aws-glue-api-catalog-functions.md#aws-glue-api-catalog-functions-CreateUserDefinedFunction)
    + [UpdateUserDefinedFunction 操作（Python：update\$1user\$1defined\$1function）](aws-glue-api-catalog-functions.md#aws-glue-api-catalog-functions-UpdateUserDefinedFunction)
    + [DeleteUserDefinedFunction 操作（Python：delete\$1user\$1defined\$1function）](aws-glue-api-catalog-functions.md#aws-glue-api-catalog-functions-DeleteUserDefinedFunction)
    + [GetUserDefinedFunction 操作（Python：get\$1user\$1defined\$1function）](aws-glue-api-catalog-functions.md#aws-glue-api-catalog-functions-GetUserDefinedFunction)
    + [GetUserDefinedFunctions 操作（Python：get\$1user\$1defined\$1functions）](aws-glue-api-catalog-functions.md#aws-glue-api-catalog-functions-GetUserDefinedFunctions)
  + [将 Athena 目录导入 AWS Glue](aws-glue-api-catalog-migration.md)
    + [数据类型](aws-glue-api-catalog-migration.md#aws-glue-api-catalog-migration-objects)
    + [CatalogImportStatus 结构](aws-glue-api-catalog-migration.md#aws-glue-api-catalog-migration-CatalogImportStatus)
    + [操作](aws-glue-api-catalog-migration.md#aws-glue-api-catalog-migration-actions)
    + [ImportCatalogToGlue 操作（Python：import\$1catalog\$1to\$1glue）](aws-glue-api-catalog-migration.md#aws-glue-api-catalog-migration-ImportCatalogToGlue)
    + [GetCatalogImportStatus 操作（Python：get\$1catalog\$1import\$1status）](aws-glue-api-catalog-migration.md#aws-glue-api-catalog-migration-GetCatalogImportStatus)
+ [表优化器 API](aws-glue-api-table-optimizers.md)
  + [数据类型](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-objects)
  + [TableOptimizer 的结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-TableOptimizer)
  + [TableOptimizerConfiguration 的结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-TableOptimizerConfiguration)
  + [TableOptimizerVpcConfiguration 结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-TableOptimizerVpcConfiguration)
  + [CompactionConfiguration 结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-CompactionConfiguration)
  + [IcebergCompactionConfiguration 结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-IcebergCompactionConfiguration)
  + [TableOptimizerRun 的结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-TableOptimizerRun)
  + [BatchGetTableOptimizerEntry 的结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-BatchGetTableOptimizerEntry)
  + [BatchTableOptimizer 的结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-BatchTableOptimizer)
  + [BatchGetTableOptimizerError 的结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-BatchGetTableOptimizerError)
  + [RetentionConfiguration 结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-RetentionConfiguration)
  + [IcebergRetentionConfiguration 结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-IcebergRetentionConfiguration)
  + [OrphanFileDeletionConfiguration 结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-OrphanFileDeletionConfiguration)
  + [IcebergOrphanFileDeletionConfiguration 结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-IcebergOrphanFileDeletionConfiguration)
  + [CompactionMetrics 结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-CompactionMetrics)
  + [RetentionMetrics 结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-RetentionMetrics)
  + [OrphanFileDeletionMetrics 结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-OrphanFileDeletionMetrics)
  + [IcebergCompactionMetrics 结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-IcebergCompactionMetrics)
  + [IcebergRetentionMetrics 结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-IcebergRetentionMetrics)
  + [IcebergOrphanFileDeletionMetrics 结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-IcebergOrphanFileDeletionMetrics)
  + [RunMetrics 的结构](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-RunMetrics)
  + [操作](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-actions)
  + [GetTableOptimizer 操作（Python：get\$1table\$1optimizer）](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-GetTableOptimizer)
  + [BatchGetTableOptimizer 操作（Python：batch\$1get\$1table\$1optimizer）](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-BatchGetTableOptimizer)
  + [ListTableOptimizerRuns 操作（Python：list\$1table\$1optimizer\$1runs）](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-ListTableOptimizerRuns)
  + [CreateTableOptimizer 操作（Python：create\$1table\$1optimizer）](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-CreateTableOptimizer)
  + [DeleteTableOptimizer 操作（Python：delete\$1table\$1optimizer）](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-DeleteTableOptimizer)
  + [UpdateTableOptimizer 操作（Python：update\$1table\$1optimizer](aws-glue-api-table-optimizers.md#aws-glue-api-table-optimizers-UpdateTableOptimizer)
+ [爬网程序和分类器 API](aws-glue-api-crawler.md)
  + [分类器 API](aws-glue-api-crawler-classifiers.md)
    + [数据类型](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-objects)
    + [Classifier 结构](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-Classifier)
    + [GrokClassifier 结构](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-GrokClassifier)
    + [XMLClassifier 结构](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-XMLClassifier)
    + [JsonClassifier 结构](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-JsonClassifier)
    + [CsvClassifier 结构](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-CsvClassifier)
    + [CreateGrokClassifierRequest 结构](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-CreateGrokClassifierRequest)
    + [UpdateGrokClassifierRequest 结构](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-UpdateGrokClassifierRequest)
    + [CreateXMLClassifierRequest 结构](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-CreateXMLClassifierRequest)
    + [UpdateXMLClassifierRequest 结构](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-UpdateXMLClassifierRequest)
    + [CreateJsonClassifierRequest 结构](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-CreateJsonClassifierRequest)
    + [UpdateJsonClassifierRequest 结构](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-UpdateJsonClassifierRequest)
    + [CreateCsvClassifierRequest 结构](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-CreateCsvClassifierRequest)
    + [UpdateCsvClassifierRequest 结构](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-UpdateCsvClassifierRequest)
    + [操作](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-actions)
    + [CreateClassifier 操作（Python：create\$1classifier）](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-CreateClassifier)
    + [DeleteClassifier 操作（Python：delete\$1classifier）](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-DeleteClassifier)
    + [GetClassifier 操作（Python：get\$1classifier）](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-GetClassifier)
    + [GetClassifiers 操作（Python：get\$1classifiers）](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-GetClassifiers)
    + [UpdateClassifier 操作（Python：update\$1classifier）](aws-glue-api-crawler-classifiers.md#aws-glue-api-crawler-classifiers-UpdateClassifier)
  + [爬网程序 API](aws-glue-api-crawler-crawling.md)
    + [数据类型](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-objects)
    + [Crawler 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-Crawler)
    + [Schedule 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-Schedule)
    + [CrawlerTargets 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-CrawlerTargets)
    + [S3Target 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-S3Target)
    + [S3DeltaCatalogTarget 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-S3DeltaCatalogTarget)
    + [S3DeltaDirectTarget 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-S3DeltaDirectTarget)
    + [JdbcTarget 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-JdbcTarget)
    + [MongoDBTarget 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-MongoDBTarget)
    + [DynamoDBTarget 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-DynamoDBTarget)
    + [DeltaTarget 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-DeltaTarget)
    + [IcebergTarget 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-IcebergTarget)
    + [HudiTarget 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-HudiTarget)
    + [CatalogTarget 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-CatalogTarget)
    + [CrawlerMetrics 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-CrawlerMetrics)
    + [CrawlerHistory 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-CrawlerHistory)
    + [CrawlsFilter 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-CrawlsFilter)
    + [SchemaChangePolicy 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-SchemaChangePolicy)
    + [LastCrawlInfo 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-LastCrawlInfo)
    + [RecrawlPolicy 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-RecrawlPolicy)
    + [LineageConfiguration 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-LineageConfiguration)
    + [LakeFormationConfiguration 结构](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-LakeFormationConfiguration)
    + [操作](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-actions)
    + [CreateCrawler 操作（Python：create\$1crawler）](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-CreateCrawler)
    + [DeleteCrawler 操作（Python：delete\$1crawler）](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-DeleteCrawler)
    + [GetCrawler 操作（Python：get\$1crawler）](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-GetCrawler)
    + [GetCrawlers 操作（Python：get\$1crawlers）](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-GetCrawlers)
    + [GetCrawlerMetrics 操作（Python：get\$1crawler\$1metrics）](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-GetCrawlerMetrics)
    + [UpdateCrawler 操作（Python：update\$1crawler）](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-UpdateCrawler)
    + [StartCrawler 操作（Python：start\$1crawler）](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-StartCrawler)
    + [StopCrawler 操作（Python：stop\$1crawler）](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-StopCrawler)
    + [BatchGetCrawlers 操作（Python：batch\$1get\$1crawlers）](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-BatchGetCrawlers)
    + [ListCrawlers 操作（Python：list\$1crawlers）](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-ListCrawlers)
    + [ListCrawls 操作（Python：list\$1crawls）](aws-glue-api-crawler-crawling.md#aws-glue-api-crawler-crawling-ListCrawls)
  + [列统计数据 API](aws-glue-api-crawler-column-statistics.md)
    + [数据类型](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-objects)
    + [ColumnStatisticsTaskRun 结构](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRun)
    + [ColumnStatisticsTaskSettings 结构](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskSettings)
    + [ExecutionAttempt 结构](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-ExecutionAttempt)
    + [操作](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-actions)
    + [StartColumnStatisticsTaskRun 操作（Python：start\$1column\$1statistics\$1task\$1run）](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-StartColumnStatisticsTaskRun)
    + [GetColumnStatisticsTaskRun 操作（Python：get\$1column\$1statistics\$1task\$1run）](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskRun)
    + [GetColumnStatisticsTaskRuns 操作（Python：get\$1column\$1statistics\$1task\$1runs）](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskRuns)
    + [ListColumnStatisticsTaskRuns 操作（Python：list\$1column\$1statistics\$1task\$1runs）](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-ListColumnStatisticsTaskRuns)
    + [StopColumnStatisticsTaskRun 操作（Python：stop\$1column\$1statistics\$1task\$1run）](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-StopColumnStatisticsTaskRun)
    + [CreateColumnStatisticsTaskSettings 操作（Python：create\$1column\$1statistics\$1task\$1settings）](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-CreateColumnStatisticsTaskSettings)
    + [UpdateColumnStatisticsTaskSettings 操作（Python：update\$1column\$1statistics\$1task\$1settings）](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-UpdateColumnStatisticsTaskSettings)
    + [GetColumnStatisticsTaskSettings 操作（Python：get\$1column\$1statistics\$1task\$1settings）](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskSettings)
    + [DeleteColumnStatisticsTaskSettings 操作（Python：delete\$1column\$1statistics\$1task\$1settings）](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-DeleteColumnStatisticsTaskSettings)
    + [StartColumnStatisticsTaskRunSchedule 操作（Python：start\$1column\$1statistics\$1task\$1run\$1schedule）](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-StartColumnStatisticsTaskRunSchedule)
    + [StopColumnStatisticsTaskRunSchedule 操作（Python：stop\$1column\$1statistics\$1task\$1run\$1schedule）](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-StopColumnStatisticsTaskRunSchedule)
    + [异常](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-exceptions)
    + [ColumnStatisticsTaskRunningException 结构](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRunningException)
    + [ColumnStatisticsTaskNotRunningException 结构](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskNotRunningException)
    + [ColumnStatisticsTaskStoppingException 结构](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskStoppingException)
    + [ColumnStatisticsTaskAutoConcurrencyLimitException 结构](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskAutoConcurrencyLimitException)
    + [InvalidCatalogSettingException 结构](aws-glue-api-crawler-column-statistics.md#aws-glue-api-crawler-column-statistics-InvalidCatalogSettingException)
  + [爬网程序计划程序 API](aws-glue-api-crawler-scheduler.md)
    + [数据类型](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-objects)
    + [Schedule 结构](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-Schedule)
    + [操作](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-actions)
    + [UpdateCrawlerSchedule 操作（Python：update\$1crawler\$1schedule）](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-UpdateCrawlerSchedule)
    + [StartCrawlerSchedule 操作（Python：start\$1crawler\$1schedule）](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-StartCrawlerSchedule)
    + [StopCrawlerSchedule 操作（Python：stop\$1crawler\$1schedule）](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-StopCrawlerSchedule)
+ [自动生成 ETL 脚本 API](aws-glue-api-etl-script-generation.md)
  + [数据类型](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-objects)
  + [CodeGenNode 结构](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-CodeGenNode)
  + [CodeGenNodeArg 结构](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-CodeGenNodeArg)
  + [CodeGenEdge 结构](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-CodeGenEdge)
  + [Location 结构](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-Location)
  + [CatalogEntry 结构](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-CatalogEntry)
  + [MappingEntry 结构](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-MappingEntry)
  + [操作](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-actions)
  + [CreateScript 操作（Python：create\$1script）](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-CreateScript)
  + [GetDataflowGraph 操作（Python：get\$1dataflow\$1graph）](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-GetDataflowGraph)
  + [GetMapping 操作（Python：get\$1mapping）](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-GetMapping)
  + [GetPlan 操作（Python：get\$1plan）](aws-glue-api-etl-script-generation.md#aws-glue-api-etl-script-generation-GetPlan)
+ [可视化作业 API](aws-glue-api-visual-job-api.md)
  + [数据类型](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-objects)
  + [CodeGenConfigurationNode 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CodeGenConfigurationNode)
  + [JDBCConnectoOptions 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-JDBCConnectorOptions)
  + [StreamingDataPreviewOptions 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-StreamingDataPreviewOptions)
  + [AthenaConnectorSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AthenaConnectorSource)
  + [JDBCConnectorSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-JDBCConnectorSource)
  + [SparkConnectorSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SparkConnectorSource)
  + [CatalogSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CatalogSource)
  + [MySQLCatalogSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-MySQLCatalogSource)
  + [PostgreSQLCatalogSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-PostgreSQLCatalogSource)
  + [OracleSQLCatalogSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-OracleSQLCatalogSource)
  + [MicrosoftSQLServerCatalogSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-MicrosoftSQLServerCatalogSource)
  + [CatalogKinesisSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CatalogKinesisSource)
  + [DirectKinesisSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DirectKinesisSource)
  + [KinesisStreamingSourceOptions 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-KinesisStreamingSourceOptions)
  + [CatalogKafkaSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CatalogKafkaSource)
  + [DirectKafkaSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DirectKafkaSource)
  + [KafkaStreamingSourceOptions 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-KafkaStreamingSourceOptions)
  + [RedshiftSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-RedshiftSource)
  + [AmazonRedshiftSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AmazonRedshiftSource)
  + [AmazonRedshiftNodeData 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AmazonRedshiftNodeData)
  + [AmazonRedshiftAdvancedOption 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AmazonRedshiftAdvancedOption)
  + [选项结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Option)
  + [S3CatalogSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3CatalogSource)
  + [S3SourceAdditionalOptions 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3SourceAdditionalOptions)
  + [S3CsvSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3CsvSource)
  + [DirectJDBCSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DirectJDBCSource)
  + [S3DirectSourceAdditionalOptions 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions)
  + [S3JsonSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3JsonSource)
  + [S3ParquetSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3ParquetSource)
  + [S3DeltaSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3DeltaSource)
  + [S3CatalogDeltaSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3CatalogDeltaSource)
  + [CatalogDeltaSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CatalogDeltaSource)
  + [S3HudiSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3HudiSource)
  + [S3CatalogHudiSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3CatalogHudiSource)
  + [S3ExcelSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3ExcelSource)
  + [CatalogHudiSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CatalogHudiSource)
  + [DynamoDBCatalogSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DynamoDBCatalogSource)
  + [RelationalCatalogSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-RelationalCatalogSource)
  + [JDBCConnectorTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-JDBCConnectorTarget)
  + [SparkConnectorTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SparkConnectorTarget)
  + [BasicCatalogTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-BasicCatalogTarget)
  + [MySQLCatalogTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-MySQLCatalogTarget)
  + [PostgreSQLCatalogTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-PostgreSQLCatalogTarget)
  + [OracleSQLCatalogTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-OracleSQLCatalogTarget)
  + [MicrosoftSQLServerCatalogTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-MicrosoftSQLServerCatalogTarget)
  + [RedshiftTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-RedshiftTarget)
  + [AmazonRedshiftTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AmazonRedshiftTarget)
  + [UpsertRedshiftTargetOptions 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-UpsertRedshiftTargetOptions)
  + [S3CatalogTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3CatalogTarget)
  + [S3GlueParquetTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3GlueParquetTarget)
  + [CatalogSchemaChangePolicy 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CatalogSchemaChangePolicy)
  + [S3DirectTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3DirectTarget)
  + [S3HudiCatalogTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3HudiCatalogTarget)
  + [S3HudiDirectTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3HudiDirectTarget)
  + [S3DeltaCatalogTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3DeltaCatalogTarget)
  + [S3DeltaDirectTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3DeltaDirectTarget)
  + [S3HyperDirectTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3HyperDirectTarget)
  + [S3IcebergDirectTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3IcebergDirectTarget)
  + [DirectSchemaChangePolicy 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DirectSchemaChangePolicy)
  + [ApplyMapping 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-ApplyMapping)
  + [Mapping 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Mapping)
  + [SelectFields 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SelectFields)
  + [DropFields 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DropFields)
  + [RenameField 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-RenameField)
  + [Spigot 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Spigot)
  + [Join 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Join)
  + [JoinColumn 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-JoinColumn)
  + [SplitFields 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SplitFields)
  + [SelectFromCollection 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SelectFromCollection)
  + [FillMissingValues 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-FillMissingValues)
  + [Filter 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Filter)
  + [FilterExpression 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-FilterExpression)
  + [FilterValue 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-FilterValue)
  + [CustomCode 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CustomCode)
  + [SparkSQL 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SparkSQL)
  + [SqlAlias 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SqlAlias)
  + [DropNullFields 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DropNullFields)
  + [NullCheckBoxList 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-NullCheckBoxList)
  + [NullValueField 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-NullValueField)
  + [Datatype 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Datatype)
  + [Merge 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Merge)
  + [Union 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Union)
  + [PIIDetection 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-PIIDetection)
  + [Aggregate 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Aggregate)
  + [DropDuplicates 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DropDuplicates)
  + [GovernedCatalogTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-GovernedCatalogTarget)
  + [GovernedCatalogSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-GovernedCatalogSource)
  + [聚合操作结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AggregateOperation)
  + [GlueSchema 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-GlueSchema)
  + [GlueStudioSchemaColumn 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-GlueStudioSchemaColumn)
  + [GlueStudioColumn 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-GlueStudioColumn)
  + [DynamicTransform 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DynamicTransform)
  + [TransformConfigParameter 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-TransformConfigParameter)
  + [EvaluateDataQuality 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-EvaluateDataQuality)
  + [DQResultsPublishingOptions 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DQResultsPublishingOptions)
  + [DQStopJobOnFailureOptions 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DQStopJobOnFailureOptions)
  + [EvaluateDataQualityMultiFrame 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-EvaluateDataQualityMultiFrame)
  + [脚本结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Recipe)
  + [RecipeReference 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-RecipeReference)
  + [SnowflakeNodeData 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SnowflakeNodeData)
  + [SnowflakeSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SnowflakeSource)
  + [SnowflakeTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-SnowflakeTarget)
  + [ConnectorDataSource 的结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-ConnectorDataSource)
  + [ConnectorDataTarget 的结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-ConnectorDataTarget)
  + [RecipeStep 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-RecipeStep)
  + [RecipeAction 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-RecipeAction)
  + [ConditionExpression 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-ConditionExpression)
  + [S3CatalogIcebergSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3CatalogIcebergSource)
  + [CatalogIcebergSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CatalogIcebergSource)
  + [S3IcebergCatalogTarget 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-S3IcebergCatalogTarget)
  + [DynamoDBELTConnectorSource 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DynamoDBELTConnectorSource)
  + [DDBELTConnectionOptions 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DDBELTConnectionOptions)
  + [DDBELTCatalogAdditionalOptions 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DDBELTCatalogAdditionalOptions)
  + [路由结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-Route)
  + [GroupFilters 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-GroupFilters)
  + [AutoDataQuality 结构](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AutoDataQuality)
+ [作业 API](aws-glue-api-jobs.md)
  + [作业](aws-glue-api-jobs-job.md)
    + [数据类型](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-objects)
    + [作业结构](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-Job)
    + [ExecutionProperty 结构](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-ExecutionProperty)
    + [NotificationProperty 结构](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-NotificationProperty)
    + [JobCommand 结构](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-JobCommand)
    + [ConnectionsList 结构](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-ConnectionsList)
    + [JobUpdate 结构](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-JobUpdate)
    + [SourceControlDetails 结构](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-SourceControlDetails)
    + [操作](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-actions)
    + [CreateJob 操作（Python：create\$1job）](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-CreateJob)
    + [UpdateJob 操作（Python：update\$1job）](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-UpdateJob)
    + [GetJob 操作（Python：get\$1job）](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-GetJob)
    + [GetJobs 操作（Python：get\$1jobs）](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-GetJobs)
    + [DeleteJob 操作（Python：delete\$1job）](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-DeleteJob)
    + [ListJobs 操作（Python：list\$1jobs）](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-ListJobs)
    + [BatchGetJobs 操作（Python：batch\$1get\$1jobs）](aws-glue-api-jobs-job.md#aws-glue-api-jobs-job-BatchGetJobs)
  + [任务运行](aws-glue-api-jobs-runs.md)
    + [数据类型](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-objects)
    + [JobRun 结构](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-JobRun)
    + [Predecessor 结构](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-Predecessor)
    + [JobBookmarkEntry 结构](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-JobBookmarkEntry)
    + [BatchStopJobRunSuccessfulSubmission 结构](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-BatchStopJobRunSuccessfulSubmission)
    + [BatchStopJobRunError 结构](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-BatchStopJobRunError)
    + [NotificationProperty 结构](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-NotificationProperty)
    + [操作](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-actions)
    + [StartJobRun 操作（Python：start\$1job\$1run）](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-StartJobRun)
    + [BatchStopJobRun 操作（Python：batch\$1stop\$1job\$1run）](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-BatchStopJobRun)
    + [GetJobRun 操作（Python：get\$1job\$1run）](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-GetJobRun)
    + [GetJobRuns 操作（Python：get\$1job\$1runs）](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-GetJobRuns)
    + [GetJobBookmark 操作（Python：get\$1job\$1bookmark）](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-GetJobBookmark)
    + [GetJobBookmarks 操作（Python：get\$1job\$1bookmarks）](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-GetJobBookmarks)
    + [ResetJobBookmark 操作（Python：reset\$1job\$1bookmark）](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-ResetJobBookmark)
  + [触发](aws-glue-api-jobs-trigger.md)
    + [数据类型](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-objects)
    + [Trigger 结构](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-Trigger)
    + [TriggerUpdate 结构](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-TriggerUpdate)
    + [Predicate 结构](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-Predicate)
    + [Condition 结构](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-Condition)
    + [Action 结构](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-Action)
    + [EventBatchingCondition 结构](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-EventBatchingCondition)
    + [操作](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-actions)
    + [CreateTrigger 操作（Python：create\$1trigger）](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-CreateTrigger)
    + [StartTrigger 操作（Python：start\$1trigger）](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-StartTrigger)
    + [GetTrigger 操作（Python：get\$1trigger）](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-GetTrigger)
    + [GetTriggers 操作（Python：get\$1triggers）](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-GetTriggers)
    + [UpdateTrigger 操作（Python：update\$1trigger）](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-UpdateTrigger)
    + [StopTrigger 操作（Python：stop\$1trigger）](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-StopTrigger)
    + [DeleteTrigger 操作（Python：delete\$1trigger）](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-DeleteTrigger)
    + [ListTriggers 操作（Python：list\$1triggers）](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-ListTriggers)
    + [BatchGetTriggers 操作（Python：batch\$1get\$1triggers）](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-BatchGetTriggers)
+ [AWS Glue 中的集成 API](aws-glue-api-integrations.md)
  + [数据类型](aws-glue-api-integrations.md#aws-glue-api-integrations-objects)
  + [集成结构](aws-glue-api-integrations.md#aws-glue-api-integrations-Integration)
  + [IntegrationConfig 结构](aws-glue-api-integrations.md#aws-glue-api-integrations-IntegrationConfig)
  + [IntegrationPartition 结构](aws-glue-api-integrations.md#aws-glue-api-integrations-IntegrationPartition)
  + [IntegrationError 结构](aws-glue-api-integrations.md#aws-glue-api-integrations-IntegrationError)
  + [IntegrationFilter 结构](aws-glue-api-integrations.md#aws-glue-api-integrations-IntegrationFilter)
  + [InboundIntegration 结构](aws-glue-api-integrations.md#aws-glue-api-integrations-InboundIntegration)
  + [SourceProcessingProperties 结构](aws-glue-api-integrations.md#aws-glue-api-integrations-SourceProcessingProperties)
  + [TargetProcessingProperties 结构](aws-glue-api-integrations.md#aws-glue-api-integrations-TargetProcessingProperties)
  + [SourceTableConfig 结构](aws-glue-api-integrations.md#aws-glue-api-integrations-SourceTableConfig)
  + [TargetTableConfig 结构](aws-glue-api-integrations.md#aws-glue-api-integrations-TargetTableConfig)
  + [操作](aws-glue-api-integrations.md#aws-glue-api-integrations-actions)
  + [CreateIntegration 操作（Python：create\$1integration）](aws-glue-api-integrations.md#aws-glue-api-integrations-CreateIntegration)
  + [ModifyIntegration 操作（Python：modify\$1integration）](aws-glue-api-integrations.md#aws-glue-api-integrations-ModifyIntegration)
  + [DescribeIntegrations 操作（Python：describe\$1integrations）](aws-glue-api-integrations.md#aws-glue-api-integrations-DescribeIntegrations)
  + [DeleteIntegration 操作（Python：delete\$1integration）](aws-glue-api-integrations.md#aws-glue-api-integrations-DeleteIntegration)
  + [DescribeInboundIntegrations 操作（Python：describe\$1inbound\$1integrations）](aws-glue-api-integrations.md#aws-glue-api-integrations-DescribeInboundIntegrations)
  + [CreateIntegrationTableProperties 操作（Python：create\$1integration\$1table\$1properties）](aws-glue-api-integrations.md#aws-glue-api-integrations-CreateIntegrationTableProperties)
  + [UpdateIntegrationTableProperties 操作（Python：update\$1integration\$1table\$1properties）](aws-glue-api-integrations.md#aws-glue-api-integrations-UpdateIntegrationTableProperties)
  + [GetIntegrationTableProperties 操作（Python：get\$1integration\$1table\$1properties）](aws-glue-api-integrations.md#aws-glue-api-integrations-GetIntegrationTableProperties)
  + [DeleteIntegrationTableProperties 操作（Python：delete\$1integration\$1table\$1properties）](aws-glue-api-integrations.md#aws-glue-api-integrations-DeleteIntegrationTableProperties)
  + [CreateIntegrationResourceProperty 操作（Python：create\$1integration\$1resource\$1property）](aws-glue-api-integrations.md#aws-glue-api-integrations-CreateIntegrationResourceProperty)
  + [UpdateIntegrationResourceProperty 操作（Python：update\$1integration\$1resource\$1property）](aws-glue-api-integrations.md#aws-glue-api-integrations-UpdateIntegrationResourceProperty)
  + [GetIntegrationResourceProperty 操作（Python：get\$1integration\$1resource\$1property）](aws-glue-api-integrations.md#aws-glue-api-integrations-GetIntegrationResourceProperty)
  + [UntagResource 操作（Python：untag\$1resource）](aws-glue-api-integrations.md#aws-glue-api-integrations-UntagResource)
  + [ListTagsForResource 操作（Python：list\$1tags\$1for\$1resource）](aws-glue-api-integrations.md#aws-glue-api-integrations-ListTagsForResource)
  + [异常](aws-glue-api-integrations.md#aws-glue-api-integrations-exceptions)
  + [ResourceNotFoundException 结构](aws-glue-api-integrations.md#aws-glue-api-integrations-ResourceNotFoundException)
  + [InternalServerException 结构](aws-glue-api-integrations.md#aws-glue-api-integrations-InternalServerException)
  + [IntegrationAlreadyExistsFault 结构](aws-glue-api-integrations.md#aws-glue-api-integrations-IntegrationAlreadyExistsFault)
  + [IntegrationConflictOperationFault 结构](aws-glue-api-integrations.md#aws-glue-api-integrations-IntegrationConflictOperationFault)
  + [IntegrationQuotaExceededFault 结构](aws-glue-api-integrations.md#aws-glue-api-integrations-IntegrationQuotaExceededFault)
  + [KMSKeyNotAccessibleFault 结构](aws-glue-api-integrations.md#aws-glue-api-integrations-KMSKeyNotAccessibleFault)
  + [IntegrationNotFoundFault 结构](aws-glue-api-integrations.md#aws-glue-api-integrations-IntegrationNotFoundFault)
  + [TargetResourceNotFound 结构](aws-glue-api-integrations.md#aws-glue-api-integrations-TargetResourceNotFound)
  + [InvalidIntegrationStateFault 结构](aws-glue-api-integrations.md#aws-glue-api-integrations-InvalidIntegrationStateFault)
+ [交互式会话 API](aws-glue-api-interactive-sessions.md)
  + [数据类型](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-objects)
  + [Session 结构](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-Session)
  + [SessionCommand 结构](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-SessionCommand)
  + [Statement 结构](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-Statement)
  + [StatementOutput 结构](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-StatementOutput)
  + [StatementOutputData 结构](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-StatementOutputData)
  + [ConnectionsList 结构](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-ConnectionsList)
  + [操作](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-actions)
  + [CreateSession 操作（Python：create\$1session）](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-CreateSession)
  + [StopSession 操作（Python：stop\$1session）](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-StopSession)
  + [DeleteSession 操作（Python：delete\$1session）](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-DeleteSession)
  + [GetSession 操作（Python：get\$1session）](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-GetSession)
  + [ListSession 操作（Python：list\$1ession）](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-ListSessions)
  + [RunStatement 操作（Python：run\$1statement）](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-RunStatement)
  + [CancelStatement 操作（Python：cancel\$1statement）](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-CancelStatement)
  + [GetStatement 操作（Python：get\$1statement）](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-GetStatement)
  + [ListStatements 操作（Python：list\$1statements）](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-ListStatements)
  + [GetGlueIdentityCenterConfiguration 操作（Python：get\$1glue\$1identity\$1center\$1configuration）](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-GetGlueIdentityCenterConfiguration)
  + [UpdateGlueIdentityCenterConfiguration 操作（Python：update\$1glue\$1identity\$1center\$1configuration）](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-UpdateGlueIdentityCenterConfiguration)
  + [CreateGlueIdentityCenterConfiguration 操作（Python：create\$1glue\$1identity\$1center\$1configuration）](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-CreateGlueIdentityCenterConfiguration)
  + [DeleteGlueIdentityCenterConfiguration 操作（Python：delete\$1glue\$1identity\$1center\$1configuration）](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-DeleteGlueIdentityCenterConfiguration)
+ [开发终端节点 API](aws-glue-api-dev-endpoint.md)
  + [数据类型](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-objects)
  + [DevEndpoint 结构](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-DevEndpoint)
  + [DevEndpointCustomLibraries 结构](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-DevEndpointCustomLibraries)
  + [操作](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-actions)
  + [CreateDevEndpoint 操作（Python：create\$1dev\$1endpoint）](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-CreateDevEndpoint)
  + [UpdateDevEndpoint 操作（Python：update\$1dev\$1endpoint）](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-UpdateDevEndpoint)
  + [DeleteDevEndpoint 操作（Python：delete\$1dev\$1endpoint）](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-DeleteDevEndpoint)
  + [GetDevEndpoint 操作（Python：get\$1dev\$1endpoint）](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-GetDevEndpoint)
  + [GetDevEndpoints 操作（Python：get\$1dev\$1endpoints）](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-GetDevEndpoints)
  + [BatchGetDevEndpoints 操作（Python：batch\$1get\$1dev\$1endpoints）](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-BatchGetDevEndpoints)
  + [ListDevEndpoints 操作（Python：list\$1dev\$1endpoints）](aws-glue-api-dev-endpoint.md#aws-glue-api-dev-endpoint-ListDevEndpoints)
+ [架构注册表](aws-glue-api-schema-registry-api.md)
  + [数据类型](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-objects)
  + [RegistryId 结构](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-RegistryId)
  + [RegistryListItem 结构](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-RegistryListItem)
  + [MetadataInfo 结构](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-MetadataInfo)
  + [OtherMetadataValueListItem 结构](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-OtherMetadataValueListItem)
  + [SchemaListItem 结构](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaListItem)
  + [SchemaVersionListItem 结构](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaVersionListItem)
  + [MetadataKeyValuePair 结构](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-MetadataKeyValuePair)
  + [SchemaVersionErrorItem 结构](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaVersionErrorItem)
  + [ErrorDetails 结构](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-ErrorDetails)
  + [SchemaVersionNumber 结构](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaVersionNumber)
  + [SchemaId 结构](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaId)
  + [操作](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-actions)
  + [CreateRegistry 操作（Python：create\$1registry）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-CreateRegistry)
  + [CreateSchema 操作（Python：create\$1schema）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-CreateSchema)
  + [GetSchema 操作（Python：get\$1schema）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-GetSchema)
  + [ListSchemaVersions 操作（Python：list\$1schema \$1version）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-ListSchemaVersions)
  + [GetSchemaVersion 操作（Python：get\$1table\$1version）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-GetSchemaVersion)
  + [GetSchemaVersionsDiff 操作（Python：get\$1schema\$1versions\$1diff）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-GetSchemaVersionsDiff)
  + [ListRegistries 操作（Python：list\$1registries）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-ListRegistries)
  + [ListSchemas 操作（Python：list\$1schema）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-ListSchemas)
  + [RegisterSchemaVersion 操作（Python：register\$1schema\$1version）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-RegisterSchemaVersion)
  + [UpdateSchema 操作（Python：update\$1schema）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-UpdateSchema)
  + [CheckSchemaVersionValidity 操作（Python：check\$1schema\$1version\$1validity）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-CheckSchemaVersionValidity)
  + [UpdateRegistry 操作（Python：update\$1registry）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-UpdateRegistry)
  + [GetSchemaByDefinition 操作（Python：get\$1schema\$1by\$1definition）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-GetSchemaByDefinition)
  + [GetRegistry 操作（Python：get\$1registry）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-GetRegistry)
  + [PutSchemaVersionMetadata 操作（Python：put\$1schema\$1version\$1metadata）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-PutSchemaVersionMetadata)
  + [QuerySchemaVersionMetadata 操作（Python：query\$1schema\$1version\$1metadata）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-QuerySchemaVersionMetadata)
  + [RemoveSchemaVersionMetadata 操作（Python：remove\$1schema\$1version\$1metadata）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-RemoveSchemaVersionMetadata)
  + [DeleteRegistry 操作（Python：delete\$1registry）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-DeleteRegistry)
  + [DeleteSchema 操作（Python：delete\$1schema）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-DeleteSchema)
  + [DeleteSchemaVersions 操作（Python：delete\$1table\$1version）](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-DeleteSchemaVersions)
+ [工作流程](aws-glue-api-workflow.md)
  + [数据类型](aws-glue-api-workflow.md#aws-glue-api-workflow-objects)
  + [JobNodeDetails 结构](aws-glue-api-workflow.md#aws-glue-api-workflow-JobNodeDetails)
  + [CrawlerNodeDetails 结构](aws-glue-api-workflow.md#aws-glue-api-workflow-CrawlerNodeDetails)
  + [TriggerNodeDetails 结构](aws-glue-api-workflow.md#aws-glue-api-workflow-TriggerNodeDetails)
  + [Crawl 结构](aws-glue-api-workflow.md#aws-glue-api-workflow-Crawl)
  + [Node 结构](aws-glue-api-workflow.md#aws-glue-api-workflow-Node)
  + [Edge 结构](aws-glue-api-workflow.md#aws-glue-api-workflow-Edge)
  + [Workflow 结构](aws-glue-api-workflow.md#aws-glue-api-workflow-Workflow)
  + [WorkflowGraph 结构](aws-glue-api-workflow.md#aws-glue-api-workflow-WorkflowGraph)
  + [WorkflowRun 结构](aws-glue-api-workflow.md#aws-glue-api-workflow-WorkflowRun)
  + [WorkflowRunStatistics 结构](aws-glue-api-workflow.md#aws-glue-api-workflow-WorkflowRunStatistics)
  + [StartingEventBatchCondition 结构](aws-glue-api-workflow.md#aws-glue-api-workflow-StartingEventBatchCondition)
  + [Blueprint 结构](aws-glue-api-workflow.md#aws-glue-api-workflow-Blueprint)
  + [BlueprintDetails 结构](aws-glue-api-workflow.md#aws-glue-api-workflow-BlueprintDetails)
  + [LastActiveDefinition 结构](aws-glue-api-workflow.md#aws-glue-api-workflow-LastActiveDefinition)
  + [BlueprintRun 结构](aws-glue-api-workflow.md#aws-glue-api-workflow-BlueprintRun)
  + [操作](aws-glue-api-workflow.md#aws-glue-api-workflow-actions)
  + [CreateWorkflow 操作（Python：create\$1workflow）](aws-glue-api-workflow.md#aws-glue-api-workflow-CreateWorkflow)
  + [UpdateWorkflow 操作（Python：update\$1workflow）](aws-glue-api-workflow.md#aws-glue-api-workflow-UpdateWorkflow)
  + [DeleteWorkflow 操作（Python：delete\$1workflow）](aws-glue-api-workflow.md#aws-glue-api-workflow-DeleteWorkflow)
  + [GetWorkflow 操作（Python：get\$1workflow）](aws-glue-api-workflow.md#aws-glue-api-workflow-GetWorkflow)
  + [ListWorkflows 操作（Python：list\$1workflows）](aws-glue-api-workflow.md#aws-glue-api-workflow-ListWorkflows)
  + [BatchGetWorkflows 操作（Python：batch\$1get\$1workflows）](aws-glue-api-workflow.md#aws-glue-api-workflow-BatchGetWorkflows)
  + [GetWorkflowRun 操作（Python：get\$1workflow\$1run）](aws-glue-api-workflow.md#aws-glue-api-workflow-GetWorkflowRun)
  + [GetWorkflowRuns 操作（Python：get\$1workflow\$1runs）](aws-glue-api-workflow.md#aws-glue-api-workflow-GetWorkflowRuns)
  + [GetWorkflowRunProperties 操作（Python：get\$1workflow\$1run\$1properties）](aws-glue-api-workflow.md#aws-glue-api-workflow-GetWorkflowRunProperties)
  + [PutWorkflowRunProperties 操作（Python：put\$1workflow\$1run\$1properties）](aws-glue-api-workflow.md#aws-glue-api-workflow-PutWorkflowRunProperties)
  + [CreateBlueprint 操作（Python：create\$1blueprint）](aws-glue-api-workflow.md#aws-glue-api-workflow-CreateBlueprint)
  + [UpdateBlueprint 操作（Python：update\$1blueprint）](aws-glue-api-workflow.md#aws-glue-api-workflow-UpdateBlueprint)
  + [DeleteBlueprint 操作（Python：delete\$1blueprint）](aws-glue-api-workflow.md#aws-glue-api-workflow-DeleteBlueprint)
  + [ListBlueprints 操作（Python：list\$1blueprint）](aws-glue-api-workflow.md#aws-glue-api-workflow-ListBlueprints)
  + [BatchGetBlueprints 操作（Python：batch\$1get\$1blueprints）](aws-glue-api-workflow.md#aws-glue-api-workflow-BatchGetBlueprints)
  + [StartBlueprintRun 操作（Python：start\$1blueprint\$1run）](aws-glue-api-workflow.md#aws-glue-api-workflow-StartBlueprintRun)
  + [GetBlueprintRun 操作（Python：get\$1blueprint\$1run）](aws-glue-api-workflow.md#aws-glue-api-workflow-GetBlueprintRun)
  + [GetBlueprintRuns 操作（Python：get\$1blueprint\$1runs）](aws-glue-api-workflow.md#aws-glue-api-workflow-GetBlueprintRuns)
  + [StartWorkflowRun 操作（Python：start\$1workflow\$1run）](aws-glue-api-workflow.md#aws-glue-api-workflow-StartWorkflowRun)
  + [StopWorkflowRun 操作（Python：stop\$1workflow\$1run）](aws-glue-api-workflow.md#aws-glue-api-workflow-StopWorkflowRun)
  + [ResumeWorkflowRun 操作（Python：resume\$1workflow\$1run）](aws-glue-api-workflow.md#aws-glue-api-workflow-ResumeWorkflowRun)
+ [使用情况配置文件](aws-glue-api-usage-profiles.md)
  + [数据类型](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-objects)
  + [ProfileConfiguration 结构](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-ProfileConfiguration)
  + [ConfigurationObject 结构](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-ConfigurationObject)
  + [UsageProfileDefinition 结构](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-UsageProfileDefinition)
  + [操作](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-actions)
  + [CreateUsageProfile 操作（Python：create\$1usage\$1profile）](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-CreateUsageProfile)
  + [GetUsageProfile 操作（Python：get\$1usage\$1profile）](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-GetUsageProfile)
  + [UpdateUsageProfile 操作（Python：update\$1usage\$1profile）](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-UpdateUsageProfile)
  + [DeleteUsageProfile 操作（Python：delete\$1usage\$1profile）](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-DeleteUsageProfile)
  + [ListUsageProfiles 操作（Python：list\$1usage\$1profile）](aws-glue-api-usage-profiles.md#aws-glue-api-usage-profiles-ListUsageProfiles)
+ [机器学习 API](aws-glue-api-machine-learning-api.md)
  + [数据类型](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-objects)
  + [TransformParameters 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-TransformParameters)
  + [EvaluationMetrics 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-EvaluationMetrics)
  + [MLTransform 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-MLTransform)
  + [FindMatchesParameters 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-FindMatchesParameters)
  + [FindMatchesMetrics 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-FindMatchesMetrics)
  + [ConfusionMatrix 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-ConfusionMatrix)
  + [GlueTable 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-GlueTable)
  + [TaskRun 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-TaskRun)
  + [TransformFilterCriteria 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-TransformFilterCriteria)
  + [TransformSortCriteria 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-TransformSortCriteria)
  + [TaskRunFilterCriteria 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-TaskRunFilterCriteria)
  + [TaskRunSortCriteria 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-TaskRunSortCriteria)
  + [TaskRunProperties 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-TaskRunProperties)
  + [FindMatchesTaskRunProperties 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-FindMatchesTaskRunProperties)
  + [ImportLabelsTaskRunProperties 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-ImportLabelsTaskRunProperties)
  + [ExportLabelsTaskRunProperties 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-ExportLabelsTaskRunProperties)
  + [LabelingSetGenerationTaskRunProperties 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-LabelingSetGenerationTaskRunProperties)
  + [SchemaColumn 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-SchemaColumn)
  + [TransformEncryption 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-TransformEncryption)
  + [MLUserDataEncryption 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-MLUserDataEncryption)
  + [ColumnImportance 结构](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-ColumnImportance)
  + [操作](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-actions)
  + [CreateMLTransform 操作（Python：create\$1ml\$1transform）](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-CreateMLTransform)
  + [UpdateMLTransform 操作（Python：update\$1ml\$1transform）](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-UpdateMLTransform)
  + [DeleteMLTransform 操作（Python：delete\$1ml\$1transform）](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-DeleteMLTransform)
  + [GetMLTransform 操作（Python：get\$1ml\$1transform）](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-GetMLTransform)
  + [GetMLTransforms 操作（Python：get\$1ml\$1ransforms）](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-GetMLTransforms)
  + [ListMLTransforms 操作（Python：list\$1ml\$1transforms）](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-ListMLTransforms)
  + [StartMLEvaluationTaskRun 操作（Python：start\$1ml\$1evaluation\$1task\$1run）](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-StartMLEvaluationTaskRun)
  + [StartMLLabelingSetGenerationTaskRun 操作（Python：start\$1ml\$1labeling\$1set\$1generation\$1task\$1run）](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-StartMLLabelingSetGenerationTaskRun)
  + [GetMLTaskRun 操作（Python：get\$1ml\$1task\$1run）](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-GetMLTaskRun)
  + [GetMLTaskRuns 操作（Python：get\$1ml\$1task\$1runs）](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-GetMLTaskRuns)
  + [CancelMLTaskRun 操作（Python：cancel\$1ml\$1task\$1run）](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-CancelMLTaskRun)
  + [StartExportLabelsTaskRun 操作（Python：start\$1export\$1labels\$1task\$1run）](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-StartExportLabelsTaskRun)
  + [StartImportLabelsTaskRun 操作（Python：start\$1import\$1labels\$1task\$1run）](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-StartImportLabelsTaskRun)
+ [数据质量 API](aws-glue-api-data-quality-api.md)
  + [数据类型](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-objects)
  + [数据源结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataSource)
  + [DataQualityRulesetListDetails 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityRulesetListDetails)
  + [DataQualityTargetTable 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityTargetTable)
  + [DataQualityRulesetEvaluationRunDescription 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunDescription)
  + [DataQualityRulesetEvaluationRunFilter 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunFilter)
  + [DataQualityEvaluationRunAdditionalRunOptions 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityEvaluationRunAdditionalRunOptions)
  + [DataQualityRuleRecommendationRunDescription 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunDescription)
  + [DataQualityRuleRecommendationRunFilter 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunFilter)
  + [DataQualityResult 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityResult)
  + [DataQualityAnalyzerResult 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityAnalyzerResult)
  + [DataQualityObservation 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityObservation)
  + [MetricBasedObservation 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-MetricBasedObservation)
  + [DataQualityMetricValues 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityMetricValues)
  + [DataQualityRuleResult 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityRuleResult)
  + [DataQualityResultDescription 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityResultDescription)
  + [DataQualityResultFilterCriteria 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityResultFilterCriteria)
  + [DataQualityRulesetFilterCriteria 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityRulesetFilterCriteria)
  + [DataQualityAggregatedMetrics 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityAggregatedMetrics)
  + [StatisticAnnotation 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-StatisticAnnotation)
  + [TimestampedInclusionAnnotation 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-TimestampedInclusionAnnotation)
  + [AnnotionError 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-AnnotationError)
  + [DatapointInclusionAnnotation 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DatapointInclusionAnnotation)
  + [StatisticSummaryList 列表](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-StatisticSummaryList)
  + [StatisticSummary 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-StatisticSummary)
  + [RunIdentifier 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-RunIdentifier)
  + [StatisticModelResult 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-StatisticModelResult)
  + [DataQualityGlueTable 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DataQualityGlueTable)
  + [操作](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-actions)
  + [StartDataQualityRulesetEvaluationRun 操作（Python：start\$1data\$1quality\$1ruleset\$1evaluation\$1run）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-StartDataQualityRulesetEvaluationRun)
  + [CancelDataQualityRulesetEvaluationRun 操作（Python：cancel\$1data\$1quality\$1ruleset\$1evaluation\$1run）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-CancelDataQualityRulesetEvaluationRun)
  + [GetDataQualityRulesetEvaluationRun 操作（Python：get\$1data\$1quality\$1ruleset\$1evaluation\$1run）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-GetDataQualityRulesetEvaluationRun)
  + [ListDataQualityRulesetEvaluationRuns 操作（Python: list\$1data\$1quality\$1ruleset\$1evaluation\$1runs）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-ListDataQualityRulesetEvaluationRuns)
  + [StartDataQualityRuleRecommendationRun 操作（Python：start\$1data\$1quality\$1rule\$1recommendation\$1run）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-StartDataQualityRuleRecommendationRun)
  + [CancelDataQualityRuleRecommendationRun 操作（Python：cancel\$1data\$1quality\$1rule\$1recommendation\$1run）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-CancelDataQualityRuleRecommendationRun)
  + [GetDataQualityRuleRecommendationRun 操作（Python：get\$1data\$1quality\$1rule\$1recommendation\$1run）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-GetDataQualityRuleRecommendationRun)
  + [ListDataQualityRuleRecommendationRuns 操作（Python：list\$1data\$1quality\$1rule\$1recommendation\$1runs）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-ListDataQualityRuleRecommendationRuns)
  + [GetDataQualityResult 操作（Python：get\$1data\$1quality\$1result）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-GetDataQualityResult)
  + [BatchGetDataQualityResult 操作（Python：batch\$1get\$1data\$1quality\$1result）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-BatchGetDataQualityResult)
  + [ListDataQualityResults 操作（Python：list\$1data\$1quality\$1results）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-ListDataQualityResults)
  + [CreateDataQualityRuleset 操作（Python：create\$1data\$1quality\$1ruleset）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-CreateDataQualityRuleset)
  + [DeleteDataQualityRuleset 操作（Python：delete\$1data\$1quality\$1ruleset）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-DeleteDataQualityRuleset)
  + [GetDataQualityRuleset 操作（Python：get\$1data\$1quality\$1ruleset）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-GetDataQualityRuleset)
  + [ListDataQualityRulesets 操作（Python：list\$1data\$1quality\$1rulesets）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-ListDataQualityRulesets)
  + [UpdateDataQualityRuleset 操作（Python：update\$1data\$1quality\$1ruleset）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-UpdateDataQualityRuleset)
  + [ListDataQualityStatistics 操作（Python：list\$1data\$1quality\$1statistics）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-ListDataQualityStatistics)
  + [TimestampFilter 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-TimestampFilter)
  + [CreateDataQualityRulesetRequest 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-CreateDataQualityRulesetRequest)
  + [GetDataQualityRulesetResponse 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-GetDataQualityRulesetResponse)
  + [GetDataQualityResultResponse 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-GetDataQualityResultResponse)
  + [StartDataQualityRuleRecommendationRunRequest 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-StartDataQualityRuleRecommendationRunRequest)
  + [GetDataQualityRuleRecommendationRunResponse 结构](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-GetDataQualityRuleRecommendationRunResponse)
  + [BatchPutDataQualityStatisticAnnotation 操作（Python：batch\$1put\$1data\$1quality\$1statistic\$1annotation）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-BatchPutDataQualityStatisticAnnotation)
  + [GetDataQualityModel 操作（Python：get\$1data\$1quality\$1model）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-GetDataQualityModel)
  + [GetDataQualityModelResult 操作（Python：get\$1data\$1quality\$1model\$1result）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-GetDataQualityModelResult)
  + [ListDataQualityStatisticAnnotations 操作（Python：list\$1data\$1quality\$1statistic\$1annotations）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-ListDataQualityStatisticAnnotations)
  + [PutDataQualityProfileAnnotation 操作（Python：put\$1data\$1quality\$1profile\$1annotation）](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-PutDataQualityProfileAnnotation)
+ [敏感数据检测 API](aws-glue-api-sensitive-data-api.md)
  + [数据类型](aws-glue-api-sensitive-data-api.md#aws-glue-api-sensitive-data-api-objects)
  + [CustomEntityType 结构](aws-glue-api-sensitive-data-api.md#aws-glue-api-sensitive-data-api-CustomEntityType)
  + [操作](aws-glue-api-sensitive-data-api.md#aws-glue-api-sensitive-data-api-actions)
  + [CreateCustomEntityType 操作（Python：create\$1custom\$1entity\$1type）](aws-glue-api-sensitive-data-api.md#aws-glue-api-sensitive-data-api-CreateCustomEntityType)
  + [DeleteCustomEntityType 操作（Python：delete\$1custom\$1entity\$1type）](aws-glue-api-sensitive-data-api.md#aws-glue-api-sensitive-data-api-DeleteCustomEntityType)
  + [GetCustomEntityType 操作（Python：get\$1custom\$1entity\$1type）](aws-glue-api-sensitive-data-api.md#aws-glue-api-sensitive-data-api-GetCustomEntityType)
  + [BatchGetCustomEntityTypes 操作（Python：batch\$1get\$1ustom\$1entity\$1type）](aws-glue-api-sensitive-data-api.md#aws-glue-api-sensitive-data-api-BatchGetCustomEntityTypes)
  + [ListCustomEntityTypes 操作（Python：list\$1custom\$1entity\$1type）](aws-glue-api-sensitive-data-api.md#aws-glue-api-sensitive-data-api-ListCustomEntityTypes)
+ [AWS Glue 中的标记 API](aws-glue-api-tags.md)
  + [数据类型](aws-glue-api-tags.md#aws-glue-api-tags-objects)
  + [Tag 结构](aws-glue-api-tags.md#aws-glue-api-tags-Tag)
  + [操作](aws-glue-api-tags.md#aws-glue-api-tags-actions)
  + [TagResource 操作（Python：tag\$1resource）](aws-glue-api-tags.md#aws-glue-api-tags-TagResource)
  + [UntagResource 操作（Python：untag\$1resource）](aws-glue-api-tags.md#aws-glue-api-tags-UntagResource)
  + [GetTags 操作（Python：get\$1tags）](aws-glue-api-tags.md#aws-glue-api-tags-GetTags)
+ [常见数据类型](aws-glue-api-common.md)
  + [Tag 结构](aws-glue-api-common.md#aws-glue-api-common-Tag)
  + [DecimalNumber 结构](aws-glue-api-common.md#aws-glue-api-common-DecimalNumber)
  + [ErrorDetail 结构](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail)
  + [PropertyPredicate 结构](aws-glue-api-common.md#aws-glue-api-common-PropertyPredicate)
  + [ResourceUri 结构](aws-glue-api-common.md#aws-glue-api-common-ResourceUri)
  + [ColumnStatistics 结构](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics)
  + [ColumnStatisticsError 结构](aws-glue-api-common.md#aws-glue-api-common-ColumnStatisticsError)
  + [ColumnError 结构](aws-glue-api-common.md#aws-glue-api-common-ColumnError)
  + [ColumnStatisticsData 结构](aws-glue-api-common.md#aws-glue-api-common-ColumnStatisticsData)
  + [BooleanColumnStatisticsData 结构](aws-glue-api-common.md#aws-glue-api-common-BooleanColumnStatisticsData)
  + [DateColumnStatisticsData 结构](aws-glue-api-common.md#aws-glue-api-common-DateColumnStatisticsData)
  + [DecimalColumnStatisticsData 结构](aws-glue-api-common.md#aws-glue-api-common-DecimalColumnStatisticsData)
  + [DoubleColumnStatisticsData 结构](aws-glue-api-common.md#aws-glue-api-common-DoubleColumnStatisticsData)
  + [LongColumnStatisticsData 结构](aws-glue-api-common.md#aws-glue-api-common-LongColumnStatisticsData)
  + [StringColumnStatisticsData 结构](aws-glue-api-common.md#aws-glue-api-common-StringColumnStatisticsData)
  + [BinaryColumnStatisticsData 结构](aws-glue-api-common.md#aws-glue-api-common-BinaryColumnStatisticsData)
  + [字符串模式](aws-glue-api-common.md#aws-glue-api-common-_string-patterns)
+ [异常](aws-glue-api-exceptions.md)
  + [AccessDeniedException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-AccessDeniedException)
  + [AlreadyExistsException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-AlreadyExistsException)
  + [ConcurrentModificationException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-ConcurrentModificationException)
  + [ConcurrentRunsExceededException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-ConcurrentRunsExceededException)
  + [CrawlerNotRunningException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-CrawlerNotRunningException)
  + [CrawlerRunningException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-CrawlerRunningException)
  + [CrawlerStoppingException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-CrawlerStoppingException)
  + [EntityNotFoundException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-EntityNotFoundException)
  + [FederationSourceException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-FederationSourceException)
  + [FederationSourceRetryableException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-FederationSourceRetryableException)
  + [GlueEncryptionException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-GlueEncryptionException)
  + [IdempotentParameterMismatchException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-IdempotentParameterMismatchException)
  + [IllegalWorkflowStateException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-IllegalWorkflowStateException)
  + [InternalServiceException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-InternalServiceException)
  + [InvalidExecutionEngineException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-InvalidExecutionEngineException)
  + [InvalidInputException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-InvalidInputException)
  + [InvalidStateException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-InvalidStateException)
  + [InvalidTaskStatusTransitionException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-InvalidTaskStatusTransitionException)
  + [JobDefinitionErrorException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-JobDefinitionErrorException)
  + [JobRunInTerminalStateException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-JobRunInTerminalStateException)
  + [JobRunInvalidStateTransitionException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-JobRunInvalidStateTransitionException)
  + [JobRunNotInTerminalStateException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-JobRunNotInTerminalStateException)
  + [LateRunnerException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-LateRunnerException)
  + [NoScheduleException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-NoScheduleException)
  + [OperationTimeoutException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-OperationTimeoutException)
  + [ResourceNotReadyException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-ResourceNotReadyException)
  + [ResourceNumberLimitExceededException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-ResourceNumberLimitExceededException)
  + [SchedulerNotRunningException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-SchedulerNotRunningException)
  + [SchedulerRunningException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-SchedulerRunningException)
  + [SchedulerTransitioningException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-SchedulerTransitioningException)
  + [UnrecognizedRunnerException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-UnrecognizedRunnerException)
  + [ValidationException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-ValidationException)
  + [VersionMismatchException 结构](aws-glue-api-exceptions.md#aws-glue-api-exceptions-VersionMismatchException)

# AWS Glue 中的安全性 API
<a name="aws-glue-api-jobs-security"></a>

安全性 API 介绍安全数据类型以及与 AWS Glue 中的安全性相关的 API。

## 数据类型
<a name="aws-glue-api-jobs-security-objects"></a>
+ [DataCatalogEncryptionSettings 结构](#aws-glue-api-jobs-security-DataCatalogEncryptionSettings)
+ [EncryptionAtRest 结构](#aws-glue-api-jobs-security-EncryptionAtRest)
+ [ConnectionPasswordEncryption 结构](#aws-glue-api-jobs-security-ConnectionPasswordEncryption)
+ [EncryptionConfiguration 结构](#aws-glue-api-jobs-security-EncryptionConfiguration)
+ [S3Encryption 结构](#aws-glue-api-jobs-security-S3Encryption)
+ [CloudWatchEncryption 结构](#aws-glue-api-jobs-security-CloudWatchEncryption)
+ [JobBookmarksEncryption 结构](#aws-glue-api-jobs-security-JobBookmarksEncryption)
+ [SecurityConfiguration 结构](#aws-glue-api-jobs-security-SecurityConfiguration)
+ [GluePolicy 结构](#aws-glue-api-jobs-security-GluePolicy)
+ [DataQualityEncryption 结构](#aws-glue-api-jobs-security-DataQualityEncryption)

## DataCatalogEncryptionSettings 结构
<a name="aws-glue-api-jobs-security-DataCatalogEncryptionSettings"></a>

包含用于维护数据目录安全性的配置信息。

**Fields**
+ `EncryptionAtRest` – 一个 [EncryptionAtRest](#aws-glue-api-jobs-security-EncryptionAtRest) 对象。

  为数据目录指定静态加密配置。
+ `ConnectionPasswordEncryption` – 一个 [ConnectionPasswordEncryption](#aws-glue-api-jobs-security-ConnectionPasswordEncryption) 对象。

  启用连接密码保护后，数据目录使用客户提供的密钥作为 `CreateConnection` 或 `UpdateConnection` 的一部分来加密密码，并将密码存储在连接属性中的 `ENCRYPTED_PASSWORD` 字段中。您可以启用目录加密或仅密码加密。

## EncryptionAtRest 结构
<a name="aws-glue-api-jobs-security-EncryptionAtRest"></a>

为数据目录指定静态加密配置。

**Fields**
+ `CatalogEncryptionMode` – *必填：* UTF-8 字符串（有效值：`DISABLED` \$1 `SSE-KMS="SSEKMS"` \$1 `SSE-KMS-WITH-SERVICE-ROLE="SSEKMSWITHSERVICEROLE"`）。

  用于对数据目录数据进行加密的静态加密模式。
+ `SseAwsKmsKeyId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于静态加密的 AWS KMS 密钥的 ID。
+ `CatalogEncryptionServiceRole` – UTF-8 字符串，与 [Custom string pattern #53](aws-glue-api-common.md#regex_53) 匹配。

  AWS Glue 为了代表调用者加密和解密数据目录对象而代入的角色。

## ConnectionPasswordEncryption 结构
<a name="aws-glue-api-jobs-security-ConnectionPasswordEncryption"></a>

数据目录用于加密密码的数据结构，作为 `CreateConnection` 或 `UpdateConnection` 的一部分，并将其存储在连接属性的 `ENCRYPTED_PASSWORD` 字段中。您可以启用目录加密或仅密码加密。

当包含密码的 `CreationConnection` 请求到达时，数据目录首先使用您的 AWS KMS 密钥加密密码。然后，如果还启用了目录加密，数据目录会再次加密整个连接对象。

此加密要求您根据安全要求设置 AWS KMS 密钥权限以启用或限制对密码密钥的访问。例如，您可能只希望管理员拥有密码密钥的解密权限。

**Fields**
+ `ReturnConnectionPasswordEncrypted` – *必填：*布尔值。

  当 `ReturnConnectionPasswordEncrypted` 标记设置为“true”时，在 `GetConnection` 和 `GetConnections` 响应中密码仍然保持加密状态。此加密独立于目录加密生效。
+ `AwsKmsKeyId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于加密连接密码的 AWS KMS 密钥。

  如果启用了连接密码保护，则 `CreateConnection` 和 `UpdateConnection` 的调用方至少需要指定的 AWS KMS 密钥的 `kms:Encrypt` 权限，才能在将密码存储在数据目录中之前加密密码。

  您可以根据安全要求设置解密权限以启用或限制对密码密钥的访问。

## EncryptionConfiguration 结构
<a name="aws-glue-api-jobs-security-EncryptionConfiguration"></a>

指定加密配置。

**Fields**
+ `S3Encryption` – [S3Encryption](#aws-glue-api-jobs-security-S3Encryption) 对象的数组。

  Amazon Simple Storage Service (Amazon S3) 数据的加密配置。
+ `CloudWatchEncryption` – 一个 [CloudWatchEncryption](#aws-glue-api-jobs-security-CloudWatchEncryption) 对象。

  Amazon CloudWatch 的加密配置。
+ `JobBookmarksEncryption` – 一个 [JobBookmarksEncryption](#aws-glue-api-jobs-security-JobBookmarksEncryption) 对象。

  作业书签的加密配置。
+ `DataQualityEncryption` – 一个 [DataQualityEncryption](#aws-glue-api-jobs-security-DataQualityEncryption) 对象。

  AWS Glue 数据质量资产的加密配置。

## S3Encryption 结构
<a name="aws-glue-api-jobs-security-S3Encryption"></a>

指定怎样对 Amazon Simple Storage Service（Amazon S3）数据进行加密。

**Fields**
+ `S3EncryptionMode` – UTF-8 字符串（有效值：`DISABLED` \$1`SSE-KMS="SSEKMS"` \$1`SSE-S3="SSES3"` ）。

  用于 Amazon S3 数据的加密模式。
+ `KmsKeyArn` – UTF-8 字符串，与 [Custom string pattern #42](aws-glue-api-common.md#regex_42) 匹配。

  用于加密数据的 KMS 密钥的 Amazon Resource Name（ARN）。

## CloudWatchEncryption 结构
<a name="aws-glue-api-jobs-security-CloudWatchEncryption"></a>

指定如何加密 Amazon CloudWatch 数据。

**Fields**
+ `CloudWatchEncryptionMode` – UTF-8 字符串（有效值：`DISABLED` \$1`SSE-KMS="SSEKMS"` ）。

  用于 CloudWatch 数据的加密模式。
+ `KmsKeyArn` – UTF-8 字符串，与 [Custom string pattern #42](aws-glue-api-common.md#regex_42) 匹配。

  用于加密数据的 KMS 密钥的 Amazon Resource Name（ARN）。

## JobBookmarksEncryption 结构
<a name="aws-glue-api-jobs-security-JobBookmarksEncryption"></a>

指定如何加密任务书签数据。

**Fields**
+ `JobBookmarksEncryptionMode` – UTF-8 字符串（有效值：`DISABLED` \$1`CSE-KMS="CSEKMS"` ）。

  用于任务书签数据的加密模式。
+ `KmsKeyArn` – UTF-8 字符串，与 [Custom string pattern #42](aws-glue-api-common.md#regex_42) 匹配。

  用于加密数据的 KMS 密钥的 Amazon Resource Name（ARN）。

## SecurityConfiguration 结构
<a name="aws-glue-api-jobs-security-SecurityConfiguration"></a>

指定安全配置。

**Fields**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  安全配置的名称。
+ `CreatedTimeStamp` – 时间戳。

  创建此安全配置的时间点。
+ `EncryptionConfiguration` – 一个 [EncryptionConfiguration](#aws-glue-api-jobs-security-EncryptionConfiguration) 对象。

  与此安全配置关联的加密配置。

## GluePolicy 结构
<a name="aws-glue-api-jobs-security-GluePolicy"></a>

返回资源策略的结构。

**Fields**
+ `PolicyInJson` – UTF-8 字符串，至少 2 个字节。

  包含 JSON 格式的请求策略文档。
+ `PolicyHash` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  包含与此策略关联的哈希值。
+ `CreateTime` – 时间戳。

  创建策略的日期和时间。
+ `UpdateTime` – 时间戳。

  上次更新策略的日期和时间。

## DataQualityEncryption 结构
<a name="aws-glue-api-jobs-security-DataQualityEncryption"></a>

指定应如何加密账户中的数据质量资产。

**Fields**
+ `DataQualityEncryptionMode` – UTF-8 字符串（有效值：`DISABLED` \$1`SSE-KMS="SSEKMS"` ）。

  用于数据质量资产加密的加密模式。这些资产包括数据质量规则集、结果、统计数据、异常检测模型以及观测结果。

  有效值是 `SSEKMS`（适用于使用客户自主管理型 KMS 密钥进行加密）或 `DISABLED`。
+ `KmsKeyArn` – UTF-8 字符串，与 [Custom string pattern #42](aws-glue-api-common.md#regex_42) 匹配。

  用于加密数据的 KMS 密钥的 Amazon Resource Name（ARN）。

## 操作
<a name="aws-glue-api-jobs-security-actions"></a>
+ [GetDataCatalogEncryptionSettings 操作（Python：get\$1data\$1catalog\$1encryption\$1settings）](#aws-glue-api-jobs-security-GetDataCatalogEncryptionSettings)
+ [PutDataCatalogEncryptionSettings 操作（Python： put\$1data\$1catalog\$1encryption\$1settings）](#aws-glue-api-jobs-security-PutDataCatalogEncryptionSettings)
+ [PutResourcePolicy 操作（Python：put\$1resource\$1policy）](#aws-glue-api-jobs-security-PutResourcePolicy)
+ [GetResourcePolicy 操作（Python：get\$1resource\$1policy）](#aws-glue-api-jobs-security-GetResourcePolicy)
+ [DeleteResourcePolicy 操作（Python：delete\$1resource\$1policy）](#aws-glue-api-jobs-security-DeleteResourcePolicy)
+ [CreateSecurityConfiguration 操作（Python：create\$1security\$1configuration）](#aws-glue-api-jobs-security-CreateSecurityConfiguration)
+ [DeleteSecurityConfiguration 操作（Python：delete\$1security\$1configuration）](#aws-glue-api-jobs-security-DeleteSecurityConfiguration)
+ [GetSecurityConfiguration 操作（Python：get\$1security\$1configuration）](#aws-glue-api-jobs-security-GetSecurityConfiguration)
+ [GetSecurityConfigurations 操作（Python：get\$1security\$1configurations）](#aws-glue-api-jobs-security-GetSecurityConfigurations)
+ [GetResourcePolicies 操作（Python：get\$1resource\$1policie）](#aws-glue-api-jobs-security-GetResourcePolicies)

## GetDataCatalogEncryptionSettings 操作（Python：get\$1data\$1catalog\$1encryption\$1settings）
<a name="aws-glue-api-jobs-security-GetDataCatalogEncryptionSettings"></a>

检索指定目录的安全配置。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索其安全配置的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。

**响应**
+ `DataCatalogEncryptionSettings` – 一个 [DataCatalogEncryptionSettings](#aws-glue-api-jobs-security-DataCatalogEncryptionSettings) 对象。

  请求的安全配置。

**错误**
+ `InternalServiceException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## PutDataCatalogEncryptionSettings 操作（Python： put\$1data\$1catalog\$1encryption\$1settings）
<a name="aws-glue-api-jobs-security-PutDataCatalogEncryptionSettings"></a>

设置指定目录的安全配置。设置配置后，指定的加密将应用于之后的每个目录写入。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要设置其安全配置的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DataCatalogEncryptionSettings` – *必填：*一个 [DataCatalogEncryptionSettings](#aws-glue-api-jobs-security-DataCatalogEncryptionSettings) 对象。

  要设置的安全配置。

**响应**
+ *无响应参数。*

**错误**
+ `InternalServiceException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## PutResourcePolicy 操作（Python：put\$1resource\$1policy）
<a name="aws-glue-api-jobs-security-PutResourcePolicy"></a>

设置用于访问控制的数据目录资源策略。

**请求**
+ `PolicyInJson` – *必需：* UTF-8 字符串，至少 2 个字节。

  包含要设置的 JSON 格式的策略文档。
+ `ResourceArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  不使用。仅供内部使用。
+ `PolicyHashCondition` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  在使用 `PutResourcePolicy` 设置上一个策略时返回的哈希值。其用途是防止并发修改策略。如果未设置先前策略，请勿使用此参数。
+ `PolicyExistsCondition` – UTF-8 字符串（有效值：`MUST_EXIST` \$1`NOT_EXIST` \$1`NONE` ）。

  `MUST_EXIST` 的值用于更新策略。`NOT_EXIST` 的值用于创建新策略。如果使用 `NONE` 值或空值，调用不依赖于策略是否存在。
+ `EnableHybrid` – UTF-8 字符串（有效值：`TRUE` \$1`FALSE` ）。

  如果 `'TRUE'`，表示您正在使用这两种方法来授予对数据目录资源的跨账户访问权限：
  + 通过使用 `PutResourePolicy` 直接更新资源策略
  + 通过使用 AWS 管理控制台 上的**授予权限**命令。

  如果您已经使用管理控制台授予跨账户访问权限，则必须设置为 `'TRUE'`，否则调用会失败。默认设置为“FALSE”。

**响应**
+ `PolicyHash` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  刚刚设置的策略的哈希。此值必须包含在覆盖或更新该策略的后续调用中。

**错误**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `ConditionCheckFailureException`

## GetResourcePolicy 操作（Python：get\$1resource\$1policy）
<a name="aws-glue-api-jobs-security-GetResourcePolicy"></a>

检索指定的资源策略。

**请求**
+ `ResourceArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  要检索其资源策略的 AWS Glue 资源的 ARN。如果未提供，则返回数据目录资源策略。使用 `GetResourcePolicies` 查看所有现有资源策略。有关更多信息，请参阅[指定 AWS Glue 资源 ARN](https://docs.aws.amazon.com/glue/latest/dg/glue-specifying-resource-arns.html)。

**响应**
+ `PolicyInJson` – UTF-8 字符串，至少 2 个字节。

  包含 JSON 格式的请求策略文档。
+ `PolicyHash` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  包含与此策略关联的哈希值。
+ `CreateTime` – 时间戳。

  创建策略的日期和时间。
+ `UpdateTime` – 时间戳。

  上次更新策略的日期和时间。

**错误**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## DeleteResourcePolicy 操作（Python：delete\$1resource\$1policy）
<a name="aws-glue-api-jobs-security-DeleteResourcePolicy"></a>

删除指定的策略。

**请求**
+ `PolicyHashCondition` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  设置此策略时返回的哈希值。
+ `ResourceArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  要删除的资源策略的 AWS Glue 资源的 ARN。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `ConditionCheckFailureException`

## CreateSecurityConfiguration 操作（Python：create\$1security\$1configuration）
<a name="aws-glue-api-jobs-security-CreateSecurityConfiguration"></a>

创建新的安全配置。安全配置是 AWS Glue 可以使用的一组安全属性。您可以使用安全配置加密静态数据。有关使用 AWS Glue 中的安全配置的信息，请参阅[加密由爬网程序、任务和开发端点写入的数据](https://docs.aws.amazon.com/glue/latest/dg/encryption-security-configuration.html)。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  新安全配置的名称。
+ `EncryptionConfiguration` – *必填：*一个 [EncryptionConfiguration](#aws-glue-api-jobs-security-EncryptionConfiguration) 对象。

  新安全配置的加密配置。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分配给新安全配置的名称。
+ `CreatedTimestamp` – 时间戳。

  创建新安全配置的时间点。

**错误**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`

## DeleteSecurityConfiguration 操作（Python：delete\$1security\$1configuration）
<a name="aws-glue-api-jobs-security-DeleteSecurityConfiguration"></a>

删除指定的安全配置。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的安全配置的名称。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## GetSecurityConfiguration 操作（Python：get\$1security\$1configuration）
<a name="aws-glue-api-jobs-security-GetSecurityConfiguration"></a>

检索指定的安全配置。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索的安全配置的名称。

**响应**
+ `SecurityConfiguration` – 一个 [SecurityConfiguration](#aws-glue-api-jobs-security-SecurityConfiguration) 对象。

  请求的安全配置。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## GetSecurityConfigurations 操作（Python：get\$1security\$1configurations）
<a name="aws-glue-api-jobs-security-GetSecurityConfigurations"></a>

检索所有安全配置的列表。

**请求**
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的最大结果数量。
+ `NextToken` – UTF-8 字符串。

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

**响应**
+ `SecurityConfigurations` – [SecurityConfiguration](#aws-glue-api-jobs-security-SecurityConfiguration) 对象的数组。

  安全配置的列表。
+ `NextToken` – UTF-8 字符串。

  一个延续令牌（如果有多个安全配置要返回）。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## GetResourcePolicies 操作（Python：get\$1resource\$1policie）
<a name="aws-glue-api-jobs-security-GetResourcePolicies"></a>

在跨账户权限授予期间检索 AWS Resource Access Manager 在单个资源上设置的资源策略。同时检索数据目录资源策略。

如果您在数据目录设置中启用了元数据加密，并且您没有 AWS KMS 密钥的权限，则操作无法返回数据目录资源策略。

**请求**
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果这是延续请求)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的列表的最大大小。

**响应**
+ `GetResourcePoliciesResponseList` – [GluePolicy](#aws-glue-api-jobs-security-GluePolicy) 对象的数组。

  单个资源策略和账户级资源策略列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌（如果返回的列表不包含上一个可用的资源策略）。

**错误**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`

# 目录对象 API
<a name="aws-glue-api-catalog"></a>

目录对象 API 描述了与使用 AWS Glue 中的目录相关的数据类型和 API。

**Topics**
+ [目录 API](aws-glue-api-catalog-catalogs.md)
+ [数据库 API](aws-glue-api-catalog-databases.md)
+ [表 API](aws-glue-api-catalog-tables.md)
+ [分区 API](aws-glue-api-catalog-partitions.md)
+ [连接 API](aws-glue-api-catalog-connections.md)
+ [用户定义的函数 API](aws-glue-api-catalog-functions.md)
+ [将 Athena 目录导入 AWS Glue](aws-glue-api-catalog-migration.md)

# 目录 API
<a name="aws-glue-api-catalog-catalogs"></a>

目录 API 描述了用于创建、删除、查找、更新和列出目录的 API。

## 数据类型
<a name="aws-glue-api-catalog-catalogs-objects"></a>
+ [目录结构](#aws-glue-api-catalog-catalogs-Catalog)
+ [CatalogInput 结构](#aws-glue-api-catalog-catalogs-CatalogInput)
+ [TargetRedshiftCatalog 结构](#aws-glue-api-catalog-catalogs-TargetRedshiftCatalog)
+ [CatalogProperties 结构](#aws-glue-api-catalog-catalogs-CatalogProperties)
+ [CatalogPropertiesOutput 结构](#aws-glue-api-catalog-catalogs-CatalogPropertiesOutput)
+ [DataLakeAccessProperties 结构](#aws-glue-api-catalog-catalogs-DataLakeAccessProperties)
+ [IcebergOptimizationProperties 结构](#aws-glue-api-catalog-catalogs-IcebergOptimizationProperties)
+ [DataLakeAccessPropertiesOutput 结构](#aws-glue-api-catalog-catalogs-DataLakeAccessPropertiesOutput)
+ [IcebergOptimizationPropertiesOutput 结构](#aws-glue-api-catalog-catalogs-IcebergOptimizationPropertiesOutput)
+ [FederatedCatalog 结构](#aws-glue-api-catalog-catalogs-FederatedCatalog)

## 目录结构
<a name="aws-glue-api-catalog-catalogs-Catalog"></a>

目录对象表示 AWS Glue Data Catalog 或联合源中的数据库的逻辑分组。您现在可以创建 Redshift 联合目录，也可以创建包含指向另一个账户或区域中的 Redshift 数据库的资源链接的目录。

**Fields**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  目录的 ID。要授予对默认目录的访问权限，不应提供此字段。
+ `Name`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 64 个字节，与 [Custom string pattern #25](aws-glue-api-common.md#regex_25) 匹配。

  目录的名称。不能与账户 ID 相同。
+ `ResourceArn` – UTF-8 字符串。

  分配给目录资源的 Amazon 资源名称 (ARN)。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  描述字符串，长度不超过 2048 个字节，与 URI 地址多行字符串模式匹配。目录的描述。
+ `Parameters` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

   定义目录的参数和属性的键值对的映射数组。
+ `CreateTime` – 时间戳。

  创建目录的时间。
+ `UpdateTime` – 时间戳。

  上次更新目录的时间。
+ `TargetRedshiftCatalog` – 一个 [TargetRedshiftCatalog](#aws-glue-api-catalog-catalogs-TargetRedshiftCatalog) 对象。

  描述数据库资源链接的目标目录的 `TargetRedshiftCatalog` 对象。
+ `FederatedCatalog` – 一个 [FederatedCatalog](#aws-glue-api-catalog-catalogs-FederatedCatalog) 对象。

  指向 AWS Glue Data Catalog 外部某个实体的 `FederatedCatalog` 对象。
+ `CatalogProperties` – 一个 [CatalogPropertiesOutput](#aws-glue-api-catalog-catalogs-CatalogPropertiesOutput) 对象。

  指定数据湖访问属性和其他自定义属性的 `CatalogProperties` 对象。
+ `CreateTableDefaultPermissions` – [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions) 对象的数组。

  `PrincipalPermissions` 数据元数组。在表上为主体创建一组默认权限。由 AWS Lake Formation 使用。正常的 AWS Glue 操作过程中不使用。
+ `CreateDatabaseDefaultPermissions` – [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions) 对象的数组。

  `PrincipalPermissions` 数据元数组。在数据库上为主体创建一组默认权限。由 AWS Lake Formation 使用。正常的 AWS Glue 操作过程中不使用。
+ `AllowFullTableExternalDataAccess` – UTF-8 字符串（有效值：`True` \$1`False` ）。

   允许第三方引擎访问已在 Lake Formation 中注册的 Amazon S3 位置处的数据。

## CatalogInput 结构
<a name="aws-glue-api-catalog-catalogs-CatalogInput"></a>

描述目录属性的结构。

**Fields**
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  描述字符串，长度不超过 2048 个字节，与 URI 地址多行字符串模式匹配。目录的描述。
+ `FederatedCatalog` – 一个 [FederatedCatalog](#aws-glue-api-catalog-catalogs-FederatedCatalog) 对象。

  一个 `FederatedCatalog` 对象。引用 AWS Glue Data Catalog 外部某个实体（例如 Redshift 数据库）的 `FederatedCatalog` 结构。
+ `Parameters` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  定义目录的参数和属性的键值对的映射数组。
+ `TargetRedshiftCatalog` – 一个 [TargetRedshiftCatalog](#aws-glue-api-catalog-catalogs-TargetRedshiftCatalog) 对象。

  描述资源链接的目标目录的 `TargetRedshiftCatalog` 对象。
+ `CatalogProperties` – 一个 [CatalogProperties](#aws-glue-api-catalog-catalogs-CatalogProperties) 对象。

  指定数据湖访问属性和其他自定义属性的 `CatalogProperties` 对象。
+ `CreateTableDefaultPermissions` – [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions) 对象的数组。

  `PrincipalPermissions` 数据元数组。在表上为主体创建一组默认权限。由 AWS Lake Formation 使用。通常应明确设置为空列表。
+ `CreateDatabaseDefaultPermissions` – [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions) 对象的数组。

  `PrincipalPermissions` 数据元数组。在数据库上为主体创建一组默认权限。由 AWS Lake Formation 使用。通常应明确设置为空列表。
+ `AllowFullTableExternalDataAccess` – UTF-8 字符串（有效值：`True` \$1`False` ）。

   允许第三方引擎访问已在 Lake Formation 中注册的 Amazon S3 位置处的数据。

## TargetRedshiftCatalog 结构
<a name="aws-glue-api-catalog-catalogs-TargetRedshiftCatalog"></a>

描述用于资源链接的目标目录的结构。

**Fields**
+ `CatalogArn` – *必填：*UTF-8 字符串。

  目录资源的 Amazon 资源名称 (ARN)。

## CatalogProperties 结构
<a name="aws-glue-api-catalog-catalogs-CatalogProperties"></a>

指定数据湖访问属性和其他自定义属性的结构。

**Fields**
+ `DataLakeAccessProperties` – 一个 [DataLakeAccessProperties](#aws-glue-api-catalog-catalogs-DataLakeAccessProperties) 对象。

  `DataLakeAccessProperties` 对象，指定用于为 AWS Glue Data Catalog 中的目录资源配置数据湖访问的属性。
+ `IcebergOptimizationProperties` – 一个 [IcebergOptimizationProperties](#aws-glue-api-catalog-catalogs-IcebergOptimizationProperties) 对象。

  一种结构，可为目录指定 Iceberg 表优化属性。这包括可应用于该目录中 Iceberg 表的压缩、保留和孤立文件删除操作的配置。
+ `CustomProperties` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  目录的其他键值属性，例如列统计数据优化。

## CatalogPropertiesOutput 结构
<a name="aws-glue-api-catalog-catalogs-CatalogPropertiesOutput"></a>

包括目录资源的配置属性的属性特性。

**Fields**
+ `DataLakeAccessProperties` – 一个 [DataLakeAccessPropertiesOutput](#aws-glue-api-catalog-catalogs-DataLakeAccessPropertiesOutput) 对象。

  具有输入属性的 `DataLakeAccessProperties` 对象，用于为 AWS Glue Data Catalog 中的目录资源配置数据湖访问。
+ `IcebergOptimizationProperties` – 一个 [IcebergOptimizationPropertiesOutput](#aws-glue-api-catalog-catalogs-IcebergOptimizationPropertiesOutput) 对象。

  一个 `IcebergOptimizationPropertiesOutput` 对象，可为目录指定 Iceberg 表优化设置，包括压缩、保留和孤立文件删除操作的配置。
+ `CustomProperties` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  目录的其他键值属性，例如列统计数据优化。

## DataLakeAccessProperties 结构
<a name="aws-glue-api-catalog-catalogs-DataLakeAccessProperties"></a>

用于为 AWS Glue Data Catalog 中的目录资源配置数据湖访问的输入属性。

**Fields**
+ `DataLakeAccess` – 布尔值。

  为从任何非 Redshift 引擎（例如 Amazon Athena、Amazon EMR 或 AWS Glue ETL）访问 Data Catalog 中的 Amazon Redshift 数据库的 Apache Spark 应用程序开启或关闭数据湖访问。
+ `DataTransferRole` – UTF-8 字符串，与 [Custom string pattern #53](aws-glue-api-common.md#regex_53) 匹配。

  AWS Glue 将代入的、在查询期间将数据传输到暂存存储桶/从暂存存储桶传输出的角色。
+ `KmsKey` – UTF-8 字符串。

  将用于与目录一起创建的暂存存储桶的加密密钥。
+ `CatalogType` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  为本机目录资源指定联合目录类型。目前支持的类型是 `aws:redshift`。

## IcebergOptimizationProperties 结构
<a name="aws-glue-api-catalog-catalogs-IcebergOptimizationProperties"></a>

一种结构，可为目录指定 Iceberg 表优化属性，包括压缩、保留和孤立文件删除操作的配置。

**Fields**
+ `RoleArn` – UTF-8 字符串，与 [Custom string pattern #53](aws-glue-api-common.md#regex_53) 匹配。

  将代入以执行 Iceberg 表优化操作的 IAM 角色的 Amazon 资源名称（ARN）。
+ `Compaction` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  键值对映射，可为 Iceberg 表压缩操作指定配置参数，这些操作可优化数据文件的布局以提高查询性能。
+ `Retention` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  键值对映射，可为 Iceberg 表保留操作指定配置参数，这些操作可管理表快照的生命周期以控制存储成本。
+ `OrphanFileDeletion` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  键值对映射，可为 Iceberg 孤立文件删除操作指定配置参数，这些操作可识别和删除表元数据不再引用的文件。

## DataLakeAccessPropertiesOutput 结构
<a name="aws-glue-api-catalog-catalogs-DataLakeAccessPropertiesOutput"></a>

用于为 AWS Glue Data Catalog 中的目录资源配置数据湖访问的输出属性。

**Fields**
+ `DataLakeAccess` – 布尔值。

  为访问 Data Catalog 中的 Amazon Redshift 数据库的 Apache Spark 应用程序开启或关闭数据湖访问。
+ `DataTransferRole` – UTF-8 字符串，与 [Custom string pattern #53](aws-glue-api-common.md#regex_53) 匹配。

  AWS Glue 将代入的、在查询期间将数据传输到暂存存储桶/从暂存存储桶传输出的角色。
+ `KmsKey` – UTF-8 字符串。

  将用于与目录一起创建的暂存存储桶的加密密钥。
+ `ManagedWorkgroupName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  为您的目录资源创建的托管 Redshift Serverless 计算名称。
+ `ManagedWorkgroupStatus` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  托管 Redshift Serverless 计算状态。
+ `RedshiftDatabaseName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  托管计算中的默认 Redshift 数据库资源名称。
+ `StatusMessage` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  该消息提供有关托管工作组状态的更多详细信息。
+ `CatalogType` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  为本机目录资源指定联合目录类型。目前支持的类型是 `aws:redshift`。

## IcebergOptimizationPropertiesOutput 结构
<a name="aws-glue-api-catalog-catalogs-IcebergOptimizationPropertiesOutput"></a>

一种结构，其中包含用于 AWS Glue Data Catalog 中目录资源的 Iceberg 表优化配置的输出属性。

**Fields**
+ `RoleArn` – UTF-8 字符串，与 [Custom string pattern #53](aws-glue-api-common.md#regex_53) 匹配。

  用于执行 Iceberg 表优化操作的 IAM 角色的 Amazon 资源名称（ARN）。
+ `Compaction` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  键值对映射，可为 Iceberg 表压缩操作指定配置参数，这些操作可优化数据文件的布局以提高查询性能。
+ `Retention` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  键值对映射，可为 Iceberg 表保留操作指定配置参数，这些操作可管理表快照的生命周期以控制存储成本。
+ `OrphanFileDeletion` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  键值对映射，可为 Iceberg 孤立文件删除操作指定配置参数，这些操作可识别和删除表元数据不再引用的文件。
+ `LastUpdatedTime` – 时间戳。

  上次更新 Iceberg 优化属性时的时间戳。

## FederatedCatalog 结构
<a name="aws-glue-api-catalog-catalogs-FederatedCatalog"></a>

指向 AWS Glue Data Catalog 外部某个实体的目录。

**Fields**
+ `Identifier` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  联合目录的唯一标识符。
+ `ConnectionName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与外部数据来源的连接的名称，例如 Redshift 联合目录。
+ `ConnectionType` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于访问联合目录的连接类型，指定连接外部数据来源的协议或方法。

## 操作
<a name="aws-glue-api-catalog-catalogs-actions"></a>
+ [CreateCatalog 操作（Python：create\$1catalog）](#aws-glue-api-catalog-catalogs-CreateCatalog)
+ [UpdateCatalog 操作（Python：update\$1catalog）](#aws-glue-api-catalog-catalogs-UpdateCatalog)
+ [DeleteCatalog 操作（Python：delete\$1catalog）](#aws-glue-api-catalog-catalogs-DeleteCatalog)
+ [GetCatalog 操作（Python：get\$1catalog）](#aws-glue-api-catalog-catalogs-GetCatalog)
+ [GetCatalogs 操作（Python：get\$1catalogs）](#aws-glue-api-catalog-catalogs-GetCatalogs)

## CreateCatalog 操作（Python：create\$1catalog）
<a name="aws-glue-api-catalog-catalogs-CreateCatalog"></a>

在 AWS Glue Data Catalog 中创建新目录。

**请求**
+ `Name`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 64 个字节，与 [Custom string pattern #25](aws-glue-api-common.md#regex_25) 匹配。

  要创建的目录的名称。
+ `CatalogInput` – *必填：*一个 [CatalogInput](#aws-glue-api-catalog-catalogs-CatalogInput) 对象。

  定义目录的元数据的 `CatalogInput` 对象。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  键值对的映射数组，不超过 50 对。每个键都是一个 UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。每个值是一个 UTF-8 字符串，不超过 256 个字节。您分配给目录的标签。

**响应**
+ *无响应参数。*

**错误**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `FederatedResourceAlreadyExistsException`
+ `FederationSourceException`

## UpdateCatalog 操作（Python：update\$1catalog）
<a name="aws-glue-api-catalog-catalogs-UpdateCatalog"></a>

更新 AWS Glue Data Catalog 中现有目录的属性。

**请求**
+ `CatalogId` –*必填项：*目录 id 字符串，长度不少于 1 个字节，并且不超过 255 个字节，并且符合 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  目录的 ID。
+ `CatalogInput` – *必填：*一个 [CatalogInput](#aws-glue-api-catalog-catalogs-CatalogInput) 对象。

  指定现有目录的新属性的 `CatalogInput` 对象。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `AccessDeniedException`
+ `FederationSourceException`

## DeleteCatalog 操作（Python：delete\$1catalog）
<a name="aws-glue-api-catalog-catalogs-DeleteCatalog"></a>

从 AWS Glue Data Catalog 中移除指定的目录。

完成此操作后，您将无法再访问已删除目录中的数据库、表（以及可能属于表的所有表版本和分区）和用户定义的函数。AWS Glue 会及时以异步方式删除这些“孤立”资源，这由服务决定。

为了确保在调用 `DeleteCatalog` 操作之前立即删除所有相关资源，请使用 `DeleteTableVersion`（或 `BatchDeleteTableVersion`）、`DeletePartition`（或 `BatchDeletePartition`）、`DeleteTable`（或 `BatchDeleteTable`）、`DeleteUserDefinedFunction` 和 `DeleteDatabase` 删除属于该目录的任何资源。

**请求**
+ `CatalogId` –*必填项：*目录 id 字符串，长度不少于 1 个字节，并且不超过 255 个字节，并且符合 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  目录的 ID。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `AccessDeniedException`
+ `FederationSourceException`

## GetCatalog 操作（Python：get\$1catalog）
<a name="aws-glue-api-catalog-catalogs-GetCatalog"></a>

要检索的目录的名称。应当全部小写。

**请求**
+ `CatalogId` –*必填项：*目录 id 字符串，长度不少于 1 个字节，并且不超过 255 个字节，并且符合 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  目录所在父目录的 ID。如果没有提供，则默认情况下使用 AWS 账号。

**响应**
+ `Catalog` – 一个 [目录](#aws-glue-api-catalog-catalogs-Catalog) 对象。

  一个 `Catalog` 对象。AWS Glue Data Catalog 中指定目录的定义。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`

## GetCatalogs 操作（Python：get\$1catalogs）
<a name="aws-glue-api-catalog-catalogs-GetCatalogs"></a>

检索 AWS Glue Data Catalog 中某个目录中定义的所有目录。对于 Redshift 联合目录使用场景，此操作返回映射到 Redshift 命名空间目录中的 Redshift 数据库的目录列表。

**请求**
+ `ParentCatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  目录所在父目录的 ID。如果没有提供，则默认情况下使用 AWS 账号。
+ `NextToken` – UTF-8 字符串。

  延续标记 (如果这是延续调用)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要在一个响应中返回的目录的最大数量。
+ `Recursive` – 布尔值。

  是否列出目录层次结构中的所有目录，从 `ParentCatalogId` 开始。默认值为 `false`。当为 `true` 时，`ParentCatalogID` 层次结构中的所有目录对象都将在响应中枚举。
+ `IncludeRoot` – 布尔值。

  是否在响应中列出账户和区域中的默认目录。默认值为 `false`。当为 `true` 和 `ParentCatalogId = NULL | AWS Account ID` 时，所有目录和默认目录都将在响应中枚举。

  如果 `ParentCatalogId` 不等于 null，并且此属性作为 `false` 或 `true` 进行传递，则会引发 `InvalidInputException`。

**响应**
+ `CatalogList` – *必填：*[目录](#aws-glue-api-catalog-catalogs-Catalog) 对象的数组。

  `Catalog` 数据元数组。指定父目录中的 `Catalog` 对象的列表。
+ `NextToken` – UTF-8 字符串。

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

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`

# 数据库 API
<a name="aws-glue-api-catalog-databases"></a>

数据库 API 介绍数据库数据类型，还包括用于创建、删除、定位、更新和列出数据库的 API。

## 数据类型
<a name="aws-glue-api-catalog-databases-objects"></a>
+ [Database 结构](#aws-glue-api-catalog-databases-Database)
+ [DatabaseInput 结构](#aws-glue-api-catalog-databases-DatabaseInput)
+ [PrincipalPermissions 结构](#aws-glue-api-catalog-databases-PrincipalPermissions)
+ [DataLakePrincipal 结构](#aws-glue-api-catalog-databases-DataLakePrincipal)
+ [DatabaseIdentifier 结构](#aws-glue-api-catalog-databases-DatabaseIdentifier)
+ [联合数据库结构](#aws-glue-api-catalog-databases-FederatedDatabase)

## Database 结构
<a name="aws-glue-api-catalog-databases-Database"></a>

`Database` 对象表示可能驻留在 Hive 元存储或 RDBMS 中的表的逻辑分组。

**字段**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据库的名称。为了确保 Hive 兼容性，它在存储时被转换为小写。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  对数据库的描述。
+ `LocationUri` - 统一资源标识符 (uri)，不少于 1 个字节或超过 1024 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  数据库的位置（例如，HDFS 路径）。
+ `Parameters` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  这些键值对定义数据库的参数和属性。
+ `CreateTime` – 时间戳。

  在目录中创建元数据数据库的时间。
+ `CreateTableDefaultPermissions` – [PrincipalPermissions](#aws-glue-api-catalog-databases-PrincipalPermissions) 对象的数组。

  在委托人表上创建一组默认权限。由 AWS Lake Formation 使用。正常的 AWS Glue 操作过程中不使用。
+ `TargetDatabase` – 一个 [DatabaseIdentifier](#aws-glue-api-catalog-databases-DatabaseIdentifier) 对象。

  描述用于资源链接的目标数据库的 `DatabaseIdentifier` 结构。
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据库所在的数据目录的 ID。
+ `FederatedDatabase` – 一个 [联合数据库](#aws-glue-api-catalog-databases-FederatedDatabase) 对象。

  一种引用 AWS Glue Data Catalog 外部实体的 `FederatedDatabase` 结构。

## DatabaseInput 结构
<a name="aws-glue-api-catalog-databases-DatabaseInput"></a>

用于创建或更新数据库的结构。

**字段**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据库的名称。为了确保 Hive 兼容性，它在存储时被转换为小写。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  对数据库的描述。
+ `LocationUri` - 统一资源标识符 (uri)，不少于 1 个字节或超过 1024 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  数据库的位置（例如，HDFS 路径）。
+ `Parameters` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  这些键值对定义数据库的参数和属性。

  这些键值对定义数据库的参数和属性。
+ `CreateTableDefaultPermissions` – [PrincipalPermissions](#aws-glue-api-catalog-databases-PrincipalPermissions) 对象的数组。

  在委托人表上创建一组默认权限。由 AWS Lake Formation 使用。正常的 AWS Glue 操作过程中不使用。
+ `TargetDatabase` – 一个 [DatabaseIdentifier](#aws-glue-api-catalog-databases-DatabaseIdentifier) 对象。

  描述用于资源链接的目标数据库的 `DatabaseIdentifier` 结构。
+ `FederatedDatabase` – 一个 [联合数据库](#aws-glue-api-catalog-databases-FederatedDatabase) 对象。

  一种引用 AWS Glue Data Catalog 外部实体的 `FederatedDatabase` 结构。

## PrincipalPermissions 结构
<a name="aws-glue-api-catalog-databases-PrincipalPermissions"></a>

向委托人授予的权限。

**字段**
+ `Principal` – 一个 [DataLakePrincipal](#aws-glue-api-catalog-databases-DataLakePrincipal) 对象。

  被授予权限的委托人。
+ `Permissions` – UTF-8 字符串数组。

  向委托人授予的权限。

## DataLakePrincipal 结构
<a name="aws-glue-api-catalog-databases-DataLakePrincipal"></a>

AWS Lake Formation 委托人。

**字段**
+ `DataLakePrincipalIdentifier` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节。

  AWS Lake Formation 委托人的标识符。

## DatabaseIdentifier 结构
<a name="aws-glue-api-catalog-databases-DatabaseIdentifier"></a>

描述用于资源链接的目标数据库的结构。

**字段**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据库所在的数据目录的 ID。
+ `DatabaseName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  目录数据库的名称。
+ `Region` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  目标数据库的区域。

## 联合数据库结构
<a name="aws-glue-api-catalog-databases-FederatedDatabase"></a>

指向 AWS Glue Data Catalog 外部实体的数据库。

**字段**
+ `Identifier` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  联合数据库的唯一标识符。
+ `ConnectionName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与外部元存储连接的名称。
+ `ConnectionType` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于访问联合数据库的连接类型，例如 JDBC、ODBC 或其他支持的连接协议。

## 操作
<a name="aws-glue-api-catalog-databases-actions"></a>
+ [CreateDatabase 操作（Python：create\$1database）](#aws-glue-api-catalog-databases-CreateDatabase)
+ [UpdateDatabase 操作（Python：update\$1database）](#aws-glue-api-catalog-databases-UpdateDatabase)
+ [DeleteDatabase 操作（Python：delete\$1database）](#aws-glue-api-catalog-databases-DeleteDatabase)
+ [GetDatabase 操作（Python：get\$1database）](#aws-glue-api-catalog-databases-GetDatabase)
+ [GetDatabases 操作（Python：get\$1databases）](#aws-glue-api-catalog-databases-GetDatabases)

## CreateDatabase 操作（Python：create\$1database）
<a name="aws-glue-api-catalog-databases-CreateDatabase"></a>

在数据目录中创建新数据库。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中创建数据库的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseInput` – *必填：*一个 [DatabaseInput](#aws-glue-api-catalog-databases-DatabaseInput) 对象。

  数据库的元数据。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  您分配给数据库的标签。

**响应**
+ *无响应参数。*

**错误**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `FederatedResourceAlreadyExistsException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`

## UpdateDatabase 操作（Python：update\$1database）
<a name="aws-glue-api-catalog-databases-UpdateDatabase"></a>

在数据目录中更新现有数据库定义。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  元数据数据库所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在目录中更新的数据库的名称。对于 Hive 兼容性，它会转化为小写。
+ `DatabaseInput` – *必填：*一个 [DatabaseInput](#aws-glue-api-catalog-databases-DatabaseInput) 对象。

  一个 `DatabaseInput` 对象，在目录中指定元数据数据库的新定义。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
+ `AlreadyExistsException`

## DeleteDatabase 操作（Python：delete\$1database）
<a name="aws-glue-api-catalog-databases-DeleteDatabase"></a>

从数据目录中删除指定的数据库。

**注意**  
完成此操作后，您将无法再访问已删除的数据库中的这些表（以及可能属于这些表的所有表版本和分区）和用户定义函数。AWS Glue 会及时以异步方式删除这些“孤立”资源，这由服务决定。  
为了确保立即删除所有相关资源，在调用 `DeleteDatabase` 之前，请使用 `DeleteTableVersion` 或 `BatchDeleteTableVersion`、`DeletePartition` 或 `BatchDeletePartition`、`DeleteUserDefinedFunction` 和 `DeleteTable` 或 `BatchDeleteTable`，删除属于该数据库的所有资源。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据库所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的数据库的名称。对于 Hive 兼容性，它必须是全部小写的。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`

## GetDatabase 操作（Python：get\$1database）
<a name="aws-glue-api-catalog-databases-GetDatabase"></a>

检索指定数据库的定义。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据库所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索的数据库的名称。对于 Hive 兼容性，它应该是全部小写的。

**响应**
+ `Database` – 一个 [数据库](#aws-glue-api-catalog-databases-Database) 对象。

  数据目录中指定数据库的定义。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`

## GetDatabases 操作（Python：get\$1databases）
<a name="aws-glue-api-catalog-databases-GetDatabases"></a>

检索在给定数据目录中定义的所有数据库。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中检索 `Databases` 的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `NextToken` – UTF-8 字符串。

  延续标记 (如果这是延续调用)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 100。

  要在一个响应中返回的数据库的最大数量。
+ `ResourceShareType` – UTF-8 字符串（有效值：`FOREIGN` \$1 `ALL` \$1 `FEDERATED`）。

  允许您指定要列出与您的账户共享的数据库。允许的值是 `FEDERATED`、`FOREIGN` 或 `ALL`。
  + 如果设置为 `FEDERATED`，将列出与您的账户共享的联合数据库（引用外部实体）。
  + 如果设置为 `FOREIGN`，将列出与您的账户共享的数据库。
  + 如果设置为 `ALL`，将列出与您的账户共享的数据库，以及本地账户中的数据库。
+ `AttributesToGet` – UTF-8 字符串数组。

  指定 `GetDatabases` 调用返回的数据库字段。此参数不接受空列表。请求中必须包含 `NAME`。

**响应**
+ `DatabaseList` – *必填：*[数据库](#aws-glue-api-catalog-databases-Database) 对象的数组。

  指定目录中的 `Database` 对象的列表。
+ `NextToken` – UTF-8 字符串。

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

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `EntityNotFoundException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`

# 表 API
<a name="aws-glue-api-catalog-tables"></a>

表 API 介绍与表关联的数据类型和操作。

## 数据类型
<a name="aws-glue-api-catalog-tables-objects"></a>
+ [Table 结构](#aws-glue-api-catalog-tables-Table)
+ [TableInput 结构](#aws-glue-api-catalog-tables-TableInput)
+ [联合表结构](#aws-glue-api-catalog-tables-FederatedTable)
+ [列结构](#aws-glue-api-catalog-tables-Column)
+ [StorageDescriptor 结构](#aws-glue-api-catalog-tables-StorageDescriptor)
+ [SchemaReference 结构](#aws-glue-api-catalog-tables-SchemaReference)
+ [SerDeInfo 结构](#aws-glue-api-catalog-tables-SerDeInfo)
+ [Order 结构](#aws-glue-api-catalog-tables-Order)
+ [SkewedInfo 结构](#aws-glue-api-catalog-tables-SkewedInfo)
+ [TableVersion 结构](#aws-glue-api-catalog-tables-TableVersion)
+ [TableError 结构](#aws-glue-api-catalog-tables-TableError)
+ [TableVersionError 结构](#aws-glue-api-catalog-tables-TableVersionError)
+ [SortCriterion 结构](#aws-glue-api-catalog-tables-SortCriterion)
+ [TableIdentifier 结构](#aws-glue-api-catalog-tables-TableIdentifier)
+ [KeySchemaElement 结构](#aws-glue-api-catalog-tables-KeySchemaElement)
+ [PartitionIndex 结构](#aws-glue-api-catalog-tables-PartitionIndex)
+ [PartitionIndexDescriptor 结构](#aws-glue-api-catalog-tables-PartitionIndexDescriptor)
+ [BackfillError 结构](#aws-glue-api-catalog-tables-BackfillError)
+ [IcebergInput 结构](#aws-glue-api-catalog-tables-IcebergInput)
+ [OpenTableFormatInput 结构](#aws-glue-api-catalog-tables-OpenTableFormatInput)
+ [ViewDefinition 结构](#aws-glue-api-catalog-tables-ViewDefinition)
+ [ViewDefinitionInput 结构](#aws-glue-api-catalog-tables-ViewDefinitionInput)
+ [ViewRepresentation 结构](#aws-glue-api-catalog-tables-ViewRepresentation)
+ [ViewRepresentationInput 结构](#aws-glue-api-catalog-tables-ViewRepresentationInput)
+ [UpdateOpenTableFormatInput 结构](#aws-glue-api-catalog-tables-UpdateOpenTableFormatInput)
+ [UpdateIcebergInput 结构](#aws-glue-api-catalog-tables-UpdateIcebergInput)
+ [CreateIcebergTableInput 结构](#aws-glue-api-catalog-tables-CreateIcebergTableInput)
+ [UpdateIcebergTableInput 结构](#aws-glue-api-catalog-tables-UpdateIcebergTableInput)
+ [IcebergSortOrder 结构](#aws-glue-api-catalog-tables-IcebergSortOrder)
+ [IcebergSortField 结构](#aws-glue-api-catalog-tables-IcebergSortField)
+ [IcebergPartitionSpec 结构](#aws-glue-api-catalog-tables-IcebergPartitionSpec)
+ [IcebergPartitionField 结构](#aws-glue-api-catalog-tables-IcebergPartitionField)
+ [IcebergSchema 结构](#aws-glue-api-catalog-tables-IcebergSchema)
+ [IcebergStructField 结构](#aws-glue-api-catalog-tables-IcebergStructField)
+ [IcebergTableUpdate 结构](#aws-glue-api-catalog-tables-IcebergTableUpdate)
+ [AuditContext 结构](#aws-glue-api-catalog-tables-AuditContext)

## Table 结构
<a name="aws-glue-api-catalog-tables-Table"></a>

表示用列和行组织的相关数据的集合。

**Fields**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表名称。对于 Hive 兼容性，它必须是完全小写的。
+ `DatabaseName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表元数据所在的数据库名称。对于 Hive 兼容性，它必须是全部小写的。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  对表的描述。
+ `Owner` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的所有者。
+ `CreateTime` – 时间戳。

  在数据目录中创建表定义的时间。
+ `UpdateTime` – 时间戳。

  上次更新该表的时间。
+ `LastAccessTime` – 时间戳。

  上次访问该表的时间。这通常取自 HDFS，可能不可靠。
+ `LastAnalyzedTime` – 时间戳。

  上次计算此表的列统计信息的时间。
+ `Retention` – 数字（整数），至多为“无”。

  此表的保留时间。
+ `StorageDescriptor` – 一个 [StorageDescriptor](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-StorageDescriptor) 对象。

  一个存储描述符，包含有关此表的物理存储的信息。
+ `PartitionKeys` – [列](#aws-glue-api-catalog-tables-Column) 对象的数组。

  表进行分区所依据的列的列表。仅支持基元类型作为分区键。

  创建 Amazon Athena 使用的表时，如果未指定任何 `partitionKeys`，则必须至少将 `partitionKeys` 的值设置为空列表。例如：

  `"PartitionKeys": []`
+ `ViewOriginalText` – UTF-8 字符串，不超过 409600 个字节。

  随附以实现 Apache Hive 兼容性。正常的 AWS Glue 操作过程中不使用。如果表为 `VIRTUAL_VIEW`，则特定 Athena 配置编码为 base64。
+ `ViewExpandedText` – UTF-8 字符串，不超过 409600 个字节。

  随附以实现 Apache Hive 兼容性。正常的 AWS Glue 操作过程中不使用。
+ `TableType` – UTF-8 字符串，不超过 255 个字节。

  该表的类型。AWS Glue 将创建 `EXTERNAL_TABLE` 类型的表。其他服务（例如 Athena）可能会创建其他表类型的表。

  AWS Glue 相关表类型：  
EXTERNAL\$1TABLE  
Hive 兼容属性 - 表示非 Hive 托管表。  
GOVERNED  
由 AWS Lake Formation 使用。AWS Glue Data Catalog 了解 `GOVERNED`。
+ `Parameters` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  这些键值对定义了与此表关联的属性。
+ `CreatedBy` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  创建表的人员或实体。
+ `IsRegisteredWithLakeFormation` – 布尔值。

  指示表是否已注册到 AWS Lake Formation。
+ `TargetTable` – 一个 [TableIdentifier](#aws-glue-api-catalog-tables-TableIdentifier) 对象。

  描述用于资源链接的目标表的 `TableIdentifier` 结构。
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据目录的 ID。
+ `VersionId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表版本 ID。
+ `FederatedTable` – 一个 [联合表](#aws-glue-api-catalog-tables-FederatedTable) 对象。

  一种引用 AWS Glue Data Catalog 外部实体的 `FederatedTable` 结构。
+ `ViewDefinition` – 一个 [ViewDefinition](#aws-glue-api-catalog-tables-ViewDefinition) 对象。

  包含定义视图的所有信息的结构，包括视图的一个或多个方言和查询。
+ `IsMultiDialectView` – 布尔值。

  指定视图是否支持一个或多个不同查询引擎的 SQL 方言，因此可以由这些引擎读取。

## TableInput 结构
<a name="aws-glue-api-catalog-tables-TableInput"></a>

用于定义表的结构。

**Fields**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表名称。为了确保 Hive 兼容性，它在存储时被转换为小写。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  对表的描述。
+ `Owner` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所有者。随附以实现 Apache Hive 兼容性。正常的 AWS Glue 操作过程中不使用。
+ `LastAccessTime` – 时间戳。

  上次访问该表的时间。
+ `LastAnalyzedTime` – 时间戳。

  上次计算此表的列统计信息的时间。
+ `Retention` – 数字（整数），至多为“无”。

  此表的保留时间。
+ `StorageDescriptor` – 一个 [StorageDescriptor](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-StorageDescriptor) 对象。

  一个存储描述符，包含有关此表的物理存储的信息。
+ `PartitionKeys` – [列](#aws-glue-api-catalog-tables-Column) 对象的数组。

  表进行分区所依据的列的列表。仅支持基元类型作为分区键。

  创建 Amazon Athena 使用的表时，如果未指定任何 `partitionKeys`，则必须至少将 `partitionKeys` 的值设置为空列表。例如：

  `"PartitionKeys": []`
+ `ViewOriginalText` – UTF-8 字符串，不超过 409600 个字节。

  随附以实现 Apache Hive 兼容性。正常的 AWS Glue 操作过程中不使用。如果表为 `VIRTUAL_VIEW`，则特定 Athena 配置编码为 base64。
+ `ViewExpandedText` – UTF-8 字符串，不超过 409600 个字节。

  随附以实现 Apache Hive 兼容性。正常的 AWS Glue 操作过程中不使用。
+ `TableType` – UTF-8 字符串，不超过 255 个字节。

  该表的类型。AWS Glue 将创建 `EXTERNAL_TABLE` 类型的表。其他服务（例如 Athena）可能会创建其他表类型的表。

  AWS Glue 相关表类型：  
EXTERNAL\$1TABLE  
Hive 兼容属性 - 表示非 Hive 托管表。  
GOVERNED  
由 AWS Lake Formation 使用。AWS Glue Data Catalog 了解 `GOVERNED`。
+ `Parameters` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  这些键值对定义了与此表关联的属性。
+ `TargetTable` – 一个 [TableIdentifier](#aws-glue-api-catalog-tables-TableIdentifier) 对象。

  描述用于资源链接的目标表的 `TableIdentifier` 结构。
+ `ViewDefinition` – 一个 [ViewDefinitionInput](#aws-glue-api-catalog-tables-ViewDefinitionInput) 对象。

  包含定义视图的所有信息的结构，包括视图的一个或多个方言和查询。

## 联合表结构
<a name="aws-glue-api-catalog-tables-FederatedTable"></a>

指向 AWS Glue Data Catalog 外部实体的表。

**Fields**
+ `Identifier` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  联合表的唯一标识符。
+ `DatabaseIdentifier` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  联合数据库的唯一标识符。
+ `ConnectionName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与外部元存储连接的名称。
+ `ConnectionType` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于访问联合表的连接类型，指定连接外部数据来源的协议或方法。

## 列结构
<a name="aws-glue-api-catalog-tables-Column"></a>

`Table` 中的列。

**Fields**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  `Column` 的名称。
+ `Type` – UTF-8 字符串，不超过 131072 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  `Column` 的数据类型。
+ `Comment` – 注释字符串，不超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  自由格式的文本注释。
+ `Parameters` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  这些键/值对定义了与此列关联的属性。

## StorageDescriptor 结构
<a name="aws-glue-api-catalog-tables-StorageDescriptor"></a>

描述表数据的物理存储。

**Fields**
+ `Columns` – [列](#aws-glue-api-catalog-tables-Column) 对象的数组。

  表中的 `Columns` 的列表。
+ `Location` – 位置字符串，不超过 2056 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  表的物理位置。默认情况下，它采用仓库位置的形式，后跟仓库中的数据库位置，然后是表名称。
+ `AdditionalLocations` – UTF-8 字符串数组。

  指向 Delta 表所在路径的位置列表。
+ `InputFormat` – 格式字符串，不超过 128 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  输入格式：`SequenceFileInputFormat`（二进制）或 `TextInputFormat` 或自定义格式。
+ `OutputFormat` – 格式字符串，不超过 128 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  输出格式：`SequenceFileOutputFormat`（二进制）、`IgnoreKeyTextOutputFormat` 或自定义格式。
+ `Compressed` – 布尔值。

  如果对表中的数据进行压缩，则为 `True`，否则为 `False`。
+ `NumberOfBuckets` – 数字（整数）。

  如果表包含任何维度列，则必须指定。
+ `SerdeInfo` – 一个 [SerDeInfo](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SerDeInfo) 对象。

  序列化/反序列化（SerDe）信息。
+ `BucketColumns` – UTF-8 字符串数组。

  表中的 Reducer 分组列、集群列以及桶列的列表。
+ `SortColumns` – [顺序](#aws-glue-api-catalog-tables-Order) 对象的数组。

  指定表中的每个桶的排序顺序的列表。
+ `Parameters` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  使用键/值形式的用户提供的属性。
+ `SkewedInfo` – 一个 [SkewedInfo](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SkewedInfo) 对象。

  有关在列中经常出现的值（偏斜值）的信息。
+ `StoredAsSubDirectories` – 布尔值。

  如果表数据存储在子目录中，则为 `True`，否则为 `False`。
+ `SchemaReference` – 一个 [SchemaReference](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SchemaReference) 对象。

  引用存储在 AWS Glue 架构注册表中的架构的对象。

  创建表时，可以为架构传递列的空列表，而使用架构引用。

## SchemaReference 结构
<a name="aws-glue-api-catalog-tables-SchemaReference"></a>

引用存储在 AWS Glue 架构注册表中的架构的对象。

**Fields**
+ `SchemaId` – 一个 [SchemaId](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaId) 对象。

  包含架构标识字段的结构。必须提供此值或 `SchemaVersionId`。
+ `SchemaVersionId` – UTF-8 字符串，长度不少于 36 个字节或超过 36 个字节，与 [Custom string pattern #45](aws-glue-api-common.md#regex_45) 匹配。

  分配给架构版本的唯一 ID。必须提供此值或 `SchemaId`。
+ `SchemaVersionNumber` – 数字（长度），不小于 1 或大于 100000。

  架构的版本号。

## SerDeInfo 结构
<a name="aws-glue-api-catalog-tables-SerDeInfo"></a>

有关序列化/反序列化程序（SerDe）的信息，它用作抽取器和加载器。

**Fields**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  SerDe 的名称。
+ `SerializationLibrary` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  通常是实现 SerDe 的类。例如，`org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe`。
+ `Parameters` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  这些键值对用于定义 SerDe 的初始化参数。

## Order 结构
<a name="aws-glue-api-catalog-tables-Order"></a>

指定排序列的排序顺序。

**Fields**
+ `Column` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  列的名称。
+ `SortOrder` – *必填：*数字（整数），不大于 1。

  指示是按升序（`== 1`）还是降序（`==0`）对列进行排序。

## SkewedInfo 结构
<a name="aws-glue-api-catalog-tables-SkewedInfo"></a>

指定表中的偏斜值。偏斜值是指出现频率很高的值。

**Fields**
+ `SkewedColumnNames` – UTF-8 字符串数组。

  包含偏斜值的列名称的列表。
+ `SkewedColumnValues` – UTF-8 字符串数组。

  经常被认为是偏斜的值的列表。
+ `SkewedColumnValueLocationMaps` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  偏斜值到包含它们的列的映射。

## TableVersion 结构
<a name="aws-glue-api-catalog-tables-TableVersion"></a>

指定表的版本。

**Fields**
+ `Table` – 一个 [表](#aws-glue-api-catalog-tables-Table) 对象。

  所涉表。
+ `VersionId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  标识此表版本的 ID 值。`VersionId` 是整数的字符串表示。每个版本都会增加 1。

## TableError 结构
<a name="aws-glue-api-catalog-tables-TableError"></a>

表操作的错误记录。

**Fields**
+ `TableName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的名称。对于 Hive 兼容性，它必须是完全小写的。
+ `ErrorDetail` – 一个 [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail) 对象。

  有关错误的详细信息。

## TableVersionError 结构
<a name="aws-glue-api-catalog-tables-TableVersionError"></a>

表版本操作的错误记录。

**Fields**
+ `TableName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  相关表的名称。
+ `VersionId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  所涉版本的 ID 值。`VersionID` 是整数的字符串表示。每个版本都会增加 1。
+ `ErrorDetail` – 一个 [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail) 对象。

  有关错误的详细信息。

## SortCriterion 结构
<a name="aws-glue-api-catalog-tables-SortCriterion"></a>

指定要作为排序依据的字段和排序顺序。

**Fields**
+ `FieldName`：值字符串，长度不少于 1 个字节，不超过 1024 个字节。

  要作为排序依据的字段的名称。
+ `Sort` – UTF-8 字符串（有效值：`ASC="ASCENDING"` \$1`DESC="DESCENDING"` ）。

  升序或降序排序。

## TableIdentifier 结构
<a name="aws-glue-api-catalog-tables-TableIdentifier"></a>

描述用于资源链接的目标表的结构。

**Fields**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据目录的 ID。
+ `DatabaseName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  包含目标表的目录数据库的名称。
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  目标表的名称。
+ `Region` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  目标表的区域。

## KeySchemaElement 结构
<a name="aws-glue-api-catalog-tables-KeySchemaElement"></a>

由名称和类型组成的分区密钥对。

**Fields**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区键的名称。
+ `Type` – *必填*：UTF-8 字符串，长度不超过 131072 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区键的类型。

## PartitionIndex 结构
<a name="aws-glue-api-catalog-tables-PartitionIndex"></a>

分区索引的结构。

**Fields**
+ `Keys` – *必填：*UTF-8 字符串数组，至少 1 个字符串。

  分区索引的键。
+ `IndexName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区索引的名称。

## PartitionIndexDescriptor 结构
<a name="aws-glue-api-catalog-tables-PartitionIndexDescriptor"></a>

表中分区索引的描述符。

**Fields**
+ `IndexName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区索引的名称。
+ `Keys` – *必填*：[KeySchemaElement](#aws-glue-api-catalog-tables-KeySchemaElement)对象的数组，至少有 1 个结构。

  一个或多个键的列表，例如 `KeySchemaElement` 结构，用于分区索引。
+ `IndexStatus` – *必填*：UTF-8 字符串（有效值：`CREATING` \$1 `ACTIVE` \$1 `DELETING` \$1 `FAILED`）。

  分区索引的状态。

  可能状态包括：
  + CREATING：正在创建索引。当索引处于 CREATING 状态时，无法删除索引或其表。
  + ACTIVE：索引创建成功。
  + FAILED：索引创建失败。
  + DELETING：索引将从索引列表中删除。
+ `BackfillErrors` – [BackfillError](#aws-glue-api-catalog-tables-BackfillError) 对象的数组。

  为现有表注册分区索引时可能发生的错误列表。

## BackfillError 结构
<a name="aws-glue-api-catalog-tables-BackfillError"></a>

为现有表注册分区索引时可能发生的错误列表。

这些错误提供了有关索引注册失败的原因的详细信息，并在响应中提供了有限数量的分区，以便您可以在故障时修复分区并尝试重新注册索引。可能发生的最常见错误集分类如下：
+ EncryptedPartitionError：分区已加密。
+ InvalidPartitionTypeDataError：分区值与该分区列的数据类型不匹配。
+ MissingPartitionValueError：分区已加密。
+ UnsupportedPartitionCharacterError：不支持分区值内的字符。例如：U\$10000、U\$10001 和 U\$10002。
+ InternalError：任何不属于其他错误代码的错误。

**Fields**
+ `Code` – UTF-8 字符串（有效值：`ENCRYPTED_PARTITION_ERROR` \$1`INTERNAL_ERROR` \$1`INVALID_PARTITION_TYPE_DATA_ERROR` \$1`MISSING_PARTITION_VALUE_ERROR` \$1`UNSUPPORTED_PARTITION_CHARACTER_ERROR` ）。

  为现有表注册分区索引时发生的错误代码。
+ `Partitions` – [PartitionValueList](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-PartitionValueList) 对象的数组。

  响应中有限数量的分区列表。

## IcebergInput 结构
<a name="aws-glue-api-catalog-tables-IcebergInput"></a>

一种结构，用于定义要在目录中创建的 Apache Iceberg 元数据表。

**Fields**
+ `MetadataOperation` – *必填*：UTF-8 字符串（有效值：`CREATE`）。

  必需的元数据操作。只能设置为 `CREATE`。
+ `Version` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  Iceberg 表的表格版本。默认值为 2。
+ `CreateIcebergTableInput` – 一个 [CreateIcebergTableInput](#aws-glue-api-catalog-tables-CreateIcebergTableInput) 对象。

  在 AWS Glue Data Catalog 中创建新 Iceberg 表所需的配置参数，包括表属性和元数据规范。

## OpenTableFormatInput 结构
<a name="aws-glue-api-catalog-tables-OpenTableFormatInput"></a>

一种表示开放格式表的结构。

**Fields**
+ `IcebergInput` – 一个 [IcebergInput](#aws-glue-api-catalog-tables-IcebergInput) 对象。

  指定用于定义 Apache Iceberg 元数据表的 `IcebergInput` 结构。

## ViewDefinition 结构
<a name="aws-glue-api-catalog-tables-ViewDefinition"></a>

包含表示形式详细信息的结构。

**Fields**
+ `IsProtected` – 布尔值。

  您可以将此标志设置为 true，以指示引擎在查询规划期间不要将用户提供的操作推送到视图的逻辑计划中。但是，设置此标志并不能保证引擎将遵循此要求。请参阅引擎的文档以了解所提供的保证（如果有）。
+ `Definer` – UTF-8 字符串，不少于 20 个字节，不超过 2048 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  SQL 中视图的定义者。
+ `SubObjects` – UTF-8 字符串数组，不超过 10 个字符串。

  包含表 Amazon 资源名称（ARN）的列表。
+ `Representations` – [ViewRepresentation](#aws-glue-api-catalog-tables-ViewRepresentation)对象的数组，不少于 1 个或不超过 1000 个结构。

  包含表示形式的列表。

## ViewDefinitionInput 结构
<a name="aws-glue-api-catalog-tables-ViewDefinitionInput"></a>

包含用于创建或更新 AWS Glue 视图的详细信息的结构。

**Fields**
+ `IsProtected` – 布尔值。

  您可以将此标志设置为 true，以指示引擎在查询规划期间不要将用户提供的操作推送到视图的逻辑计划中。但是，设置此标志并不能保证引擎将遵循此要求。请参阅引擎的文档以了解所提供的保证（如果有）。
+ `Definer` – UTF-8 字符串，不少于 20 个字节，不超过 2048 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  SQL 中视图的定义者。
+ `Representations` – [ViewRepresentationInput](#aws-glue-api-catalog-tables-ViewRepresentationInput) 对象的数组，长度不少于 1 个结构，不超过 10 个结构。

  包含视图方言和定义视图的查询的结构列表。
+ `SubObjects` – UTF-8 字符串数组，不超过 10 个字符串。

  包含构成视图的基表 ARN 列表。

## ViewRepresentation 结构
<a name="aws-glue-api-catalog-tables-ViewRepresentation"></a>

包含视图方言和定义视图的查询的结构。

**Fields**
+ `Dialect` – UTF-8 字符串（有效值：`REDSHIFT` \$1`ATHENA` \$1`SPARK` ）。

  查询引擎的方言。
+ `DialectVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节。

  查询引擎的方言版本。例如 3.0.0。
+ `ViewOriginalText` – UTF-8 字符串，不超过 409600 个字节。

  客户在 `CREATE VIEW DDL` 期间提供的 `SELECT` 查询。在对视图进行查询时不使用此 SQL（现改为使用 `ViewExpandedText`）。`ViewOriginalText` 用于 `SHOW CREATE VIEW` 等情况（当用户想要查看创建视图的原始 DDL 命令时）。
+ `ViewExpandedText` – UTF-8 字符串，不超过 409600 个字节。

  视图的扩展 SQL。引擎在处理视图查询时使用此 SQL。在视图创建过程中，引擎可能会执行操作，将 `ViewOriginalText` 转换为 `ViewExpandedText`。例如：
  + 完全限定的标识符：`SELECT * from table1 -> SELECT * from db1.table1`
+ `ValidationConnection` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于验证视图的特定表示形式的连接的名称。
+ `IsStale` – 布尔值。

  标记为过时的方言不再有效，必须先进行更新，然后才能在其各自的查询引擎中进行查询。

## ViewRepresentationInput 结构
<a name="aws-glue-api-catalog-tables-ViewRepresentationInput"></a>

包含表示形式详细信息的结构，用于更新或创建 Lake Formation 视图。

**Fields**
+ `Dialect` – UTF-8 字符串（有效值：`REDSHIFT` \$1`ATHENA` \$1`SPARK` ）。

  用于指定特定表示形式的引擎类型的参数。
+ `DialectVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节。

  用于指定特定表示形式的引擎版本的参数。
+ `ViewOriginalText` – UTF-8 字符串，不超过 409600 个字节。

  用于表示描述视图的原始 SQL 查询的字符串。
+ `ValidationConnection` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于验证视图的特定表示形式的连接的名称。
+ `ViewExpandedText` – UTF-8 字符串，不超过 409600 个字节。

  表示 SQL 查询的字符串，该查询描述了带有扩展资源 ARN 的视图

## UpdateOpenTableFormatInput 结构
<a name="aws-glue-api-catalog-tables-UpdateOpenTableFormatInput"></a>

用于更新 AWS Glue Data Catalog 中开放表格式表的输入参数，作为 Apache Iceberg 等格式特定更新操作的封装器。

**Fields**
+ `UpdateIcebergInput` – 一个 [UpdateIcebergInput](#aws-glue-api-catalog-tables-UpdateIcebergInput) 对象。

  Apache Iceberg 特定更新参数，用于定义要应用的表修改，包括架构更改、分区规范和表属性。

## UpdateIcebergInput 结构
<a name="aws-glue-api-catalog-tables-UpdateIcebergInput"></a>

更新 AWS Glue Data Catalog 中 Apache Iceberg 表的特定输入参数，其中包含要应用于现有 Iceberg 表的更新操作。

**Fields**
+ `UpdateIcebergTableInput` – *必填：*一个 [UpdateIcebergTableInput](#aws-glue-api-catalog-tables-UpdateIcebergTableInput) 对象。

  要应用于 Iceberg 表的具体更新操作，其中包含定义表新状态的更新列表，包括架构、分区和属性。

## CreateIcebergTableInput 结构
<a name="aws-glue-api-catalog-tables-CreateIcebergTableInput"></a>

在 AWS Glue Data Catalog 中创建新 Iceberg 表所需的配置参数，包括表属性和元数据规范。

**Fields**
+ `Location`：*（必填）*位置字符串，长度不超过 2056 个字节，应符合 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 模式。

  将用于存储 Iceberg 表数据的 S3 位置。
+ `Schema` – *必填：*一个 [IcebergSchema](#aws-glue-api-catalog-tables-IcebergSchema) 对象。

  架构定义，用于指定 Iceberg 表结构、字段类型和元数据。
+ `PartitionSpec` – 一个 [IcebergPartitionSpec](#aws-glue-api-catalog-tables-IcebergPartitionSpec) 对象。

  分区规范，用于定义如何对 Iceberg 表数据进行组织和分区以实现最佳查询性能。
+ `WriteOrder` – 一个 [IcebergSortOrder](#aws-glue-api-catalog-tables-IcebergSortOrder) 对象。

  排序顺序规范，用于定义如何对每个分区内的数据进行排序以优化查询性能。
+ `Properties` – 

  用于定义 Iceberg 表的其他表属性和配置设置的键值对。

## UpdateIcebergTableInput 结构
<a name="aws-glue-api-catalog-tables-UpdateIcebergTableInput"></a>

包含要应用于 AWS Glue Data Catalog 中现有 Iceberg 表的更新操作，用于定义表元数据的新状态。

**Fields**
+ `Updates` – *必填：*[IcebergTableUpdate](#aws-glue-api-catalog-tables-IcebergTableUpdate) 对象的数组。

  表更新操作列表，用于指定要对 Iceberg 表执行的更改，包括架构修改、分区规范和表属性。

## IcebergSortOrder 结构
<a name="aws-glue-api-catalog-tables-IcebergSortOrder"></a>

定义 Iceberg 表的排序顺序规范，用于确定如何对分区内的数据进行排序以优化查询性能。

**Fields**
+ `OrderId` – *必填*：数字（整数）。

  该排序顺序规范在 Iceberg 表元数据中的唯一标识符。
+ `Fields` – *必填：*[IcebergSortField](#aws-glue-api-catalog-tables-IcebergSortField) 对象的数组。

  字段列表及其排序方向，用于定义 Iceberg 表数据的排序标准。

## IcebergSortField 结构
<a name="aws-glue-api-catalog-tables-IcebergSortField"></a>

定义 Iceberg 排序顺序规范中的单个字段，包括源字段、转换、排序方向和空值排序规则。

**Fields**
+ `SourceId` – *必填*：数字（整数）。

  源字段在该排序字段所基于的表架构中的标识符。
+ `Transform` – *必填：*UTF-8 字符串。

  排序前应用于源字段的转换函数，例如身份、存储桶或截断。
+ `Direction` – *必填：*UTF-8 字符串（有效值：`asc="ASC"` \$1 `desc="DESC"`）。

  该字段的排序方向，或为升序，或为降序。
+ `NullOrder` – *必填：*UTF-8 字符串（有效值：`nulls-first="NULLS_FIRST"` \$1 `nulls-last="NULLS_LAST"`）。

  该字段中空值的排序行为，用于指定空值在排序时应排在第一位还是最后一位。

## IcebergPartitionSpec 结构
<a name="aws-glue-api-catalog-tables-IcebergPartitionSpec"></a>

定义 Iceberg 表的分区规范，确定如何对表数据进行组织和分区以获得最佳查询性能。

**Fields**
+ `Fields` – *必填：*[IcebergPartitionField](#aws-glue-api-catalog-tables-IcebergPartitionField) 对象的数组。

  分区字段列表，用于定义应如何对表数据进行分区，包括源字段及其转换。
+ `SpecId` – 数字（整数）。

  该分区规范在 Iceberg 表元数据历史记录中的唯一标识符。

## IcebergPartitionField 结构
<a name="aws-glue-api-catalog-tables-IcebergPartitionField"></a>

定义 Iceberg 分区规范中的单个分区依据字段，包括源字段、转换函数、分区名称和唯一标识符。

**Fields**
+ `SourceId` – *必填*：数字（整数）。

  源字段在该分区依据字段所基于的表架构中的标识符。
+ `Transform` – *必填：*UTF-8 字符串。

  为了创建分区而应用于源字段的转换函数，例如身份、存储桶、截断、年、月、日或小时。
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 1024 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区依据字段在分区表结构中显示的名称。
+ `FieldId` – 数字（整数）。

  在 Iceberg 表的分区规范中分配给该分区依据字段的唯一标识符。

## IcebergSchema 结构
<a name="aws-glue-api-catalog-tables-IcebergSchema"></a>

定义 Iceberg 表的架构结构，包括字段定义、数据类型和架构元数据。

**Fields**
+ `SchemaId` – 数字（整数）。

  该架构版本在 Iceberg 表的架构演变历史记录中的唯一标识符。
+ `IdentifierFieldIds`：一个由带符号的 32 位整数组成的数组。

  用于唯一标识表中记录的字段标识符列表，用于行级操作和重复数据删除。
+ `Type` – UTF-8 字符串（有效值：`struct="STRUCT"`）。

  架构结构的根类型，通常是 Iceberg 表架构的“结构体”。
+ `Fields` – *必填：*[IcebergStructField](#aws-glue-api-catalog-tables-IcebergStructField) 对象的数组。

  构成表架构的字段定义列表，包括字段名称、类型和元数据。

## IcebergStructField 结构
<a name="aws-glue-api-catalog-tables-IcebergStructField"></a>

定义 Iceberg 表架构中的单个字段，包括其标识符、名称、数据类型、可空性和文档。

**Fields**
+ `Id` – *必填*：数字（整数）。

  在 Iceberg 表架构中分配给该字段的唯一标识符，用于记录架构演变历史和字段跟踪。
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 1024 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  在表架构和查询操作中显示的字段名称。
+ `Type`：*（必填）*名为 `IcebergDocument` 的空结构。

  该字段的数据类型定义，用于指定其所含数据的结构和格式。
+ `Required` – *必填：*布尔值。

  指示该字段在表架构中是必填字段（不可为空）还是可选字段（可为空）。
+ `Doc` – 注释字符串，不超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  可选的文档或描述文本，用于提供有关该字段用途和用法的更多背景信息。

## IcebergTableUpdate 结构
<a name="aws-glue-api-catalog-tables-IcebergTableUpdate"></a>

定义要应用于 Iceberg 表的完整更新，包括架构更改、分区修改、排序顺序调整、位置更新和属性更改。

**Fields**
+ `Schema` – *必填：*一个 [IcebergSchema](#aws-glue-api-catalog-tables-IcebergSchema) 对象。

  更新后的 Iceberg 表架构定义，用于指定对字段结构、数据类型或架构元数据的任何更改。
+ `PartitionSpec` – 一个 [IcebergPartitionSpec](#aws-glue-api-catalog-tables-IcebergPartitionSpec) 对象。

  更新后的分区规范，用于定义如何对表数据进行重新组织和分区。
+ `SortOrder` – 一个 [IcebergSortOrder](#aws-glue-api-catalog-tables-IcebergSortOrder) 对象。

  更新后的排序顺序规范，用于定义如何在分区内对数据进行排序以实现最佳查询性能。
+ `Location`：*（必填）*位置字符串，长度不超过 2056 个字节，应符合 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 模式。

  将用于存储 Iceberg 表数据的更新后的 S3 位置。
+ `Properties` – 

  Iceberg 表更新后的表属性和配置设置键值对。

## AuditContext 结构
<a name="aws-glue-api-catalog-tables-AuditContext"></a>

包含 Lake Formation 审计上下文的结构。

**Fields**
+ `AdditionalAuditContext` – UTF-8 字符串，长度不超过 2048 个字节。

  包含其他审计上下文信息的字符串。
+ `RequestedColumns` – UTF-8 字符串数组。

  请求的审计列。
+ `AllColumnsRequested` – 布尔值。

  所有列都请求审计。

## 操作
<a name="aws-glue-api-catalog-tables-actions"></a>
+ [CreateTable 操作（Python：create\$1table）](#aws-glue-api-catalog-tables-CreateTable)
+ [UpdateTable 操作（Python：update\$1table）](#aws-glue-api-catalog-tables-UpdateTable)
+ [DeleteTable 操作（Python：delete\$1table）](#aws-glue-api-catalog-tables-DeleteTable)
+ [BatchDeleteTable 操作（Python：batch\$1delete\$1table）](#aws-glue-api-catalog-tables-BatchDeleteTable)
+ [GetTable 操作（Python：get\$1table）](#aws-glue-api-catalog-tables-GetTable)
+ [GetTables 操作（Python：get\$1tables）](#aws-glue-api-catalog-tables-GetTables)
+ [GetTableVersion 操作（Python：get\$1table\$1version）](#aws-glue-api-catalog-tables-GetTableVersion)
+ [GetTableVersions 操作（Python：get\$1table\$1versions）](#aws-glue-api-catalog-tables-GetTableVersions)
+ [DeleteTableVersion 操作（Python：delete\$1table\$1version）](#aws-glue-api-catalog-tables-DeleteTableVersion)
+ [BatchDeleteTableVersion 操作（Python：batch\$1delete\$1table\$1version）](#aws-glue-api-catalog-tables-BatchDeleteTableVersion)
+ [SearchTables 操作（Python：search\$1tables）](#aws-glue-api-catalog-tables-SearchTables)
+ [GetPartitionIndexes 操作（Python：get\$1partition\$1indexes）](#aws-glue-api-catalog-tables-GetPartitionIndexes)
+ [CreatePartitionIndex 操作（Python：create\$1partition\$1index）](#aws-glue-api-catalog-tables-CreatePartitionIndex)
+ [DeletePartitionIndex 操作（Python：delete\$1partition\$1index）](#aws-glue-api-catalog-tables-DeletePartitionIndex)
+ [GetColumnStatisticsForTable 操作（Python：get\$1column\$1statistics\$1for\$1table）](#aws-glue-api-catalog-tables-GetColumnStatisticsForTable)
+ [UpdateColumnStatisticsForTable 操作（Python：update\$1column\$1statistics\$1for\$1table）](#aws-glue-api-catalog-tables-UpdateColumnStatisticsForTable)
+ [DeleteColumnStatisticsForTable 操作（Python：delete\$1column\$1statistics\$1for\$1table）](#aws-glue-api-catalog-tables-DeleteColumnStatisticsForTable)

## CreateTable 操作（Python：create\$1table）
<a name="aws-glue-api-catalog-tables-CreateTable"></a>

在数据目录中创建新表定义。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中创建 `Table` 的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中创建新表的目录数据库。对于 Hive 兼容性，此名称必须是完全小写的。
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  该表在将于 AWS Glue Data Catalog 中创建的指定数据库中的唯一标识符。
+ `TableInput` – 一个 [TableInput](#aws-glue-api-catalog-tables-TableInput) 对象。

  用于定义要在目录中创建的元数据表的 `TableInput` 对象。
+ `PartitionIndexes` – [PartitionIndex](#aws-glue-api-catalog-tables-PartitionIndex) 对象的数组，不超过 3 个结构。

  用于表中创建的分区索引和 `PartitionIndex` 结构的列表。
+ `TransactionId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #44](aws-glue-api-common.md#regex_44) 匹配。

  事务的 ID。
+ `OpenTableFormatInput` – 一个 [OpenTableFormatInput](#aws-glue-api-catalog-tables-OpenTableFormatInput) 对象。

  在创建开放格式表时指定 `OpenTableFormatInput` 结构。

**响应**
+ *无响应参数。*

**错误**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`

## UpdateTable 操作（Python：update\$1table）
<a name="aws-glue-api-catalog-tables-UpdateTable"></a>

更新数据目录中的元数据表。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的目录数据库的名称。对于 Hive 兼容性，此名称必须是完全小写的。
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  该表在将于 AWS Glue Data Catalog 中创建的指定数据库中的唯一标识符。
+ `TableInput` – 一个 [TableInput](#aws-glue-api-catalog-tables-TableInput) 对象。

  用于定义目录中的元数据表的 `TableInput` 对象。
+ `SkipArchive` – 布尔值。

  默认情况下，`UpdateTable` 始终在更新表之前创建一个存档版本。但是，如果 `skipArchive` 设置为 true，`UpdateTable` 不创建存档的版本。
+ `TransactionId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #44](aws-glue-api-common.md#regex_44) 匹配。

  在该 ID 处更新表内容的事务 ID。
+ `VersionId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于更新表内容的版本 ID。
+ `ViewUpdateAction` – UTF-8 字符串（有效值：`ADD` \$1`REPLACE` \$1`ADD_OR_REPLACE` \$1`DROP` ）。

  更新视图时要执行的操作。
+ `Force` – 布尔值。

  一个标志，可以设置为 true 以忽略匹配的存储描述符和子对象匹配要求。
+ `UpdateOpenTableFormatInput` – 一个 [UpdateOpenTableFormatInput](#aws-glue-api-catalog-tables-UpdateOpenTableFormatInput) 对象。

  用于更新 AWS Glue Data Catalog 中开放表格式表的输入参数，作为 Apache Iceberg 等格式特定更新操作的封装器。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
+ `AlreadyExistsException`

## DeleteTable 操作（Python：delete\$1table）
<a name="aws-glue-api-catalog-tables-DeleteTable"></a>

从数据目录中创建表定义。

**注意**  
完成此操作后，您将无法再访问属于已删除的表的表版本和分区。AWS Glue 会及时以异步方式删除这些“孤立”资源，这由服务决定。  
为了确保立即删除所有相关资源，在调用 `DeleteTable` 之前，请使用 `DeleteTableVersion` 或 `BatchDeleteTableVersion` 以及 `DeletePartition` 或 `BatchDeletePartition`，删除属于该表的所有资源。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的目录数据库的名称。对于 Hive 兼容性，此名称必须是完全小写的。
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的表的名称。对于 Hive 兼容性，此名称必须是完全小写的。
+ `TransactionId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #44](aws-glue-api-common.md#regex_44) 匹配。

  在该 ID 处删除表内容的事务 ID。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`

## BatchDeleteTable 操作（Python：batch\$1delete\$1table）
<a name="aws-glue-api-catalog-tables-BatchDeleteTable"></a>

一次性删除多个表。

**注意**  
完成此操作后，您将无法再访问属于已删除的表的表版本和分区。AWS Glue 会及时以异步方式删除这些“孤立”资源，这由服务决定。  
为了确保立即删除所有相关资源，在调用 `BatchDeleteTable` 之前，请使用 `DeleteTableVersion` 或 `BatchDeleteTableVersion` 以及 `DeletePartition` 或 `BatchDeletePartition`，删除属于该表的所有资源。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的表所在的目录数据库的名称。对于 Hive 兼容性，此名称必须是完全小写的。
+ `TablesToDelete` – *必填：*UTF-8 字符串数组，不超过 100 个字符串。

  要删除的表的列表。
+ `TransactionId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #44](aws-glue-api-common.md#regex_44) 匹配。

  在该 ID 处删除表内容的事务 ID。

**响应**
+ `Errors` – [TableError](#aws-glue-api-catalog-tables-TableError) 对象的数组。

  尝试删除指定表时遇到的错误的列表。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ResourceNotReadyException`

## GetTable 操作（Python：get\$1table）
<a name="aws-glue-api-catalog-tables-GetTable"></a>

在指定表的数据目录中检索 `Table` 定义。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的目录中的数据库的名称。对于 Hive 兼容性，此名称必须是完全小写的。
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索其定义的表的名称。对于 Hive 兼容性，此名称必须是完全小写的。
+ `TransactionId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #44](aws-glue-api-common.md#regex_44) 匹配。

  在该 ID 处读取表内容的事务 ID。
+ `QueryAsOfTime` – 时间戳。

  截至读取表内容的时间。如果未设置，将使用最近的事务提交时间。无法与 `TransactionId` 一起指定。
+ `AuditContext` – 一个 [AuditContext](#aws-glue-api-catalog-tables-AuditContext) 对象。

  包含 Lake Formation [审计上下文](https://docs.aws.amazon.com/glue/latest/webapi/API_AuditContext.html)的结构。
+ `IncludeStatusDetails` – 布尔值。

  指定是否包含与 AWS Glue Data Catalog 视图创建或更新请求相关的状态详细信息。

**响应**
+ `Table` – 一个 [表](#aws-glue-api-catalog-tables-Table) 对象。

  用于定义指定表的 `Table` 对象。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`

## GetTables 操作（Python：get\$1tables）
<a name="aws-glue-api-catalog-tables-GetTables"></a>

在给定的 `Database` 中检索部分或所有表的定义。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  目录中要列出其表的数据库。对于 Hive 兼容性，此名称必须是完全小写的。
+ `Expression` – UTF-8 字符串，长度不超过 2048 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  正则表达式模式。如果存在，则只返回其名称与模式匹配的表。
+ `NextToken` – UTF-8 字符串。

  延续标记 (如果这是延续调用，则包括)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 100。

  要在单个响应中返回的表的最大数量。
+ `TransactionId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #44](aws-glue-api-common.md#regex_44) 匹配。

  在该 ID 处读取表内容的事务 ID。
+ `QueryAsOfTime` – 时间戳。

  截至读取表内容的时间。如果未设置，将使用最近的事务提交时间。无法与 `TransactionId` 一起指定。
+ `AuditContext` – 一个 [AuditContext](#aws-glue-api-catalog-tables-AuditContext) 对象。

  包含 Lake Formation [审计上下文](https://docs.aws.amazon.com/glue/latest/webapi/API_AuditContext.html)的结构。
+ `IncludeStatusDetails` – 布尔值。

  指定是否包含与 AWS Glue Data Catalog 视图创建或更新请求相关的状态详细信息。
+ `AttributesToGet` – UTF-8 字符串数组。

   指定 `GetTables` 调用返回的表字段。此参数不接受空列表。请求中必须包含 `NAME`。

  有效的值组合如下：
  + `NAME` – 数据库中所有表的名称。
  + `NAME`、`TABLE_TYPE` – 所有表的名称和表类型。

**响应**
+ `TableList` – [表](#aws-glue-api-catalog-tables-Table) 对象的数组。

  请求的 `Table` 对象的列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果当前列表片段不是最后一个，则呈现)。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`

## GetTableVersion 操作（Python：get\$1table\$1version）
<a name="aws-glue-api-catalog-tables-GetTableVersion"></a>

检索表的指定版本。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的目录中的数据库。对于 Hive 兼容性，此名称必须是完全小写的。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的名称。对于 Hive 兼容性，此名称必须是完全小写的。
+ `VersionId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索的表版本的 ID 值。`VersionID` 是整数的字符串表示。每个版本都会增加 1。

**响应**
+ `TableVersion` – 一个 [TableVersion](#aws-glue-api-catalog-tables-TableVersion) 对象。

  请求的表版本。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`

## GetTableVersions 操作（Python：get\$1table\$1versions）
<a name="aws-glue-api-catalog-tables-GetTableVersions"></a>

检索标识指定表的可用版本的字符串的列表。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的目录中的数据库。对于 Hive 兼容性，此名称必须是完全小写的。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的名称。对于 Hive 兼容性，此名称必须是完全小写的。
+ `NextToken` – UTF-8 字符串。

  延续标记 (如果这不是第一次调用)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 100。

  要在一个响应中返回的表版本的最大数量。

**响应**
+ `TableVersions` – [TableVersion](#aws-glue-api-catalog-tables-TableVersion) 对象的数组。

  标识指定表的可用版本的字符串的列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果可用版本的列表不包括最后一个)。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`

## DeleteTableVersion 操作（Python：delete\$1table\$1version）
<a name="aws-glue-api-catalog-tables-DeleteTableVersion"></a>

删除表的指定版本。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的目录中的数据库。对于 Hive 兼容性，此名称必须是完全小写的。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的名称。对于 Hive 兼容性，此名称必须是完全小写的。
+ `VersionId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的表版本的 ID。`VersionID` 是整数的字符串表示。每个版本都会增加 1。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## BatchDeleteTableVersion 操作（Python：batch\$1delete\$1table\$1version）
<a name="aws-glue-api-catalog-tables-BatchDeleteTableVersion"></a>

删除表的版本的指定批次。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的目录中的数据库。对于 Hive 兼容性，此名称必须是完全小写的。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的名称。对于 Hive 兼容性，此名称必须是完全小写的。
+ `VersionIds` – *必填：*UTF-8 字符串数组，不超过 100 个字符串。

  要删除版本的 ID 的列表。`VersionId` 是整数的字符串表示。每个版本都会增加 1。

**响应**
+ `Errors` – [TableVersionError](#aws-glue-api-catalog-tables-TableVersionError) 对象的数组。

  尝试删除指定表版本时遇到的错误的列表。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## SearchTables 操作（Python：search\$1tables）
<a name="aws-glue-api-catalog-tables-SearchTables"></a>

根据表元数据以及父数据库中的属性搜索一组表。您可以根据文本或筛选条件进行搜索。

您只能基于 Lake Formation 中定义的安全策略来获取有权访问的表。您至少需要具有该表的只读访问权才能返回该表。如果您无权访问表中的所有列，则在将表列表返回给您时，不会根据这些列进行搜索。如果您有权访问这些列，但不能访问这些列中的数据，则这些列及其关联元数据将包含在搜索中。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  唯一标识符，包含 `account_id`。
+ `NextToken` – UTF-8 字符串。

  延续标记 (如果这是延续调用，则包括)。
+ `Filters` – [PropertyPredicate](aws-glue-api-common.md#aws-glue-api-common-PropertyPredicate) 对象的数组。

  键值对列表以及用于筛选搜索结果的比较器。返回与谓词匹配的所有实体。

  `PropertyPredicate` 结构的 `Comparator` 成员仅用于时间字段，并且可以省略其他字段类型。此外，当比较字符串值时，例如 `Key=Name`，则使用模糊匹配算法。`Key` 字段（例如，`Name` 字段值）将拆分为某些标点符号字符，例如 -、:、\$1 等来成为令牌。然后，每个令牌都与 `PropertyPredicate` 成员的 `Value` 完全匹配。例如，如果是 `Key=Name` 和 `Value=link`，表名为 `customer-link` 并且返回 `xx-link-yy`，但不返回 `xxlinkyy`。
+ `SearchText`：值字符串，长度不少于 1 个字节，不超过 1024 个字节。

  一个用于文本搜索的字符串。

  根据与值的精确匹配在引号筛选器中指定值。
+ `SortCriteria` – [SortCriterion](#aws-glue-api-catalog-tables-SortCriterion) 对象的数组，不超过 1 个结构。

  用于按字段名称对结果进行升序或降序排序的条件的列表。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要在单个响应中返回的表的最大数量。
+ `ResourceShareType` – UTF-8 字符串（有效值：`FOREIGN` \$1`ALL` \$1`FEDERATED` ）。

  允许您指定要搜索与您的账户共享的表。允许的值是 `FOREIGN` 或 `ALL`。
  + 如果设置为 `FOREIGN`，将搜索与您的账户共享的表。
  + 如果设置为 `ALL`，将列出与您的账户共享的表，以及本账户中的表。
+ `IncludeStatusDetails` – 布尔值。

  指定是否包含与 AWS Glue Data Catalog 视图创建或更新请求相关的状态详细信息。

**响应**
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果当前列表片段不是最后一个，则呈现)。
+ `TableList` – [表](#aws-glue-api-catalog-tables-Table) 对象的数组。

  请求的 `Table` 对象的列表。`SearchTables` 响应仅返回您有权访问的表。

**错误**
+ `InternalServiceException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## GetPartitionIndexes 操作（Python：get\$1partition\$1indexes）
<a name="aws-glue-api-catalog-tables-GetPartitionIndexes"></a>

检索与表关联的分区索引。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据目录的 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  指定要从中检索分区索引的数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  指定要为其检索分区索引的表的名称。
+ `NextToken` – UTF-8 字符串。

  延续标记 (如果这是延续调用，则包括)。

**响应**
+ `PartitionIndexDescriptorList` – [PartitionIndexDescriptor](#aws-glue-api-catalog-tables-PartitionIndexDescriptor) 对象的数组。

  索引描述符的列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果当前列表片段不是最后一个，则呈现)。

**错误**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `ConflictException`

## CreatePartitionIndex 操作（Python：create\$1partition\$1index）
<a name="aws-glue-api-catalog-tables-CreatePartitionIndex"></a>

在现有表中创建指定的分区索引。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据目录的 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  指定要创建分区索引的数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  指定要创建分区索引的表的名称。
+ `PartitionIndex` – *必填：*一个 [PartitionIndex](#aws-glue-api-catalog-tables-PartitionIndex) 对象。

  指定 `PartitionIndex` 结构在现有表中创建分区索引。

**响应**
+ *无响应参数。*

**错误**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`

## DeletePartitionIndex 操作（Python：delete\$1partition\$1index）
<a name="aws-glue-api-catalog-tables-DeletePartitionIndex"></a>

在现有表中删除指定的分区索引。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据目录的 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  指定要从中删除分区索引的数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  指定要从中删除分区索引的表的名称。
+ `IndexName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的分区索引的名称。

**响应**
+ *无响应参数。*

**错误**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `ConflictException`
+ `GlueEncryptionException`

## GetColumnStatisticsForTable 操作（Python：get\$1column\$1statistics\$1for\$1table）
<a name="aws-glue-api-catalog-tables-GetColumnStatisticsForTable"></a>

检索列的表统计数据信息。

此操作所需的 Identity and Access Management（IAM）权限是 `GetTable`。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  所涉分区所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区所在的目录数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区的表的名称。
+ `ColumnNames` – *必填：*UTF-8 字符串数组，不超过 100 个字符串。

  列名称的列表。

**响应**
+ `ColumnStatisticsList` – [ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics) 对象的数组。

  列统计数据列表。
+ `Errors` – [ColumnError](aws-glue-api-common.md#aws-glue-api-common-ColumnError) 对象的数组。

  检索失败的 ColumnStatistics 的列表。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`

## UpdateColumnStatisticsForTable 操作（Python：update\$1column\$1statistics\$1for\$1table）
<a name="aws-glue-api-catalog-tables-UpdateColumnStatisticsForTable"></a>

创建或更新列的表统计数据信息。

此操作所需的 Identity and Access Management（IAM）权限是 `UpdateTable`。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  所涉分区所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区所在的目录数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区的表的名称。
+ `ColumnStatisticsList` – *必填：*[ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics) 对象的数组，不超过 25 个结构。

  列统计数据的列表。

**响应**
+ `Errors` – [ColumnStatisticsError](aws-glue-api-common.md#aws-glue-api-common-ColumnStatisticsError) 对象的数组。

  ColumnStatisticsErrors 的列表。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`

## DeleteColumnStatisticsForTable 操作（Python：delete\$1column\$1statistics\$1for\$1table）
<a name="aws-glue-api-catalog-tables-DeleteColumnStatisticsForTable"></a>

检索列的表统计数据信息。

此操作所需的 Identity and Access Management（IAM）权限是 `DeleteTable`。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  所涉分区所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区所在的目录数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区的表的名称。
+ `ColumnName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  列的名称。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`

# 分区 API
<a name="aws-glue-api-catalog-partitions"></a>

分区 API 介绍用于处理分区的数据类型和操作。

## 数据类型
<a name="aws-glue-api-catalog-partitions-objects"></a>
+ [Partition 结构](#aws-glue-api-catalog-partitions-Partition)
+ [PartitionInput 结构](#aws-glue-api-catalog-partitions-PartitionInput)
+ [PartitionSpecWithSharedStorageDescriptor 结构](#aws-glue-api-catalog-partitions-PartitionSpecWithSharedStorageDescriptor)
+ [PartitionListComposingSpec 结构](#aws-glue-api-catalog-partitions-PartitionListComposingSpec)
+ [PartitionSpecProxy 结构](#aws-glue-api-catalog-partitions-PartitionSpecProxy)
+ [PartitionValueList 结构](#aws-glue-api-catalog-partitions-PartitionValueList)
+ [Segment 结构](#aws-glue-api-catalog-partitions-Segment)
+ [PartitionError 结构](#aws-glue-api-catalog-partitions-PartitionError)
+ [BatchUpdatePartitionFailureEntry 结构](#aws-glue-api-catalog-partitions-BatchUpdatePartitionFailureEntry)
+ [BatchUpdatePartitionRequestEntry 结构](#aws-glue-api-catalog-partitions-BatchUpdatePartitionRequestEntry)
+ [StorageDescriptor 结构](#aws-glue-api-catalog-partitions-StorageDescriptor)
+ [SchemaReference 结构](#aws-glue-api-catalog-partitions-SchemaReference)
+ [SerDeInfo 结构](#aws-glue-api-catalog-partitions-SerDeInfo)
+ [SkewedInfo 结构](#aws-glue-api-catalog-partitions-SkewedInfo)

## Partition 结构
<a name="aws-glue-api-catalog-partitions-Partition"></a>

表示表数据的一部分。

**Fields**
+ `Values` – UTF-8 字符串数组。

  分区的值。
+ `DatabaseName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中创建分区的目录数据库的名称。
+ `TableName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中创建分区的数据库表的名称。
+ `CreationTime` – 时间戳。

  创建分区的时间。
+ `LastAccessTime` – 时间戳。

  上次访问分区的时间。
+ `StorageDescriptor` – 一个 [StorageDescriptor](#aws-glue-api-catalog-partitions-StorageDescriptor) 对象。

  提供有关存储分区的物理位置的信息。
+ `Parameters` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  这些键值对用于定义分区参数。
+ `LastAnalyzedTime` – 时间戳。

  上次为该分区计算列统计信息的时间。
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区所在的数据目录的 ID。

## PartitionInput 结构
<a name="aws-glue-api-catalog-partitions-PartitionInput"></a>

用于创建和更新分区的结构。

**Fields**
+ `Values` – UTF-8 字符串数组。

  分区的值。尽管开发工具包不需要此参数，但您必须为有效输入指定此参数。

  新分区的键值必须作为字符串对象数组传递，这些对象的顺序必须与 Amazon S3 前缀中出现的分区键的顺序相同。否则，AWS Glue 会将值添加到错误的键。
+ `LastAccessTime` – 时间戳。

  上次访问分区的时间。
+ `StorageDescriptor` – 一个 [StorageDescriptor](#aws-glue-api-catalog-partitions-StorageDescriptor) 对象。

  提供有关存储分区的物理位置的信息。
+ `Parameters` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  这些键值对用于定义分区参数。
+ `LastAnalyzedTime` – 时间戳。

  上次为该分区计算列统计信息的时间。

## PartitionSpecWithSharedStorageDescriptor 结构
<a name="aws-glue-api-catalog-partitions-PartitionSpecWithSharedStorageDescriptor"></a>

共享物理位置的分区的分区规范。

**Fields**
+ `StorageDescriptor` – 一个 [StorageDescriptor](#aws-glue-api-catalog-partitions-StorageDescriptor) 对象。

  共享的物理存储信息。
+ `Partitions` – [分区](#aws-glue-api-catalog-partitions-Partition) 对象的数组。

  共享该物理位置的分区的列表。

## PartitionListComposingSpec 结构
<a name="aws-glue-api-catalog-partitions-PartitionListComposingSpec"></a>

列出相关的分区。

**Fields**
+ `Partitions` – [分区](#aws-glue-api-catalog-partitions-Partition) 对象的数组。

  编制规范中的分区的列表。

## PartitionSpecProxy 结构
<a name="aws-glue-api-catalog-partitions-PartitionSpecProxy"></a>

提供指定分区的根路径。

**Fields**
+ `DatabaseName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区所在的目录数据库。
+ `TableName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  包含分区的表的名称。
+ `RootPath` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于寻址分区的代理的根路径。
+ `PartitionSpecWithSharedSD` – 一个 [PartitionSpecWithSharedStorageDescriptor](#aws-glue-api-catalog-partitions-PartitionSpecWithSharedStorageDescriptor) 对象。

  共享同一物理存储位置的分区的规范。
+ `PartitionListComposingSpec` – 一个 [PartitionListComposingSpec](#aws-glue-api-catalog-partitions-PartitionListComposingSpec) 对象。

  指定分区的列表。

## PartitionValueList 结构
<a name="aws-glue-api-catalog-partitions-PartitionValueList"></a>

包含定义分区的值的列表。

**Fields**
+ `Values` – *必填*：UTF-8 字符串数组。

  值的列表。

## Segment 结构
<a name="aws-glue-api-catalog-partitions-Segment"></a>

定义表分区的非重叠区域，从而允许并行运行多个请求。

**Fields**
+ `SegmentNumber` – *必填：*数字（整数），至多为“无”。

  此片段的从零开始的索引编号。例如，如果片段的总数为 4，则 `SegmentNumber` 值的范围为 0 到 3 。
+ `TotalSegments` – *必填：*数字（整数），不小于 1 或大于 10。

  片段总数。

## PartitionError 结构
<a name="aws-glue-api-catalog-partitions-PartitionError"></a>

包含有关分区错误的信息。

**Fields**
+ `PartitionValues` – UTF-8 字符串数组。

  用于定义分区的值。
+ `ErrorDetail` – 一个 [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail) 对象。

  有关分区错误的详细信息。

## BatchUpdatePartitionFailureEntry 结构
<a name="aws-glue-api-catalog-partitions-BatchUpdatePartitionFailureEntry"></a>

包含有关批量更新分区错误的信息。

**Fields**
+ `PartitionValueList` – UTF-8 字符串数组，不超过 100 个字符串。

  用于定义分区的值的列表。
+ `ErrorDetail` – 一个 [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail) 对象。

  有关批量更新分区错误的详细信息。

## BatchUpdatePartitionRequestEntry 结构
<a name="aws-glue-api-catalog-partitions-BatchUpdatePartitionRequestEntry"></a>

该结构包含用于更新分区的值和结构。

**Fields**
+ `PartitionValueList` – *必填：*UTF-8 字符串数组，不超过 100 个字符串。

  用于定义分区的值的列表。
+ `PartitionInput` – *必填：*一个 [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput) 对象。

  用于更新分区的结构。

## StorageDescriptor 结构
<a name="aws-glue-api-catalog-partitions-StorageDescriptor"></a>

描述表数据的物理存储。

**Fields**
+ `Columns` – [列](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-Column) 对象的数组。

  表中的 `Columns` 的列表。
+ `Location` – 位置字符串，不超过 2056 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  表的物理位置。默认情况下，它采用仓库位置的形式，后跟仓库中的数据库位置，然后是表名称。
+ `AdditionalLocations` – UTF-8 字符串数组。

  指向 Delta 表所在路径的位置列表。
+ `InputFormat` – 格式字符串，不超过 128 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  输入格式：`SequenceFileInputFormat`（二进制）或 `TextInputFormat` 或自定义格式。
+ `OutputFormat` – 格式字符串，不超过 128 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  输出格式：`SequenceFileOutputFormat`（二进制）、`IgnoreKeyTextOutputFormat` 或自定义格式。
+ `Compressed` – 布尔值。

  如果对表中的数据进行压缩，则为 `True`，否则为 `False`。
+ `NumberOfBuckets` – 数字（整数）。

  如果表包含任何维度列，则必须指定。
+ `SerdeInfo` – 一个 [SerDeInfo](#aws-glue-api-catalog-partitions-SerDeInfo) 对象。

  序列化/反序列化（SerDe）信息。
+ `BucketColumns` – UTF-8 字符串数组。

  表中的 Reducer 分组列、集群列以及桶列的列表。
+ `SortColumns` – [顺序](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-Order) 对象的数组。

  指定表中的每个桶的排序顺序的列表。
+ `Parameters` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  使用键/值形式的用户提供的属性。
+ `SkewedInfo` – 一个 [SkewedInfo](#aws-glue-api-catalog-partitions-SkewedInfo) 对象。

  有关在列中经常出现的值（偏斜值）的信息。
+ `StoredAsSubDirectories` – 布尔值。

  如果表数据存储在子目录中，则为 `True`，否则为 `False`。
+ `SchemaReference` – 一个 [SchemaReference](#aws-glue-api-catalog-partitions-SchemaReference) 对象。

  引用存储在 AWS Glue 架构注册表中的架构的对象。

  创建表时，可以为架构传递列的空列表，而使用架构引用。

## SchemaReference 结构
<a name="aws-glue-api-catalog-partitions-SchemaReference"></a>

引用存储在 AWS Glue 架构注册表中的架构的对象。

**Fields**
+ `SchemaId` – 一个 [SchemaId](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaId) 对象。

  包含架构标识字段的结构。必须提供此值或 `SchemaVersionId`。
+ `SchemaVersionId` – UTF-8 字符串，长度不少于 36 个字节或超过 36 个字节，与 [Custom string pattern #45](aws-glue-api-common.md#regex_45) 匹配。

  分配给架构版本的唯一 ID。必须提供此值或 `SchemaId`。
+ `SchemaVersionNumber` – 数字（长度），不小于 1 或大于 100000。

  架构的版本号。

## SerDeInfo 结构
<a name="aws-glue-api-catalog-partitions-SerDeInfo"></a>

有关序列化/反序列化程序（SerDe）的信息，它用作抽取器和加载器。

**Fields**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  SerDe 的名称。
+ `SerializationLibrary` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  通常是实现 SerDe 的类。例如，`org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe`。
+ `Parameters` – 键值对的映射数组。

  每个键是一个键字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

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

  这些键值对用于定义 SerDe 的初始化参数。

## SkewedInfo 结构
<a name="aws-glue-api-catalog-partitions-SkewedInfo"></a>

指定表中的偏斜值。偏斜值是指出现频率很高的值。

**Fields**
+ `SkewedColumnNames` – UTF-8 字符串数组。

  包含偏斜值的列名称的列表。
+ `SkewedColumnValues` – UTF-8 字符串数组。

  经常被认为是偏斜的值的列表。
+ `SkewedColumnValueLocationMaps` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  偏斜值到包含它们的列的映射。

## 操作
<a name="aws-glue-api-catalog-partitions-actions"></a>
+ [CreatePartition 操作（Python：create\$1partition）](#aws-glue-api-catalog-partitions-CreatePartition)
+ [BatchCreatePartition 操作（Python：batch\$1create\$1partition）](#aws-glue-api-catalog-partitions-BatchCreatePartition)
+ [UpdatePartition 操作（Python：update\$1partition）](#aws-glue-api-catalog-partitions-UpdatePartition)
+ [DeletePartition 操作（Python：delete\$1partition）](#aws-glue-api-catalog-partitions-DeletePartition)
+ [BatchDeletePartition 操作（Python：batch\$1delete\$1partition）](#aws-glue-api-catalog-partitions-BatchDeletePartition)
+ [GetPartition 操作（Python：get\$1partition）](#aws-glue-api-catalog-partitions-GetPartition)
+ [GetPartitions 操作（Python：get\$1partitions）](#aws-glue-api-catalog-partitions-GetPartitions)
+ [BatchGetPartition 操作（Python：batch\$1get\$1partition）](#aws-glue-api-catalog-partitions-BatchGetPartition)
+ [BatchUpdatePartition 操作（Python：batch\$1update\$1partition）](#aws-glue-api-catalog-partitions-BatchUpdatePartition)
+ [GetColumnStatisticsForPartition 操作（Python：get\$1column\$1statistics\$1for\$1partition）](#aws-glue-api-catalog-partitions-GetColumnStatisticsForPartition)
+ [UpdateColumnStatisticsForPartition 操作（Python：update\$1column\$1statistics\$1for\$1partition）](#aws-glue-api-catalog-partitions-UpdateColumnStatisticsForPartition)
+ [DeleteColumnStatisticsForPartition 操作（Python：delete\$1column\$1statistics\$1for\$1partition）](#aws-glue-api-catalog-partitions-DeleteColumnStatisticsForPartition)

## CreatePartition 操作（Python：create\$1partition）
<a name="aws-glue-api-catalog-partitions-CreatePartition"></a>

创建新的分区。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中创建分区的目录的 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中创建分区的元数据数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中创建分区的元数据表的名称。
+ `PartitionInput` – *必填：*一个 [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput) 对象。

  一个用于定义要创建的分区的 `PartitionInput` 结构。

**响应**
+ *无响应参数。*

**错误**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`

## BatchCreatePartition 操作（Python：batch\$1create\$1partition）
<a name="aws-glue-api-catalog-partitions-BatchCreatePartition"></a>

在批量操作中创建一个或多个分区。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中创建分区的目录的 ID。目前，它应该为 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中创建分区的元数据数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中创建分区的元数据表的名称。
+ `PartitionInputList` – *必填：*[PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput) 对象的数组，不超过 100 个结构。

  用于定义要创建的分区的 `PartitionInput` 结构的列表。

**响应**
+ `Errors` – [PartitionError](#aws-glue-api-catalog-partitions-PartitionError) 对象的数组。

  在尝试创建请求的分区时遇到错误。

**错误**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`

## UpdatePartition 操作（Python：update\$1partition）
<a name="aws-glue-api-catalog-partitions-UpdatePartition"></a>

更新分区。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要更新的分区所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  所涉表所在的目录数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要更新的分区所在的表的名称。
+ `PartitionValueList` – *必填：*UTF-8 字符串数组，不超过 100 个字符串。

  用于定义分区更新的分区键值的列表。
+ `PartitionInput` – *必填：*一个 [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput) 对象。

  要将分区更新到的新分区对象。

  此 `Values` 属性无法更改。如果要更改分区的分区键值，请删除并重新创建分区。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`

## DeletePartition 操作（Python：delete\$1partition）
<a name="aws-glue-api-catalog-partitions-DeletePartition"></a>

删除指定的分区。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的分区所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  所涉表所在的目录数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  包含要删除的分区的表的名称。
+ `PartitionValues` – *必填*：UTF-8 字符串数组。

  用于定义分区的值。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## BatchDeletePartition 操作（Python：batch\$1delete\$1partition）
<a name="aws-glue-api-catalog-partitions-BatchDeletePartition"></a>

在批量操作中删除一个或多个分区。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的分区所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  所涉表所在的目录数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  包含要删除的分区的表的名称。
+ `PartitionsToDelete` – *必填：*[PartitionValueList](#aws-glue-api-catalog-partitions-PartitionValueList) 对象的数组，不超过 25 个结构。

  用于定义要删除的分区的 `PartitionInput` 结构的列表。

**响应**
+ `Errors` – [PartitionError](#aws-glue-api-catalog-partitions-PartitionError) 对象的数组。

  在尝试删除请求的分区时遇到错误。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## GetPartition 操作（Python：get\$1partition）
<a name="aws-glue-api-catalog-partitions-GetPartition"></a>

检索有关指定分区的信息。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  所涉分区所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区所在的目录数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区的表的名称。
+ `PartitionValues` – *必填*：UTF-8 字符串数组。

  用于定义分区的值。

**响应**
+ `Partition` – 一个 [分区](#aws-glue-api-catalog-partitions-Partition) 对象。

  请求的信息，采用 `Partition` 对象的形式。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`

## GetPartitions 操作（Python：get\$1partitions）
<a name="aws-glue-api-catalog-partitions-GetPartitions"></a>

检索有关表中的分区的信息。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  所涉分区所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区所在的目录数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区的表的名称。
+ `Expression` – 谓词字符串，不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  筛选要返回的分区的表达式。

  该表达式使用类似于 SQL `WHERE` 筛选条件子句的 SQL 语法。SQL 语句解析器 [JSQLParser](http://jsqlparser.sourceforge.net/home.php) 可解析表达式。

  *运算符*：以下是您可以在 `Expression` API 调用中使用的运算符：  
=  
检查两个操作数的值是否相等；如果是，则条件成立。  
示例：假设“变量 a”保持 10，“变量 b”保持 20。  
(a = b) 不成立。  
< >  
检查两个操作数的值是否相等；如果值不相等，则条件成立。  
示例：(a < > b) 成立。  
>  
检查左操作数的值是否大于右操作数的值；如果是，则条件成立。  
示例：(a > b) 不成立。  
<  
检查左操作数的值是否小于右操作数的值；如果是，则条件成立。  
示例：(a < b) 成立。  
>=  
检查左操作数的值是否大于或等于右操作数的值；如果是，则条件成立。  
示例：(a >= b) 不成立。  
<=  
检查左操作数的值是否小于或等于右操作数的值；如果是，则条件成立。  
示例：(a <= b) 成立。  
AND、OR、IN、BETWEEN、LIKE、NOT、IS NULL  
逻辑运算符。

  *支持的分区键类型*：以下是受支持的分区键。
  + `string`
  + `date`
  + `timestamp`
  + `int`
  + `bigint`
  + `long`
  + `tinyint`
  + `smallint`
  + `decimal`

  如果遇到无效类型，则会引发异常。

  以下列表显示了每种类型的有效运算符。定义爬网程序时，`partitionKey` 类型将创建为 `STRING`，以与目录分区兼容。

  *示例 API 调用*：  
**Example**  

  表 `twitter_partition` 有三个分区：

  ```
  year = 2015
          year = 2016
          year = 2017
  ```  
**Example**  

  获取 `year` 等于 2015 的分区

  ```
  aws glue get-partitions --database-name dbname --table-name twitter_partition 
          --expression "year*=*'2015'"
  ```  
**Example**  

  获取 `year` 2016 至 2018 （不含）之间的分区

  ```
  aws glue get-partitions --database-name dbname --table-name twitter_partition 
          --expression "year>'2016' AND year<'2018'"
  ```  
**Example**  

  获取 `year` 2015 至 2018（含）之间的分区 以下 API 调用彼此等效：

  ```
  aws glue get-partitions --database-name dbname --table-name twitter_partition 
          --expression "year>='2015' AND year<='2018'"
          
          aws glue get-partitions --database-name dbname --table-name twitter_partition 
          --expression "year BETWEEN 2015 AND 2018"
          
          aws glue get-partitions --database-name dbname --table-name twitter_partition 
          --expression "year IN (2015,2016,2017,2018)"
  ```  
**Example**  

  通配符分区筛选条件，其中以下调用输出为分区年份=2017。`LIKE` 中不支持正则表达式。

  ```
  aws glue get-partitions --database-name dbname --table-name twitter_partition 
          --expression "year LIKE '%7'"
  ```
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果这不是检索这些分区的第一个调用)。
+ `Segment` – 一个 [客户细分](#aws-glue-api-catalog-partitions-Segment) 对象。

  要在该请求中扫描的表的片段。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要在单个响应中返回的最大分区数。
+ `ExcludeColumnSchema` – 布尔值。

  如果为真，则指定不返回分区列架构。当您只对分区值或位置等其他分区属性感兴趣时很有用。这种方法通过不返回重复数据来避免大型响应的问题。
+ `TransactionId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #44](aws-glue-api-common.md#regex_44) 匹配。

  在该 ID 处读取分区内容的事务 ID。
+ `QueryAsOfTime` – 时间戳。

  截至读取分区内容的时间。如果未设置，将使用最近的事务提交时间。无法与 `TransactionId` 一起指定。

**响应**
+ `Partitions` – [分区](#aws-glue-api-catalog-partitions-Partition) 对象的数组。

  请求的分区的列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果返回的分区列表不包括最后一个)。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`
+ `InvalidStateException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`

## BatchGetPartition 操作（Python：batch\$1get\$1partition）
<a name="aws-glue-api-catalog-partitions-BatchGetPartition"></a>

在批处理请求中检索分区。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  所涉分区所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区所在的目录数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区的表的名称。
+ `PartitionsToGet` – *必填：*[PartitionValueList](#aws-glue-api-catalog-partitions-PartitionValueList) 对象的数组，不超过 1000 个结构。

  用于标识要检索的分区的分区值的列表。

**响应**
+ `Partitions` – [分区](#aws-glue-api-catalog-partitions-Partition) 对象的数组。

  请求的分区的列表。
+ `UnprocessedKeys` – [PartitionValueList](#aws-glue-api-catalog-partitions-PartitionValueList) 对象数组，不超过 1000 个结构。

  请求中未返回分区的分区值的列表。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`
+ `InvalidStateException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`

## BatchUpdatePartition 操作（Python：batch\$1update\$1partition）
<a name="aws-glue-api-catalog-partitions-BatchUpdatePartition"></a>

在分批操作中更新一个或多个分区。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中更新分区的目录的 ID。目前，它应该为 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中更新分区的元数据数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中更新分区的元数据表的名称。
+ `Entries` – *必填*：[BatchUpdatePartitionRequestEntry](#aws-glue-api-catalog-partitions-BatchUpdatePartitionRequestEntry)对象的数组，不少于 1 个或不超过 100 个结构。

  最多 100 个 `BatchUpdatePartitionRequestEntry` 对象进行更新的列表。

**响应**
+ `Errors` – [BatchUpdatePartitionFailureEntry](#aws-glue-api-catalog-partitions-BatchUpdatePartitionFailureEntry) 对象的数组。

  在尝试更新请求的分区时遇到错误。`BatchUpdatePartitionFailureEntry` 对象的列表。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`

## GetColumnStatisticsForPartition 操作（Python：get\$1column\$1statistics\$1for\$1partition）
<a name="aws-glue-api-catalog-partitions-GetColumnStatisticsForPartition"></a>

检索列的分区统计数据信息。

此操作所需的 Identity and Access Management（IAM）权限是 `GetPartition`。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  所涉分区所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区所在的目录数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区的表的名称。
+ `PartitionValues` – *必填*：UTF-8 字符串数组。

  用于标识分区的分区值的列表。
+ `ColumnNames` – *必填：*UTF-8 字符串数组，不超过 100 个字符串。

  列名称的列表。

**响应**
+ `ColumnStatisticsList` – [ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics) 对象的数组。

  检索失败的 ColumnStatistics 的列表。
+ `Errors` – [ColumnError](aws-glue-api-common.md#aws-glue-api-common-ColumnError) 对象的数组。

  检索列统计数据时出错。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`

## UpdateColumnStatisticsForPartition 操作（Python：update\$1column\$1statistics\$1for\$1partition）
<a name="aws-glue-api-catalog-partitions-UpdateColumnStatisticsForPartition"></a>

创建或更新分区统计数据列信息。

此操作所需的 Identity and Access Management（IAM）权限是 `UpdatePartition`。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  所涉分区所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区所在的目录数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区的表的名称。
+ `PartitionValues` – *必填*：UTF-8 字符串数组。

  用于标识分区的分区值的列表。
+ `ColumnStatisticsList` – *必填：*[ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics) 对象的数组，不超过 25 个结构。

  列统计数据的列表。

**响应**
+ `Errors` – [ColumnStatisticsError](aws-glue-api-common.md#aws-glue-api-common-ColumnStatisticsError) 对象的数组。

  更新列统计数据时出错。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`

## DeleteColumnStatisticsForPartition 操作（Python：delete\$1column\$1statistics\$1for\$1partition）
<a name="aws-glue-api-catalog-partitions-DeleteColumnStatisticsForPartition"></a>

删除列的分区列统计数据信息。

此操作所需的 Identity and Access Management（IAM）权限是 `DeletePartition`。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  所涉分区所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区所在的目录数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分区的表的名称。
+ `PartitionValues` – *必填*：UTF-8 字符串数组。

  用于标识分区的分区值的列表。
+ `ColumnName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  列的名称。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`

# 连接 API
<a name="aws-glue-api-catalog-connections"></a>

连接 API 描述了与使用 AWS Glue 中的连接相关的数据类型和 API。

**Topics**
+ [连接 API](aws-glue-api-catalog-connections-connections.md)
+ [连接类型 API](aws-glue-api-catalog-connections-connections-type.md)
+ [连接元数据和预览 API](aws-glue-api-catalog-connections-connections-metadata.md)

# 连接 API
<a name="aws-glue-api-catalog-connections-connections"></a>

连接 API 介绍 AWS Glue 连接数据类型，以及用于创建、删除、更新和列出连接的 API。

## 数据类型
<a name="aws-glue-api-catalog-connections-connections-objects"></a>
+ [Connection 结构](#aws-glue-api-catalog-connections-connections-Connection)
+ [ConnectionInput 结构](#aws-glue-api-catalog-connections-connections-ConnectionInput)
+ [TestConnectionInput 结构](#aws-glue-api-catalog-connections-connections-TestConnectionInput)
+ [PhysicalConnectionRequirements 结构](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements)
+ [GetConnectionsFilter 结构](#aws-glue-api-catalog-connections-connections-GetConnectionsFilter)
+ [AuthenticationConfiguration 结构](#aws-glue-api-catalog-connections-connections-AuthenticationConfiguration)
+ [AuthenticationConfigurationInput 结构](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput)
+ [OAuth2Properties 结构](#aws-glue-api-catalog-connections-connections-OAuth2Properties)
+ [OAuth2PropertiesInput 结构](#aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput)
+ [OAuth2ClientApplication 结构](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication)
+ [AuthorizationCodeProperties 结构](#aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties)
+ [BasicAuthenticationCredentials 结构](#aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials)
+ [OAuth2Credentials 结构](#aws-glue-api-catalog-connections-connections-OAuth2Credentials)

## Connection 结构
<a name="aws-glue-api-catalog-connections-connections-Connection"></a>

定义与数据源的连接。

**Fields**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  连接定义的名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  连接的描述。
+ `ConnectionType` – UTF-8 字符串（有效值：`JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1 `VERTICA`）。

  连接的类型。目前不支持 SFTP。
+ `MatchCriteria` – UTF-8 字符串数组，不超过 10 个字符串。

  可用于选择此连接的条件的列表。
+ `ConnectionProperties` – 键值对的映射数组，不超过 100 对。

  每个键都是一个 UTF-8 字符串（有效值：`HOST` \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_GSSAPI_KEYTAB` \$1 `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` \$1 `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1 `DATABASE`）。

  每个值都是一个值字符串，长度不少于 1 个字节，不超过 1024 个字节。

  这些键值对定义使用版本 1 连接架构时的连接参数：
  + `HOST`- 主机 URI：完全限定域名 (FQDN) 或数据库主机的 IPv4 地址。
  + `PORT`- 端口的端口号，介于 1024 和 65535 之间，数据库主机在这些端口上侦听数据库连接。
  + `USER_NAME`- 登录数据库时使用的名称。`USER_NAME` 的值字符串为“`USERNAME`”。
  + `PASSWORD`- 用户名使用的密码（如果使用的话）。
  + `ENCRYPTED_PASSWORD` - 通过在数据目录加密设置中设置 `ConnectionPasswordEncryption` 来启用连接密码保护时，此字段会存储加密的密码。
  + `JDBC_DRIVER_JAR_URI` - 包含要使用的 JDBC 驱动程序的 JAR 文件的 Amazon Simple Storage Service (Amazon S3) 路径。
  + `JDBC_DRIVER_CLASS_NAME` - 要使用的 JDBC 驱动程序的类名称。
  + `JDBC_ENGINE` - 要使用的 JDBC 引擎的名称。
  + `JDBC_ENGINE_VERSION` - 要使用的 JDBC 引擎的版本。
  + `CONFIG_FILES` -（留待将来使用。）
  + `INSTANCE_ID` - 要使用的实例 ID。
  + `JDBC_CONNECTION_URL` - 用于连接到 JDBC 数据源的 URL。
  + `JDBC_ENFORCE_SSL` – 不区分大小写的布尔值字符串（true 或 false），指定是否对客户端的 JDBC 连接强制启用带主机名匹配的安全套接字层（SSL）。默认值为 false。
  + `CUSTOM_JDBC_CERT` – 指明客户根证书的 Amazon S3 位置。AWS Glue 在连接到客户数据库时，使用此根证书来验证客户的证书。AWS Glue 仅处理 X.509 证书。提供的证书必须经过 DER 编码，并以 Base64 编码 PEM 格式提供。
  + `SKIP_CUSTOM_JDBC_CERT_VALIDATION` – 默认情况下，这是 `false`。AWS Glue 将验证客户证书的签名算法和主题公有密钥算法。签名算法允许的算法仅包括 SHA256withRSA、SHA384withRSA 或 SHA512withRSA。对于主题公有密钥算法，密钥长度必须至少为 2048 位。您可以将该属性的值设置为 `true` 以跳过 AWS Glue 对客户证书进行的验证。
  + `CUSTOM_JDBC_CERT_STRING` - 一个自定义的 JDBC 证书字符串，用于域匹配或可分辨名称匹配以防止中间人攻击。在 Oracle 数据库中，这将用作 `SSL_SERVER_CERT_DN`；在 Microsoft SQL Server 中，这将用作 `hostNameInCertificate`。
  + `CONNECTION_URL` - 用于连接到一般（非 JDBC）数据源的 URL。
  + `SECRET_ID` – 用于凭证的 Secret Manager 的密钥 ID。
  + `CONNECTOR_URL` – MARKETPLACE 或自定义连接的连接器 URL。
  + `CONNECTOR_TYPE` – MARKETPLACE 或自定义连接的连接器类型。
  + `CONNECTOR_CLASS_NAME` – MARKETPLACE 或自定义连接的连接器类名称。
  + `KAFKA_BOOTSTRAP_SERVERS` - 以逗号分隔的主机和端口对列表，它们是 Kafka 集群中 Apache Kafka 代理商的地址，Kafka 客户端将连接到该集群并自行引导。
  + `KAFKA_SSL_ENABLED` – 是否启用或禁用 Apache Kafka 连接的 SSL。默认值为“true”。
  + `KAFKA_CUSTOM_CERT` – 私有 CA 证书文件的 Amazon S3 URL（.pem 格式）。默认值是空字符串。
  + `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` – 是否跳过 CA 证书文件的验证。AWS Glue 验证三种算法：SHA256withRSA、SHA384withRSA 和 SHA512withRSA。默认值为“false”。
  + `KAFKA_CLIENT_KEYSTORE` – 用于 Kafka 客户端身份验证的客户端密钥库文件的 Amazon S3 位置（可选）。
  + `KAFKA_CLIENT_KEYSTORE_PASSWORD` – 用于访问提供的密钥库的密码（可选）。
  + `KAFKA_CLIENT_KEY_PASSWORD` – 密钥库可以由多个密钥组成，因此这是与 Kafka 服务器端密钥一起使用的用于访问客户端密钥的密码（可选）。
  + `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` – Kafka 客户端密钥库密码的加密版本（如果用户选中使用 AWS Glue 加密密码设置）。
  + `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` – Kafka 客户端密钥密码的加密版本（如果用户选中使用 AWS Glue 加密密码设置）。
  + `KAFKA_SASL_MECHANISM` – `"SCRAM-SHA-512"`、`"GSSAPI"`、`"AWS_MSK_IAM"` 或 `"PLAIN"`。这些是受支持的 [SASL 机制](https://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml)。
  + `KAFKA_SASL_PLAIN_USERNAME` – 用于使用“PLAIN”机制进行身份验证的明文用户名。
  + `KAFKA_SASL_PLAIN_PASSWORD` – 用于使用“PLAIN”机制进行身份验证的明文密码。
  + `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` – Kafka SASL PLAIN 密码的加密版本（如果用户选中使用 AWS Glue 加密密码设置）。
  + `KAFKA_SASL_SCRAM_USERNAME` – 用于使用“SCRAM-SHA-512”机制进行身份验证的明文用户名。
  + `KAFKA_SASL_SCRAM_PASSWORD` – 用于使用“SCRAM-SHA-512”机制进行身份验证的明文密码。
  + `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` – Kafka SASL SCRAM 密码的加密版本（如果用户选中使用 AWS Glue 加密密码设置）。
  + `KAFKA_SASL_SCRAM_SECRETS_ARN` - AWS Secrets Manager 中密钥的 Amazon 资源名称。
  + `KAFKA_SASL_GSSAPI_KEYTAB` – Kerberos `keytab` 文件的 S3 位置。keytab 可存储一个或多个主体的长期密钥。有关更多信息，请参阅 [MIT Kerberos 文档：keytab](https://web.mit.edu/kerberos/krb5-latest/doc/basic/keytab_def.html)。
  + `KAFKA_SASL_GSSAPI_KRB5_CONF` – Kerberos `krb5.conf` 文件的 S3 位置。krb5.conf 可存储 Kerberos 配置信息，例如 KDC 服务器的位置。有关更多信息，请参阅 [MIT Kerberos 文档：krb5.conf](https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html)。
  + `KAFKA_SASL_GSSAPI_SERVICE` – Kerberos 服务名称，如您的 [Kafka 配置](https://kafka.apache.org/documentation/#brokerconfigs_sasl.kerberos.service.name)中的 `sasl.kerberos.service.name` 设置。
  + `KAFKA_SASL_GSSAPI_PRINCIPAL` – 使用的 Kerberos 主体的名称。AWS Glue有关更多信息，请参阅 [Kafka 文档：配置 Kafka 代理](https://kafka.apache.org/documentation/#security_sasl_kerberos_clientconfig)。
  + `ROLE_ARN` – 用于运行查询的角色。
  + `REGION` – 将在其中运行查询的 AWS 区域。
  + `WORKGROUP_NAME` – 将在其中运行查询的 Amazon Redshift Serverless 工作组或 Amazon Athena 工作组的名称。
  + `CLUSTER_IDENTIFIER` – 将在其中运行查询的 Amazon Redshift 集群的集群标识符。
  + `DATABASE` – 您要连接到的 Amazon Redshift 数据库。
+ `SparkProperties` – 键值对的映射数组。

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

  每个值都是一个 UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  特定于 Spark 计算环境的连接属性。
+ `AthenaProperties` – 键值对的映射数组。

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

  每个值都是一个 UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  特定于 Athena 计算环境的连接属性。
+ `PythonProperties` – 键值对的映射数组。

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

  每个值都是一个 UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  特定于 Python 计算环境的连接属性。
+ `PhysicalConnectionRequirements` – 一个 [PhysicalConnectionRequirements](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements) 对象。

  成功建立此连接所需的物理连接要求，如虚拟私有云（VPC）和 `SecurityGroup`。
+ `CreationTime` – 时间戳。

  创建此连接定义的时间的时间戳。
+ `LastUpdatedTime` – 时间戳。

  上次更新此连接定义的时间的时间戳。
+ `LastUpdatedBy` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  上次更新此连接定义的用户、组或角色。
+ `Status` – UTF-8 字符串（有效值：`READY` \$1`IN_PROGRESS` \$1`FAILED` ）。

  连接的状态。可以为以下值之一：`READY`、`IN_PROGRESS` 或 `FAILED`。
+ `StatusReason` – UTF-8 字符串，长度不少于 1 个字节，不超过 16384 个字节。

  连接状态原因。
+ `LastConnectionValidationTime` – 时间戳。

  上次验证此连接的时间的时间戳。
+ `AuthenticationConfiguration` – 一个 [AuthenticationConfiguration](#aws-glue-api-catalog-connections-connections-AuthenticationConfiguration) 对象。

  连接的身份验证属性。
+ `ConnectionSchemaVersion`：数字（整数），不小于 1 或大于 2。

  此连接的连接架构的版本。版本 2 支持特定计算环境的属性。
+ `CompatibleComputeEnvironments` – UTF-8 字符串数组。

  与连接兼容的计算环境列表。

## ConnectionInput 结构
<a name="aws-glue-api-catalog-connections-connections-ConnectionInput"></a>

用于指定要创建或更新的连接的结构。

**Fields**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  连接的名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  连接的描述。
+ `ConnectionType` – *必填：* UTF-8 字符串（有效值：`JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1 `VERTICA`）。

  连接的类型。目前，支持以下类型：
  + `JDBC` - 通过 Java 数据库连接（JDBC）指定与数据库的连接。

    `JDBC` 连接使用以下 ConnectionParameters。
    + 必需：所有（`HOST`、`PORT`、`JDBC_ENGINE`）或 `JDBC_CONNECTION_URL`。
    + 必需：所有（`USERNAME`、`PASSWORD`）或 `SECRET_ID`。
    + 可选：`JDBC_ENFORCE_SSL`、`CUSTOM_JDBC_CERT`、`CUSTOM_JDBC_CERT_STRING`、`SKIP_CUSTOM_JDBC_CERT_VALIDATION`。这些参数用于通过 JDBC 配置 SSL。
  + `KAFKA` - 指定与 Apache Kafka 流平台的连接。

    `KAFKA` 连接使用以下 ConnectionParameters。
    + 必需：`KAFKA_BOOTSTRAP_SERVERS`。
    + 可选：`KAFKA_SSL_ENABLED`、`KAFKA_CUSTOM_CERT`、`KAFKA_SKIP_CUSTOM_CERT_VALIDATION`。这些参数用于通过 `KAFKA` 配置 SSL。
    + 可选：`KAFKA_CLIENT_KEYSTORE`、`KAFKA_CLIENT_KEYSTORE_PASSWORD`、`KAFKA_CLIENT_KEY_PASSWORD`、`ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD`、`ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD`。这些参数用于在 `KAFKA` 中通过 SSL 配置 TLS 客户端配置。
    + 可选：`KAFKA_SASL_MECHANISM`。可以指定为 `SCRAM-SHA-512`、`GSSAPI` 或 `AWS_MSK_IAM`。
    + 可选：`KAFKA_SASL_SCRAM_USERNAME`、`KAFKA_SASL_SCRAM_PASSWORD`、`ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD`。这些参数用于通过 `KAFKA` 配置 SASL/SCRAM-SHA-512 身份验证。
    + 可选：`KAFKA_SASL_GSSAPI_KEYTAB`、`KAFKA_SASL_GSSAPI_KRB5_CONF`、`KAFKA_SASL_GSSAPI_SERVICE`、`KAFKA_SASL_GSSAPI_PRINCIPAL`。这些参数用于通过 `KAFKA` 配置 SASL/GSSAPI 身份验证。
  + `MONGODB` - 指定与 MongoDB 文档数据库的连接。

    `MONGODB` 连接使用以下 ConnectionParameters。
    + 必需：`CONNECTION_URL`。
    + 必需：所有（`USERNAME`、`PASSWORD`）或 `SECRET_ID`。
  + `VIEW_VALIDATION_REDSHIFT` – 指定 Amazon Redshift 用于视图验证的连接。
  + `VIEW_VALIDATION_ATHENA` – 指定 Amazon Athena 用于视图验证的连接。
  + `NETWORK` - 指定到 Amazon Virtual Private Cloud 环境（Amazon VPC）中的数据源的网络连接。

    `NETWORK` 连接不需要 ConnectionParameters。相反，提供 PhysicalConnectionRequirements。
  + `MARKETPLACE` – 使用从 AWS Marketplace 购买的连接器中包含的配置设置来读取和写入 AWS Glue 本地不支持的数据存储。

    `MARKETPLACE` 连接使用以下 ConnectionParameters。
    + 必需：`CONNECTOR_TYPE`、`CONNECTOR_URL`、`CONNECTOR_CLASS_NAME`、`CONNECTION_URL`。
    + `JDBC` `CONNECTOR_TYPE` 连接必需：所有（`USERNAME`、`PASSWORD`）或 `SECRET_ID`。
  + `CUSTOM` – 使用自定义连接器中包含的配置设置来读取和写入 本地不支持的数据存储。AWS Glue

  有关特定连接器所需的连接参数的更多信息，请参阅《AWS Glue 用户指南》中的[添加 AWS Glue 连接](https://docs.aws.amazon.com/glue/latest/dg/console-connections.html)中相应连接器的文档。

  `SFTP`不支持 。

  有关如何使用可选的 ConnectionProperties 配置 AWS Glue 中功能的更多信息，请参阅 [AWS Glue 连接属性](https://docs.aws.amazon.com/glue/latest/dg/connection-defining.html)。

  有关如何使用可选的 ConnectionProperties 配置 AWS Glue Studio 中功能的更多信息，请参阅[使用连接器和连接](https://docs.aws.amazon.com/glue/latest/ug/connectors-chapter.html)。
+ `MatchCriteria` – UTF-8 字符串数组，不超过 10 个字符串。

  可用于选择此连接的条件的列表。
+ `ConnectionProperties` – *必填*：键值对的映射数组，不超过 100 对。

  每个键都是一个 UTF-8 字符串（有效值：`HOST` \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_GSSAPI_KEYTAB` \$1 `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` \$1 `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1 `DATABASE`）。

  每个值都是一个值字符串，长度不少于 1 个字节，不超过 1024 个字节。

  这些键值对用于定义连接的参数。
+ `SparkProperties` – 键值对的映射数组。

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

  每个值都是一个 UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  特定于 Spark 计算环境的连接属性。
+ `AthenaProperties` – 键值对的映射数组。

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

  每个值都是一个 UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  特定于 Athena 计算环境的连接属性。
+ `PythonProperties` – 键值对的映射数组。

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

  每个值都是一个 UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  特定于 Python 计算环境的连接属性。
+ `PhysicalConnectionRequirements` – 一个 [PhysicalConnectionRequirements](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements) 对象。

  成功建立此连接所需的物理连接要求，如虚拟私有云（VPC）和 `SecurityGroup`。
+ `AuthenticationConfiguration` – 一个 [AuthenticationConfigurationInput](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput) 对象。

  连接的身份验证属性。
+ `ValidateCredentials` – 布尔值。

  用于在创建连接期间验证凭证的标志。默认设置为 true。
+ `ValidateForComputeEnvironments` – UTF-8 字符串数组。

  用于验证指定的连接属性的计算环境。

## TestConnectionInput 结构
<a name="aws-glue-api-catalog-connections-connections-TestConnectionInput"></a>

用于指定测试与服务的连接的结构。

**Fields**
+ `ConnectionType` – *必填：* UTF-8 字符串（有效值：`JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1 `VERTICA`）。

  要测试的连接类型。此操作仅适用于 `JDBC` 或 `SALESFORCE` 连接类型。
+ `ConnectionProperties` – *必填*：键值对的映射数组，不超过 100 对。

  每个键都是一个 UTF-8 字符串（有效值：`HOST` \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_GSSAPI_KEYTAB` \$1 `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` \$1 `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1 `DATABASE`）。

  每个值都是一个值字符串，长度不少于 1 个字节，不超过 1024 个字节。

  定义连接的参数的键值对。

  JDBC 连接使用下面的连接属性：
  + 必需：所有（`HOST`、`PORT`、`JDBC_ENGINE`）或 `JDBC_CONNECTION_URL`。
  + 必需：所有（`USERNAME`、`PASSWORD`）或 `SECRET_ID`。
  + 可选：`JDBC_ENFORCE_SSL`、`CUSTOM_JDBC_CERT`、`CUSTOM_JDBC_CERT_STRING`、`SKIP_CUSTOM_JDBC_CERT_VALIDATION`。这些参数用于通过 JDBC 配置 SSL。

  SALESFORCE 连接需要配置 `AuthenticationConfiguration` 成员。
+ `AuthenticationConfiguration` – 一个 [AuthenticationConfigurationInput](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput) 对象。

  在 TestConnection 请求中包含身份验证配置的结构。使用 OAuth 身份验证连接到 Salesforce 所必需的。

## PhysicalConnectionRequirements 结构
<a name="aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements"></a>

GetConnection 响应中的 OAuth 客户端应用程序。

**Fields**
+ `SubnetId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  连接使用的子网 ID。
+ `SecurityGroupIdList` – UTF-8 字符串数组，不超过 50 个字符串。

  连接使用的安全组 ID 列表。
+ `AvailabilityZone` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  连接的可用区。

## GetConnectionsFilter 结构
<a name="aws-glue-api-catalog-connections-connections-GetConnectionsFilter"></a>

筛选由 `GetConnections` API 操作返回的连接定义。

**Fields**
+ `MatchCriteria` – UTF-8 字符串数组，不超过 10 个字符串。

  一个条件字符串，它必须与连接定义中记录的条件相匹配，才能返回连接定义。
+ `ConnectionType` – UTF-8 字符串（有效值：`JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1 `VERTICA`）。

  要返回的连接的类型。目前不支持 SFTP。
+ `ConnectionSchemaVersion`：数字（整数），不小于 1 或大于 2。

  指示连接是使用架构版本 1 还是 2 创建的。

## AuthenticationConfiguration 结构
<a name="aws-glue-api-catalog-connections-connections-AuthenticationConfiguration"></a>

包含身份验证配置的结构。

**Fields**
+ `AuthenticationType` – UTF-8 字符串（有效值：`BASIC` \$1`OAUTH2` \$1`CUSTOM` \$1`IAM` ）。

  包含身份验证配置的结构。
+ `SecretArn` – UTF-8 字符串，与 [Custom string pattern #36](aws-glue-api-common.md#regex_36) 匹配。

  用于存储凭证的 Secrets Manager ARN。
+ `KmsKeyArn` – UTF-8 字符串，与 [Custom string pattern #42](aws-glue-api-common.md#regex_42) 匹配。

  用于加密敏感身份验证信息的 KMS 密钥的 Amazon 资源名称 (ARN)。此密钥用于保护存储在身份验证配置中的凭证和其他敏感数据。
+ `OAuth2Properties` – 一个 [OAuth2Properties](#aws-glue-api-catalog-connections-connections-OAuth2Properties) 对象。

  OAuth2 身份验证的属性。

## AuthenticationConfigurationInput 结构
<a name="aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput"></a>

在 CreateConnection 请求中包含身份验证配置的结构。

**Fields**
+ `AuthenticationType` – UTF-8 字符串（有效值：`BASIC` \$1`OAUTH2` \$1`CUSTOM` \$1`IAM` ）。

  在 CreateConnection 请求中包含身份验证配置的结构。
+ `OAuth2Properties` – 一个 [OAuth2PropertiesInput](#aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput) 对象。

  CreateConnection 请求中 OAuth2 身份验证的属性。
+ `SecretArn` – UTF-8 字符串，与 [Custom string pattern #36](aws-glue-api-common.md#regex_36) 匹配。

  用于在 CreateConnection 请求中存储凭证的 Secrets Manager ARN。
+ `KmsKeyArn` – UTF-8 字符串，与 [Custom string pattern #42](aws-glue-api-common.md#regex_42) 匹配。

  用于加密连接的 KMS 密钥的 ARN。仅作为请求中的输入并存储在 Secret Manager 中。
+ `BasicAuthenticationCredentials` – 一个 [BasicAuthenticationCredentials](#aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials) 对象。

  身份验证类型为基本身份验证时使用的凭证。
+ `CustomAuthenticationCredentials` – 键值对的映射数组。

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

  每个值都是一个 UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  身份验证类型为自定义身份验证时使用的凭证。

## OAuth2Properties 结构
<a name="aws-glue-api-catalog-connections-connections-OAuth2Properties"></a>

包含 OAuth2 身份验证属性的结构。

**Fields**
+ `OAuth2GrantType` – UTF-8 字符串（有效值：`AUTHORIZATION_CODE` \$1`CLIENT_CREDENTIALS` \$1`JWT_BEARER` ）。

  OAuth2 授权类型。例如，`AUTHORIZATION_CODE`、`JWT_BEARER` 或 `CLIENT_CREDENTIALS`。
+ `OAuth2ClientApplication` – 一个 [OAuth2ClientApplication](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication) 对象。

  客户端应用程序类型。例如，AWS\$1MANAGED 或 USER\$1MANAGED。
+ `TokenUrl` – UTF-8 字符串，长度不超过 256 个字节，与 [Custom string pattern #40](aws-glue-api-common.md#regex_40) 匹配。

  提供程序身份验证服务器的 URL，用于以授权代码交换访问令牌。
+ `TokenUrlParametersMap` – 键值对的映射数组。

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

  每个值都是一个 UTF-8 字符串，长度不少于 1 个字节，不超过 512 个字节。

  添加到令牌 `GET` 请求中的参数的映射。

## OAuth2PropertiesInput 结构
<a name="aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput"></a>

在 CreateConnection 请求中包含 OAuth2 属性的结构。

**Fields**
+ `OAuth2GrantType` – UTF-8 字符串（有效值：`AUTHORIZATION_CODE` \$1`CLIENT_CREDENTIALS` \$1`JWT_BEARER` ）。

  CreateConnection 请求中的 OAuth2 授权类型。例如，`AUTHORIZATION_CODE`、`JWT_BEARER` 或 `CLIENT_CREDENTIALS`。
+ `OAuth2ClientApplication` – 一个 [OAuth2ClientApplication](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication) 对象。

  CreateConnection 请求中的客户端应用程序类型。例如，`AWS_MANAGED` 或 `USER_MANAGED`。
+ `TokenUrl` – UTF-8 字符串，长度不超过 256 个字节，与 [Custom string pattern #40](aws-glue-api-common.md#regex_40) 匹配。

  提供程序身份验证服务器的 URL，用于以授权代码交换访问令牌。
+ `TokenUrlParametersMap` – 键值对的映射数组。

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

  每个值都是一个 UTF-8 字符串，长度不少于 1 个字节，不超过 512 个字节。

  添加到令牌 `GET` 请求中的参数的映射。
+ `AuthorizationCodeProperties` – 一个 [AuthorizationCodeProperties](#aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties) 对象。

  OAuth2 `AUTHORIZATION_CODE` 授权类型所需的属性集。
+ `OAuth2Credentials` – 一个 [OAuth2Credentials](#aws-glue-api-catalog-connections-connections-OAuth2Credentials) 对象。

  身份验证类型为 OAuth2 身份验证时使用的凭证。

## OAuth2ClientApplication 结构
<a name="aws-glue-api-catalog-connections-connections-OAuth2ClientApplication"></a>

用于连接的 OAuth2 客户端应用程序。

**Fields**
+ `UserManagedClientApplicationClientId` – UTF-8 字符串，长度不超过 2048 个字节，与 [Custom string pattern #37](aws-glue-api-common.md#regex_37) 匹配。

  如果 ClientAppType 是 `USER_MANAGED`，则为客户端应用程序 clientID。
+ `AWSManagedClientApplicationReference` – UTF-8 字符串，长度不超过 2048 个字节，与 [Custom string pattern #37](aws-glue-api-common.md#regex_37) 匹配。

  对 AWS 托管的 SaaS 端客户端应用程序的引用。

## AuthorizationCodeProperties 结构
<a name="aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties"></a>

OAuth2 `AUTHORIZATION_CODE` 授权类型工作流所需的属性集。

**Fields**
+ `AuthorizationCode` – UTF-8 字符串，长度不少于 1 个字节，不超过 4096 个字节，与 [Custom string pattern #37](aws-glue-api-common.md#regex_37) 匹配。

  将在 `AUTHORIZATION_CODE` 授权工作流的第三分支中使用的授权代码。这是一次性代码，一旦用于交换访问令牌后就会失效，因此可以将此值作为请求参数。
+ `RedirectUri` – UTF-8 字符串，长度不超过 512 个字节，与 [Custom string pattern #41](aws-glue-api-common.md#regex_41) 匹配。

  重定向 URI，在发布授权代码时授权服务器将用户重定向到此处。随后，在将授权代码交换为访问令牌时使用该 URI。

## BasicAuthenticationCredentials 结构
<a name="aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials"></a>

用于在不提供 `SecretArn` 值时提供基本身份验证凭证。

**Fields**
+ `Username` – UTF-8 字符串，长度不超过 512 个字节，与 [Custom string pattern #37](aws-glue-api-common.md#regex_37) 匹配。

  用于连接到数据来源的用户名。
+ `Password` – UTF-8 字符串，长度不超过 512 个字节，与 [Custom string pattern #33](aws-glue-api-common.md#regex_33) 匹配。

  用于连接到数据来源的密码。

## OAuth2Credentials 结构
<a name="aws-glue-api-catalog-connections-connections-OAuth2Credentials"></a>

身份验证类型为 OAuth2 身份验证时使用的凭证。

**Fields**
+ `UserManagedClientApplicationClientSecret` – UTF-8 字符串，长度不超过 512 个字节，与 [Custom string pattern #38](aws-glue-api-common.md#regex_38) 匹配。

  如果客户端应用程序为用户管理型，则为客户端应用程序客户端秘钥。
+ `AccessToken`：UTF-8 字符串，长度不超过 4096 个字节，与 [Custom string pattern #38](aws-glue-api-common.md#regex_38) 匹配。

  身份验证类型为 OAuth2 时使用的访问令牌。
+ `RefreshToken`：UTF-8 字符串，长度不超过 4096 个字节，与 [Custom string pattern #38](aws-glue-api-common.md#regex_38) 匹配。

  身份验证类型为 OAuth2 时使用的刷新令牌。
+ `JwtToken`：UTF-8 字符串，长度不超过 8000 个字节，与 [Custom string pattern #39](aws-glue-api-common.md#regex_39) 匹配。

  身份验证类型为 OAuth2 时使用的 JSON Web 令牌（JWT）。

## 操作
<a name="aws-glue-api-catalog-connections-connections-actions"></a>
+ [CreateConnection 操作（Python：create\$1connection）](#aws-glue-api-catalog-connections-connections-CreateConnection)
+ [DeleteConnection 操作（Python：delete\$1connection）](#aws-glue-api-catalog-connections-connections-DeleteConnection)
+ [GetConnection 操作（Python：get\$1connection）](#aws-glue-api-catalog-connections-connections-GetConnection)
+ [GetConnections 操作（Python：get\$1connections）](#aws-glue-api-catalog-connections-connections-GetConnections)
+ [UpdateConnection 操作（Python：update\$1connection）](#aws-glue-api-catalog-connections-connections-UpdateConnection)
+ [TestConnection 操作（Python：test\$1connection）](#aws-glue-api-catalog-connections-connections-TestConnection)
+ [BatchDeleteConnection 操作（Python：batch\$1delete\$1connection）](#aws-glue-api-catalog-connections-connections-BatchDeleteConnection)

## CreateConnection 操作（Python：create\$1connection）
<a name="aws-glue-api-catalog-connections-connections-CreateConnection"></a>

在数据目录中创建连接定义。

用于创建联合资源的连接需要 IAM `glue:PassConnection` 权限。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中创建连接的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `ConnectionInput` – *必填：*一个 [ConnectionInput](#aws-glue-api-catalog-connections-connections-ConnectionInput) 对象。

  用于定义要创建的连接的 `ConnectionInput` 对象。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  您分配给连接的标签。

**响应**
+ `CreateConnectionStatus` – UTF-8 字符串（有效值：`READY` \$1`IN_PROGRESS` \$1`FAILED` ）。

  连接创建请求的状态。对于某些身份验证类型，请求可能需要一些时间，例如在 VPC 上创建包含令牌交换 OAuth 连接时。

**错误**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`

## DeleteConnection 操作（Python：delete\$1connection）
<a name="aws-glue-api-catalog-connections-connections-DeleteConnection"></a>

从数据目录中删除连接。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  连接所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `ConnectionName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的连接的名称。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `OperationTimeoutException`

## GetConnection 操作（Python：get\$1connection）
<a name="aws-glue-api-catalog-connections-connections-GetConnection"></a>

从数据目录中检索连接定义。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  连接所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索的连接定义的名称。
+ `HidePassword` – 布尔值。

  允许您在不返回密码的情况下检索连接元数据。例如，AWS Glue 控制台使用此标记来检索连接，并且不显示密码。当调用方可能无权使用 AWS KMS 密钥解密密码，但有权访问其余连接属性时，请设置此参数。
+ `ApplyOverrideForComputeEnvironment` – UTF-8 字符串（有效值：`SPARK` \$1`ATHENA` \$1`PYTHON` ）。

  对于可能在多个服务中使用的连接，指定为指定的计算环境返回属性。

**响应**
+ `Connection` – 一个 [Connection](#aws-glue-api-catalog-connections-connections-Connection) 对象。

  请求的连接定义。

**错误**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`

## GetConnections 操作（Python：get\$1connections）
<a name="aws-glue-api-catalog-connections-connections-GetConnections"></a>

从数据目录中检索连接定义的列表。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  连接所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `Filter` – 一个 [GetConnectionsFilter](#aws-glue-api-catalog-connections-connections-GetConnectionsFilter) 对象。

  控制将返回哪些连接的筛选器。
+ `HidePassword` – 布尔值。

  允许您在不返回密码的情况下检索连接元数据。例如，AWS Glue 控制台使用此标记来检索连接，并且不显示密码。当调用方可能无权使用 AWS KMS 密钥解密密码，但有权访问其余连接属性时，请设置此参数。
+ `NextToken` – UTF-8 字符串。

  延续标记 (如果这是延续调用)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要在一个响应中返回的连接的最大数量。

**响应**
+ `ConnectionList` – [Connection](#aws-glue-api-catalog-connections-connections-Connection) 对象的数组。

  请求的连接定义的列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果返回的连接列表不包括最后一个筛选的连接)。

**错误**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`

## UpdateConnection 操作（Python：update\$1connection）
<a name="aws-glue-api-catalog-connections-connections-UpdateConnection"></a>

在数据目录中更新连接定义。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  连接所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要更新的连接定义的名称。
+ `ConnectionInput` – *必填：*一个 [ConnectionInput](#aws-glue-api-catalog-connections-connections-ConnectionInput) 对象。

  用于重新定义所涉连接的 `ConnectionInput` 对象。

**响应**
+ *无响应参数。*

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`

## TestConnection 操作（Python：test\$1connection）
<a name="aws-glue-api-catalog-connections-connections-TestConnection"></a>

测试与某服务的连接以验证您提供的服务凭证。

您可以提供现有的连接名称或 `TestConnectionInput` 来测试不存在的连接输入。同时提供两者将导致错误。

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

**请求**
+ `ConnectionName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  可选。要测试的连接的名称。如果仅提供名称，则操作将获取连接并使用它来进行测试。
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  连接所在的目录的 ID。
+ `TestConnectionInput` – 一个 [TestConnectionInput](#aws-glue-api-catalog-connections-connections-TestConnectionInput) 对象。

  用于指定测试与服务的连接的结构。

**响应**
+ *无响应参数。*

**错误**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ConflictException`
+ `InternalServiceException`

## BatchDeleteConnection 操作（Python：batch\$1delete\$1connection）
<a name="aws-glue-api-catalog-connections-connections-BatchDeleteConnection"></a>

从数据目录中删除连接定义的列表。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  连接所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `ConnectionNameList` – *必填：*UTF-8 字符串数组，不超过 25 个字符串。

  要删除的连接的名称的列表。

**响应**
+ `Succeeded` – UTF-8 字符串数组。

  已成功删除的连接定义的名称的列表。
+ `Errors` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  每个值都是一个 [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail) 对象。

  未成功删除的连接名称到错误详细信息的映射。

**错误**
+ `InternalServiceException`
+ `OperationTimeoutException`

# 连接类型 API
<a name="aws-glue-api-catalog-connections-connections-type"></a>

连接类型 API 描述与描述连接类型相关的 AWS Glue API。

## 连接管理 API
<a name="aws-glue-api-catalog-connections-connections-type-connection-management"></a>
+ [DescribeConnectionType 操作（Python：describe\$1connection\$1type）](#aws-glue-api-catalog-connections-connections-type-DescribeConnectionType)
+ [ListConnectionTypes 操作（Python：list\$1connection\$1types）](#aws-glue-api-catalog-connections-connections-type-ListConnectionTypes)
+ [ConnectionTypeBrief 结构](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief)
+ [ConnectionTypeVariant 结构](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant)

## DescribeConnectionType 操作（Python：describe\$1connection\$1type）
<a name="aws-glue-api-catalog-connections-connections-type-DescribeConnectionType"></a>

`DescribeConnectionType` API 提供 AWS Glue 中给定连接类型支持的选项的完整详细信息。

**请求**
+ `ConnectionType` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要描述的连接类型的名称。

**响应**
+ `ConnectionType` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  连接类型的名称。
+ `Description` – UTF-8 字符串，长度不超过 1024 个字节。

  连接类型的描述。
+ `Capabilities` – 一个 [功能](#aws-glue-api-catalog-connections-connections-type-Capabilities) 对象。

  连接器支持的身份验证类型、数据接口类型（计算环境）以及数据操作。
+ `ConnectionProperties` – 键值对的映射数组。

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

  每个值都是一个 [属性](#aws-glue-api-catalog-connections-connections-type-Property) 对象。

  跨计算环境的通用连接属性。
+ `ConnectionOptions` – 键值对的映射数组。

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

  每个值都是一个 [属性](#aws-glue-api-catalog-connections-connections-type-Property) 对象。

  返回在 `ConnectionInput.ConnectionProperties` 中创建连接时可以设置的属性。`ConnectionOptions` 定义可以在传递给 DataFrame 的连接选项映射中的 Spark ETL 脚本中设置的参数。
+ `AuthenticationConfiguration` – 一个 [AuthConfiguration](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration) 对象。

  用于连接的身份验证类型。
+ `ComputeEnvironmentConfigurations` – 键值对的映射数组。

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

  每个值都是一个 [ComputeEnvironmentConfiguration](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration) 对象。

  连接支持的计算环境。
+ `PhysicalConnectionRequirements` – 键值对的映射数组。

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

  每个值都是一个 [属性](#aws-glue-api-catalog-connections-connections-type-Property) 对象。

  连接的物理要求，如 VPC、子网和安全组规范。
+ `AthenaConnectionProperties` – 键值对的映射数组。

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

  每个值都是一个 [属性](#aws-glue-api-catalog-connections-connections-type-Property) 对象。

  特定于 Athena 计算环境的连接属性。
+ `PythonConnectionProperties` – 键值对的映射数组。

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

  每个值都是一个 [属性](#aws-glue-api-catalog-connections-connections-type-Property) 对象。

  特定于 Python 计算环境的连接属性。
+ `SparkConnectionProperties` – 键值对的映射数组。

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

  每个值都是一个 [属性](#aws-glue-api-catalog-connections-connections-type-Property) 对象。

  特定于 Spark 计算环境的连接属性。

**错误**
+ `ValidationException`
+ `InvalidInputException`
+ `InternalServiceException`

## ListConnectionTypes 操作（Python：list\$1connection\$1types）
<a name="aws-glue-api-catalog-connections-connections-type-ListConnectionTypes"></a>

`ListConnectionTypes` API 提供了一种发现机制，用于了解 AWS Glue 中可用的连接类型。响应包含连接类型列表以及每种连接类型支持的内容的高级详细信息。列出的连接类型是 `CreateConnection` API 中 `ConnectionType` 值支持的选项集。

**请求**
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的最大结果数量。
+ `NextToken` – UTF-8 字符串，不少于 1 个字节或超过 2048 个字节，与 [Custom string pattern #11](aws-glue-api-common.md#regex_11) 匹配。

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

**响应**
+ `ConnectionTypes` – [ConnectionTypeBrief](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief) 对象的数组。

  `ConnectionTypeBrief` 对象列表，包含有关支持的连接类型的简要信息。
+ `NextToken` – UTF-8 字符串，不少于 1 个字节或超过 2048 个字节，与 [Custom string pattern #11](aws-glue-api-common.md#regex_11) 匹配。

  延续令牌（如果当前列表片段不是最后一个片段）。

**错误**
+ `InternalServiceException`

## ConnectionTypeBrief 结构
<a name="aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief"></a>

`ListConnectionTypes` API 返回的有关支持的连接类型的简要信息。

**Fields**
+ `ConnectionType` – UTF-8 字符串（有效值：`JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1 `VERTICA`）。

  连接类型的名称。
+ `DisplayName` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  AWS Glue 控制台中显示的连接类型的人类可读名称。
+ `Vendor` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  创建或维护此连接类型的供应商或者提供商的名称。
+ `Description` – UTF-8 字符串，长度不超过 1024 个字节。

  连接类型的描述。
+ `Categories` – .

  此连接类型所属的类别列表。类别可帮助用户根据其用例筛选并找到合适的连接类型。
+ `Capabilities` – 一个 [功能](#aws-glue-api-catalog-connections-connections-type-Capabilities) 对象。

  连接器支持的身份验证类型、数据接口类型（计算环境）以及数据操作。
+ `LogoUrl` – UTF-8 字符串。

  与连接类型相关联的徽标的 URL。
+ `ConnectionTypeVariants` – [ConnectionTypeVariant](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant) 对象的数组。

  此连接类型可用的变体列表。不同的变体可能会为特定用例或相同通用连接类型的实现提供专门的配置。

## ConnectionTypeVariant 结构
<a name="aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant"></a>

表示 AWS Glue Data Catalog 中连接类型的变体。连接类型变体为同一通用连接类型的不同实现提供特定的配置和行为。

**Fields**
+ `ConnectionTypeVariantName` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  连接类型变体的唯一标识符。此名称在内部用于标识连接类型的特定变体。
+ `DisplayName` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  AWS Glue 控制台中显示的连接类型变体的人类可读名称。
+ `Description` – UTF-8 字符串，长度不超过 1024 个字节。

  连接类型变体的详细描述，包括其用途、用例和任何特定的配置要求。
+ `LogoUrl` – UTF-8 字符串。

  与连接类型变体关联的徽标的 URL。

## 数据类型
<a name="aws-glue-api-catalog-connections-connections-type-connection-types"></a>
+ [验证结构](#aws-glue-api-catalog-connections-connections-type-Validation)
+ [AuthConfiguration 结构](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration)
+ [功能结构](#aws-glue-api-catalog-connections-connections-type-Capabilities)
+ [属性结构](#aws-glue-api-catalog-connections-connections-type-Property)
+ [AllowedValue 结构](#aws-glue-api-catalog-connections-connections-type-AllowedValue)
+ [ComputeEnvironmentConfiguration 结构](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration)

## 验证结构
<a name="aws-glue-api-catalog-connections-connections-type-Validation"></a>

定义如何对连接属性执行验证。

**Fields**
+ `ValidationType` – *必填：*UTF-8 字符串（有效值：`REGEX` \$1 `RANGE`）。

  要执行的验证类型，例如 `REGEX`。
+ `Patterns` – .

  适用于验证的模式列表。
+ `Description` – *必填项：*UTF-8 字符串，长度不少于 1 个字节，不超过 1024 个字节。

  验证的描述。
+ `MaxLength` – 数字（整数）。

  字符串连接属性的最大长度。
+ `Maximum` – 数字（整数）。

  指定 `RANGE` 类型验证时的最大值。
+ `Minimum` – 数字（整数）。

  指定 `RANGE` 类型验证时的最小值。

## AuthConfiguration 结构
<a name="aws-glue-api-catalog-connections-connections-type-AuthConfiguration"></a>

`DescribeConnectionType` API 返回的连接的身份验证配置。

**Fields**
+ `AuthenticationType` – *必填：*一个 [属性](#aws-glue-api-catalog-connections-connections-type-Property) 对象。

  连接的身份验证类型。
+ `SecretArn` – 一个 [属性](#aws-glue-api-catalog-connections-connections-type-Property) 对象。

  Secrets Manager 的 Amazon 资源名称 (ARN)。
+ `OAuth2Properties` – 键值对的映射数组。

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

  每个值都是一个 [属性](#aws-glue-api-catalog-connections-connections-type-Property) 对象。

  OAuth2 属性的键值对映射。每个值都是一个 `Property` 对象。
+ `BasicAuthenticationProperties` – 键值对的映射数组。

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

  每个值都是一个 [属性](#aws-glue-api-catalog-connections-connections-type-Property) 对象。

  OAuth2 属性的键值对映射。每个值都是一个 `Property` 对象。
+ `CustomAuthenticationProperties` – 键值对的映射数组。

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

  每个值都是一个 [属性](#aws-glue-api-catalog-connections-connections-type-Property) 对象。

  自定义身份验证属性的键值对映射。每个值都是一个 `Property` 对象。

## 功能结构
<a name="aws-glue-api-catalog-connections-connections-type-Capabilities"></a>

指定 `DescribeConnectionType` API 返回的支持的身份验证类型。

**Fields**
+ `SupportedAuthenticationTypes` – *必填*：UTF-8 字符串数组。

  支持的身份验证类型列表。
+ `SupportedDataOperations` – *必填*：UTF-8 字符串数组。

  支持的数据操作列表。
+ `SupportedComputeEnvironments` – *必填*：UTF-8 字符串数组。

  支持的计算环境列表。

## 属性结构
<a name="aws-glue-api-catalog-connections-connections-type-Property"></a>

定义计算环境的连接类型的对象。

**Fields**
+ `Name`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  属性的名称。
+ `Description`：*必需：*UTF-8 字符串，长度不超过 1024 个字节。

  属性的描述。
+ `Required` – *必填：*布尔值。

  指示属性是否为必需属性。
+ `PropertyTypes` – *必填*：UTF-8 字符串数组。

  描述属性的类型。
+ `AllowedValues` – [AllowedValue](#aws-glue-api-catalog-connections-connections-type-AllowedValue) 对象的数组。

  表示属性允许的值的 `AllowedValue` 对象列表。
+ `DataOperationScopes` – UTF-8 字符串数组。

  指示哪些数据操作适用于该属性。

## AllowedValue 结构
<a name="aws-glue-api-catalog-connections-connections-type-AllowedValue"></a>

表示属性允许的值的对象。

**Fields**
+ `Description` – UTF-8 字符串，长度不超过 1024 个字节。

  允许的值的描述。
+ `Value`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  属性允许的值。

## ComputeEnvironmentConfiguration 结构
<a name="aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration"></a>

包含 `DescribeConnectionType` API 返回的计算环境（如 Spark、Python 或 Athena）配置的对象。

**Fields**
+ `Name`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  计算环境配置的名称。
+ `Description`：*必需：*UTF-8 字符串，长度不超过 1024 个字节。

  计算环境的描述。
+ `ComputeEnvironment` – *必填：* UTF-8 字符串（有效值：`SPARK` \$1 `ATHENA` \$1 `PYTHON`）。

  计算环境的类型。
+ `SupportedAuthenticationTypes` – *必填*：UTF-8 字符串数组。

  计算环境支持的身份验证类型。
+ `ConnectionOptions` – *必填*：键值对的映射数组。

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

  每个值都是一个 [属性](#aws-glue-api-catalog-connections-connections-type-Property) 对象。

  用作计算环境的连接选项的参数。
+ `ConnectionPropertyNameOverrides` – *必填*：键值对的映射数组。

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

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

  计算环境的连接属性名称覆盖。
+ `ConnectionOptionNameOverrides` – *必填*：键值对的映射数组。

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

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

  计算环境的连接选项名称覆盖。
+ `ConnectionPropertiesRequiredOverrides` – *必填：*。

  计算环境需要覆盖的连接属性。
+ `PhysicalConnectionPropertiesRequired` – 布尔值。

  指示计算环境是否需要 `PhysicalConnectionProperties`。

# 连接元数据和预览 API
<a name="aws-glue-api-catalog-connections-connections-metadata"></a>

以下连接 API 介绍了用于描述连接元数据的操作。

## 数据类型
<a name="aws-glue-api-catalog-connections-connections-metadata-objects"></a>
+ [元数据](#aws-glue-api-catalog-connections-connections-metadata-Entity)
+ [字段结构](#aws-glue-api-catalog-connections-connections-metadata-Field)

## 元数据
<a name="aws-glue-api-catalog-connections-connections-metadata-Entity"></a>

给定 `ConnectionType` 支持的实体。

**Fields**
+ `EntityName` – UTF-8 字符串。

  在 中，将实体命名为 。
+ `Label` – UTF-8 字符串。

  用于实体的标签。
+ `IsParentEntity` – 布尔值。

  一个布尔值，有助于确定是否有可以列出的子对象。
+ `Description` – UTF-8 字符串。

  实体的描述。
+ `Category` – UTF-8 字符串。

  响应中存在的实体的类型。此值取决于源连接。例如，对于 Salesforce，这为 `SObjects`，对于 Amazon Redshift 等来源，这为 `databases`、`schemas` 或 `tables`。
+ `CustomProperties` – 

  连接器可为实体返回的可选键映射。

## 字段结构
<a name="aws-glue-api-catalog-connections-connections-metadata-Field"></a>

`Field` 对象包含与连接器中的某字段关联的不同属性的信息。

**Fields**
+ `FieldName` – UTF-8 字符串。

  字段的唯一标识符。
+ `Label` – UTF-8 字符串。

  用于该字段的可读标签。
+ `Description` – UTF-8 字符串。

  字段的描述。
+ `FieldType`：UTF-8 字符串（有效值：`INT` \$1 `SMALLINT` \$1 `BIGINT` \$1 `FLOAT` \$1 `LONG` \$1 `DATE` \$1 `BOOLEAN` \$1 `MAP` \$1 `ARRAY` \$1 `STRING` \$1 `TIMESTAMP` \$1 `DECIMAL` \$1 `BYTE` \$1 `SHORT` \$1 `DOUBLE` \$1 `STRUCT`）。

  字段中的数据类型。
+ `IsPrimaryKey` – 布尔值。

  指示此字段是否可用作给定实体的主键。
+ `IsNullable` – 布尔值。

  指示此字段是否可以为空。
+ `IsRetrievable` – 布尔值。

  指示此字段是否可以添加到 SQL 查询的 Select 子句中或者是否可以检索。
+ `IsFilterable` – 布尔值。

   指示在查询数据时是否可以在 SQL 语句的筛选条件子句（`WHERE` 子句）中使用此字段。
+ `IsPartitionable` – 布尔值。

  指示是否可以使用给定字段对向 SaaS 进行的查询进行分区。
+ `IsCreateable` – 布尔值。

  指示此字段是否可以作为目标写入的一部分创建。
+ `IsUpdateable` – 布尔值。

  指示此字段是否可以作为目标写入的一部分更新。
+ `IsUpsertable` – 布尔值。

  指示此字段是否可以作为目标写入的一部分更新插入。
+ `IsDefaultOnCreate` – 布尔值。

  指示在创建对象时（例如在时间戳时创建的）是否自动填充此字段。
+ `SupportedValues` – .

  该字段支持的值的列表。
+ `SupportedFilterOperators` – UTF-8 字符串数组。

  指示此字段的支持筛选运算符。
+ `CustomProperties` – 

  可能返回的可选键映射。

## 操作
<a name="aws-glue-api-catalog-connections-connections-metadata-actions"></a>
+ [ListEntities 操作（Python：list\$1entities）](#aws-glue-api-catalog-connections-connections-metadata-ListEntities)
+ [DescribeEntity 操作（Python：describe\$1entity)](#aws-glue-api-catalog-connections-connections-metadata-DescribeEntity)
+ [GetEntityRecords 操作（Python：get\$1entity\$1records）](#aws-glue-api-catalog-connections-connections-metadata-GetEntityRecords)

## ListEntities 操作（Python：list\$1entities）
<a name="aws-glue-api-catalog-connections-connections-metadata-ListEntities"></a>

返回连接类型支持的可用实体。

**请求**
+ `ConnectionName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  具有查询任何连接类型所需凭证的连接的名称。
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  包含连接的目录的目录 ID。这可以为空，默认情况下，AWS 账户 ID 就是目录 ID。
+ `ParentEntityName` – UTF-8 字符串。

  您想要列出子项的父实体的名称。此参数采用实体的完全限定路径来列出子实体。
+ `NextToken` – UTF-8 字符串，不少于 1 个字节或超过 2048 个字节，与 [Custom string pattern #11](aws-glue-api-common.md#regex_11) 匹配。

  延续标记 (如果这是延续调用，则包括)。
+ `DataStoreApiVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 256 个字节，与 [Custom string pattern #23](aws-glue-api-common.md#regex_23) 匹配。

  SaaS 连接器的 API 版本。

**响应**
+ `Entities` – [实体](#aws-glue-api-catalog-connections-connections-metadata-Entity) 对象的数组。

  `Entity` 对象的列表。
+ `NextToken` – UTF-8 字符串，不少于 1 个字节或超过 2048 个字节，与 [Custom string pattern #11](aws-glue-api-common.md#regex_11) 匹配。

  延续令牌，如果当前片段不是最后一个片段则呈现。

**错误**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
+ `ValidationException`
+ `FederationSourceException`
+ `AccessDeniedException`

## DescribeEntity 操作（Python：describe\$1entity)
<a name="aws-glue-api-catalog-connections-connections-metadata-DescribeEntity"></a>

提供有关连接类型所使用的实体的详细信息以及所选实体中每个字段的数据模型的描述。

 响应包括构成实体的所有字段。

**请求**
+ `ConnectionName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  包含连接类型凭证的连接的名称。
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  包含连接的目录的目录 ID。这可以为空，默认情况下，AWS 账户 ID 就是目录 ID。
+ `EntityName` – *必填：*UTF-8 字符串。

  您想要从连接类型描述的实体的名称。
+ `NextToken` – UTF-8 字符串，不少于 1 个字节或超过 2048 个字节，与 [Custom string pattern #11](aws-glue-api-common.md#regex_11) 匹配。

  延续标记 (如果这是延续调用，则包括)。
+ `DataStoreApiVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 256 个字节，与 [Custom string pattern #23](aws-glue-api-common.md#regex_23) 匹配。

  用于数据存储的 API 版本。

**响应**
+ `Fields` – [字段](#aws-glue-api-catalog-connections-connections-metadata-Field) 对象的数组。

  描述该连接器实体的字段。这是 `Field` 对象的列表。`Field` 与数据库中的列非常相似。`Field` 对象包含与连接器中的字段关联的不同属性的信息。
+ `NextToken` – UTF-8 字符串，不少于 1 个字节或超过 2048 个字节，与 [Custom string pattern #11](aws-glue-api-common.md#regex_11) 匹配。

  延续令牌，如果当前片段不是最后一个片段则呈现。

**错误**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
+ `ValidationException`
+ `FederationSourceException`
+ `AccessDeniedException`

## GetEntityRecords 操作（Python：get\$1entity\$1records）
<a name="aws-glue-api-catalog-connections-connections-metadata-GetEntityRecords"></a>

此 API 用于从给定的连接类型或基于 Amazon S3 的原生 AWS Glue Data Catalog 查询预览数据。

以 JSON blob 数组的形式返回记录。每条记录都使用 Jackson JsonNode 根据 `DescribeEntity` API 定义的字段类型进行格式化。

Spark 连接器根据与 `DescribeEntity` API 中相同的数据类型映射生成架构。Spark 连接器在返回行时会将数据转换为与架构匹配的适当数据类型。

**请求**
+ `ConnectionName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  包含连接类型凭证的连接的名称。
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  包含连接的目录的目录 ID。这可以为空，默认情况下，AWS 账户 ID 就是目录 ID。
+ `EntityName` – *必填：*UTF-8 字符串。

  我们想要从给定的连接类型查询预览数据的实体的名称。
+ `NextToken` – UTF-8 字符串，不少于 1 个字节或超过 2048 个字节，与 [Custom string pattern #11](aws-glue-api-common.md#regex_11) 匹配。

  延续标记 (如果这是延续调用，则包括)。
+ `DataStoreApiVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 256 个字节，与 [Custom string pattern #23](aws-glue-api-common.md#regex_23) 匹配。

  SaaS 连接器的 API 版本。
+ `ConnectionOptions` – 键值对的映射数组，不超过 100 对。

  每个键是一个 UTF-8 字符串，长度不少于 1 个字节，不超过 256 个字节，与 [Custom string pattern #18](aws-glue-api-common.md#regex_18) 匹配。

  每个值是一个 UTF-8 字符串，长度不少于 1 个字节，不超过 256 个字节，与 [Custom string pattern #17](aws-glue-api-common.md#regex_17) 匹配。

  查询数据所需的连接器选项。
+ `FilterPredicate`：UTF-8 字符串，长度不少于 1 个字节，不超过 100000 个字节。

  您可以在查询请求中应用的筛选谓词。
+ `Limit`：*必需：*数字（长度），不少于 1 或不超过 1000。

  限制通过请求提取的记录数。
+ `SelectedFields`：UTF-8 字符串数组，不少于 1 个字符串，不超过 1000 个字符串。

   我们想要作为预览数据的一部分提取的字段列表。

**响应**
+ `Records` – 结构数组。

  请求的 对象的列表。
+ `NextToken` – UTF-8 字符串，不少于 1 个字节或超过 2048 个字节，与 [Custom string pattern #11](aws-glue-api-common.md#regex_11) 匹配。

  延续令牌，如果当前片段不是最后一个片段则呈现。

**错误**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
+ `ValidationException`
+ `FederationSourceException`
+ `AccessDeniedException`

# 用户定义的函数 API
<a name="aws-glue-api-catalog-functions"></a>

用户定义的函数 API 介绍用于处理函数的 AWS Glue 数据类型和操作。

## 数据类型
<a name="aws-glue-api-catalog-functions-objects"></a>
+ [UserDefinedFunction 结构](#aws-glue-api-catalog-functions-UserDefinedFunction)
+ [UserDefinedFunctionInput 结构](#aws-glue-api-catalog-functions-UserDefinedFunctionInput)

## UserDefinedFunction 结构
<a name="aws-glue-api-catalog-functions-UserDefinedFunction"></a>

表示与 Hive 用户定义函数 (`UDF`) 定义等效的函数。

**字段**
+ `FunctionName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  函数的名称。
+ `DatabaseName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  包含函数的目录数据库的名称。
+ `ClassName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  包含函数代码的 Java 类。
+ `OwnerName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  参数的所有者。
+ `OwnerType` – UTF-8 字符串（有效值：`USER` \$1 `ROLE` \$1 `GROUP`）。

  所有者类型。
+ `CreateTime` – 时间戳。

  创建函数的时间。
+ `ResourceUris` – [ResourceUri](aws-glue-api-common.md#aws-glue-api-common-ResourceUri) 对象数组，不超过 1000 个结构。

  函数的资源 URI。
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中创建函数的数据目录的 ID。

## UserDefinedFunctionInput 结构
<a name="aws-glue-api-catalog-functions-UserDefinedFunctionInput"></a>

用于创建或更新用户定义函数的结构。

**字段**
+ `FunctionName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  函数的名称。
+ `ClassName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  包含函数代码的 Java 类。
+ `OwnerName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  参数的所有者。
+ `OwnerType` – UTF-8 字符串（有效值：`USER` \$1 `ROLE` \$1 `GROUP`）。

  所有者类型。
+ `ResourceUris` – [ResourceUri](aws-glue-api-common.md#aws-glue-api-common-ResourceUri) 对象数组，不超过 1000 个结构。

  函数的资源 URI。

## 操作
<a name="aws-glue-api-catalog-functions-actions"></a>
+ [CreateUserDefinedFunction 操作（Python：create\$1user\$1defined\$1function）](#aws-glue-api-catalog-functions-CreateUserDefinedFunction)
+ [UpdateUserDefinedFunction 操作（Python：update\$1user\$1defined\$1function）](#aws-glue-api-catalog-functions-UpdateUserDefinedFunction)
+ [DeleteUserDefinedFunction 操作（Python：delete\$1user\$1defined\$1function）](#aws-glue-api-catalog-functions-DeleteUserDefinedFunction)
+ [GetUserDefinedFunction 操作（Python：get\$1user\$1defined\$1function）](#aws-glue-api-catalog-functions-GetUserDefinedFunction)
+ [GetUserDefinedFunctions 操作（Python：get\$1user\$1defined\$1functions）](#aws-glue-api-catalog-functions-GetUserDefinedFunctions)

## CreateUserDefinedFunction 操作（Python：create\$1user\$1defined\$1function）
<a name="aws-glue-api-catalog-functions-CreateUserDefinedFunction"></a>

在数据目录中创建新函数定义。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中创建函数的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要在其中创建函数的目录数据库的名称。
+ `FunctionInput` – *必填：*一个 [UserDefinedFunctionInput](#aws-glue-api-catalog-functions-UserDefinedFunctionInput) 对象。

  一个 `FunctionInput` 对象，它定义要在数据目录中创建的函数。

**响应**
+ *无响应参数。*

**错误**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`

## UpdateUserDefinedFunction 操作（Python：update\$1user\$1defined\$1function）
<a name="aws-glue-api-catalog-functions-UpdateUserDefinedFunction"></a>

在数据目录中更新现有函数定义。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要更新的函数所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要更新的函数所在的目录数据库的名称。
+ `FunctionName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  函数的名称。
+ `FunctionInput` – *必填：*一个 [UserDefinedFunctionInput](#aws-glue-api-catalog-functions-UserDefinedFunctionInput) 对象。

  一个 `FunctionInput` 对象，它重新定义数据目录中的函数。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`

## DeleteUserDefinedFunction 操作（Python：delete\$1user\$1defined\$1function）
<a name="aws-glue-api-catalog-functions-DeleteUserDefinedFunction"></a>

从数据目录中删除现有函数定义。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的函数所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  函数所在的目录数据库的名称。
+ `FunctionName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的函数定义的名称。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## GetUserDefinedFunction 操作（Python：get\$1user\$1defined\$1function）
<a name="aws-glue-api-catalog-functions-GetUserDefinedFunction"></a>

从数据目录中检索指定的函数定义。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索的函数所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  函数所在的目录数据库的名称。
+ `FunctionName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  函数的名称。

**响应**
+ `UserDefinedFunction` – 一个 [UserDefinedFunction](#aws-glue-api-catalog-functions-UserDefinedFunction) 对象。

  请求的函数定义。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`

## GetUserDefinedFunctions 操作（Python：get\$1user\$1defined\$1functions）
<a name="aws-glue-api-catalog-functions-GetUserDefinedFunctions"></a>

从数据目录中检索多个函数定义。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索的函数所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `DatabaseName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  函数所在的目录数据库的名称。如果未提供任何内容，则将返回来自目录中所有数据库的函数。
+ `Pattern` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  一个可选的函数名称模式字符串，用于筛选返回的函数定义。
+ `NextToken` – UTF-8 字符串。

  延续标记 (如果这是延续调用)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 100。

  要在一个响应中返回的函数的最大数量。

**响应**
+ `UserDefinedFunctions` – [UserDefinedFunction](#aws-glue-api-catalog-functions-UserDefinedFunction) 对象的数组。

  请求的函数定义的列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果返回函数的列表不包括最后一个请求的函数)。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`

# 将 Athena 目录导入 AWS Glue
<a name="aws-glue-api-catalog-migration"></a>

迁移 API 介绍与将 Athena 数据目录迁移到 AWS Glue 有关的 AWS Glue 数据类型和操作。

## 数据类型
<a name="aws-glue-api-catalog-migration-objects"></a>
+ [CatalogImportStatus 结构](#aws-glue-api-catalog-migration-CatalogImportStatus)

## CatalogImportStatus 结构
<a name="aws-glue-api-catalog-migration-CatalogImportStatus"></a>

包含迁移状态信息的结构。

**字段**
+ `ImportCompleted` – 布尔值。

  如果迁移已完成，则为 `True`，否则为 `False`。
+ `ImportTime` – 时间戳。

  启动迁移的时间。
+ `ImportedBy` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  启动迁移的人员的姓名。

## 操作
<a name="aws-glue-api-catalog-migration-actions"></a>
+ [ImportCatalogToGlue 操作（Python：import\$1catalog\$1to\$1glue）](#aws-glue-api-catalog-migration-ImportCatalogToGlue)
+ [GetCatalogImportStatus 操作（Python：get\$1catalog\$1import\$1status）](#aws-glue-api-catalog-migration-GetCatalogImportStatus)

## ImportCatalogToGlue 操作（Python：import\$1catalog\$1to\$1glue）
<a name="aws-glue-api-catalog-migration-ImportCatalogToGlue"></a>

将现有的 Amazon Athena 数据目录导入到 AWS Glue。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要导入的目录的 ID。目前，它应该为 AWS 账户 ID。

**响应**
+ *无响应参数。*

**错误**
+ `InternalServiceException`
+ `OperationTimeoutException`

## GetCatalogImportStatus 操作（Python：get\$1catalog\$1import\$1status）
<a name="aws-glue-api-catalog-migration-GetCatalogImportStatus"></a>

检索迁移操作的状态。

**请求**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要迁移的目录的 ID。目前，它应该为 AWS 账户 ID。

**响应**
+ `ImportStatus` – 一个 [CatalogImportStatus](#aws-glue-api-catalog-migration-CatalogImportStatus) 对象。

  指定目录迁移的状态。

**错误**
+ `InternalServiceException`
+ `OperationTimeoutException`

# 表优化器 API
<a name="aws-glue-api-table-optimizers"></a>

表优化器 API 介绍了用于启用压缩以提高读取性能的 AWS Glue API。

## 数据类型
<a name="aws-glue-api-table-optimizers-objects"></a>
+ [TableOptimizer 的结构](#aws-glue-api-table-optimizers-TableOptimizer)
+ [TableOptimizerConfiguration 的结构](#aws-glue-api-table-optimizers-TableOptimizerConfiguration)
+ [TableOptimizerVpcConfiguration 结构](#aws-glue-api-table-optimizers-TableOptimizerVpcConfiguration)
+ [CompactionConfiguration 结构](#aws-glue-api-table-optimizers-CompactionConfiguration)
+ [IcebergCompactionConfiguration 结构](#aws-glue-api-table-optimizers-IcebergCompactionConfiguration)
+ [TableOptimizerRun 的结构](#aws-glue-api-table-optimizers-TableOptimizerRun)
+ [BatchGetTableOptimizerEntry 的结构](#aws-glue-api-table-optimizers-BatchGetTableOptimizerEntry)
+ [BatchTableOptimizer 的结构](#aws-glue-api-table-optimizers-BatchTableOptimizer)
+ [BatchGetTableOptimizerError 的结构](#aws-glue-api-table-optimizers-BatchGetTableOptimizerError)
+ [RetentionConfiguration 结构](#aws-glue-api-table-optimizers-RetentionConfiguration)
+ [IcebergRetentionConfiguration 结构](#aws-glue-api-table-optimizers-IcebergRetentionConfiguration)
+ [OrphanFileDeletionConfiguration 结构](#aws-glue-api-table-optimizers-OrphanFileDeletionConfiguration)
+ [IcebergOrphanFileDeletionConfiguration 结构](#aws-glue-api-table-optimizers-IcebergOrphanFileDeletionConfiguration)
+ [CompactionMetrics 结构](#aws-glue-api-table-optimizers-CompactionMetrics)
+ [RetentionMetrics 结构](#aws-glue-api-table-optimizers-RetentionMetrics)
+ [OrphanFileDeletionMetrics 结构](#aws-glue-api-table-optimizers-OrphanFileDeletionMetrics)
+ [IcebergCompactionMetrics 结构](#aws-glue-api-table-optimizers-IcebergCompactionMetrics)
+ [IcebergRetentionMetrics 结构](#aws-glue-api-table-optimizers-IcebergRetentionMetrics)
+ [IcebergOrphanFileDeletionMetrics 结构](#aws-glue-api-table-optimizers-IcebergOrphanFileDeletionMetrics)
+ [RunMetrics 的结构](#aws-glue-api-table-optimizers-RunMetrics)

## TableOptimizer 的结构
<a name="aws-glue-api-table-optimizers-TableOptimizer"></a>

包含有关与表相关的优化器详细信息。

**字段**
+ `type` – UTF-8 字符串（有效值：`compaction="COMPACTION"` \$1 `retention="RETENTION"` \$1 `orphan_file_deletion="ORPHAN_FILE_DELETION"`）。

  优化器的类型。有效值为：
  + `compaction`：用于使用表优化器管理压缩。
  + `retention`：用于使用表优化器管理快照保留。
  + `orphan_file_deletion`：用于使用表优化器管理孤立文件删除。
+ `configuration` – 一个 [TableOptimizerConfiguration](#aws-glue-api-table-optimizers-TableOptimizerConfiguration) 对象。

  在创建或更新表优化器时指定的 `TableOptimizerConfiguration` 对象。
+ `lastRun` – 一个 [TableOptimizerRun](#aws-glue-api-table-optimizers-TableOptimizerRun) 对象。

  表示表优化器的上一次运行的 `TableOptimizerRun` 对象。
+ `configurationSource` – UTF-8 字符串（有效值：`catalog="CATALOG"` \$1 `table="TABLE"`）。

   指定优化器配置源。该参数表明表优化器的配置方式以及配置的发起实体或服务。

## TableOptimizerConfiguration 的结构
<a name="aws-glue-api-table-optimizers-TableOptimizerConfiguration"></a>

包含有关表优化器配置的详细信息。您可以在创建或更新表优化器时传递此配置。

**字段**
+ `roleArn` – UTF-8 字符串，不少于 20 个字节，不超过 2048 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  由调用方传递的角色，将向服务授予代表调用方更新与优化器关联的资源的权限。
+ `enabled` – 布尔值。

  是否启用表优化。
+ `vpcConfiguration` – 一个 [TableOptimizerVpcConfiguration](#aws-glue-api-table-optimizers-TableOptimizerVpcConfiguration) 对象。

  表示表优化器 VPC 配置的 `TableOptimizerVpcConfiguration` 对象。

  此配置是对客户 VPC 中的表进行优化所必需的。
+ `compactionConfiguration` – 一个 [CompactionConfiguration](#aws-glue-api-table-optimizers-CompactionConfiguration) 对象。

  压缩优化器的配置。此配置用于定义如何压缩表中的数据文件，以提高查询性能并降低存储成本。
+ `retentionConfiguration` – 一个 [RetentionConfiguration](#aws-glue-api-table-optimizers-RetentionConfiguration) 对象。

  快照保留优化器的配置。
+ `orphanFileDeletionConfiguration` – 一个 [OrphanFileDeletionConfiguration](#aws-glue-api-table-optimizers-OrphanFileDeletionConfiguration) 对象。

  孤立文件删除优化器的配置。

## TableOptimizerVpcConfiguration 结构
<a name="aws-glue-api-table-optimizers-TableOptimizerVpcConfiguration"></a>

描述表优化器 VPC 配置的对象。

此配置是对客户 VPC 中的表进行优化所必需的。

**字段**
+ `glueConnectionName` – UTF-8 字符串，至少 1 个字节。

  用于表优化器 VPC 的 AWS Glue 连接名称。

## CompactionConfiguration 结构
<a name="aws-glue-api-table-optimizers-CompactionConfiguration"></a>

压缩优化器的配置。此配置用于定义如何压缩表中的数据文件，以提高查询性能并降低存储成本。

**字段**
+ `icebergConfiguration` – 一个 [IcebergCompactionConfiguration](#aws-glue-api-table-optimizers-IcebergCompactionConfiguration) 对象。

  Iceberg 压缩优化器的配置。

## IcebergCompactionConfiguration 结构
<a name="aws-glue-api-table-optimizers-IcebergCompactionConfiguration"></a>

Iceberg 压缩优化器的配置。该配置旨在定义用于优化 Iceberg 表中数据文件布局的参数。

**字段**
+ `strategy` – UTF-8 字符串（有效值：`binpack="BINPACK"` \$1 `sort="SORT"` \$1 `z-order="ZORDER"`）。

  用于压缩的策略。有效值为：
  +  `binpack`：将小文件合并成较大的文件（目标大小通常超过 100MB），同时应用任何待执行的删除。对于大多数使用案例，这是推荐使用的压缩策略。
  +  `sort`：在压缩期间根据指定列整理数据，按层次排序，从而提高筛选出的操作的查询性能。当查询经常会筛选特定列时，建议使用此策略。要使用此策略，必须首先在 Iceberg 表属性中使用 `sort_order` 表属性定义排序顺序。
  +  `z-order`：通过将多个属性混合成一个可用于排序的标量值来优化数据的组织，从而实现跨多个维度高效查询。需要同时跨多个维度查询数据时，建议使用此策略。要使用此策略，必须首先在 Iceberg 表属性中使用 `sort_order` 表属性定义排序顺序。

  如果未提供任何输入，则使用默认值“binpack”。
+ `minInputFiles` – 数字（整数）。

  压缩操作实际压缩文件之前，分区中必须存在的最小数据文件数量。该参数有助于控制压缩触发时机，避免对文件较少的分区执行不必要的压缩操作。如果未输入任何值，则使用默认值 100。
+ `deleteFileThreshold` – 数字（整数）。

  数据文件中必须存在的最小删除记录数量，以使其符合压缩条件。该参数通过关注包含大量删除记录的文件来优化压缩过程，移除已删除记录可提升查询性能。如果未输入任何值，则使用默认值 1。

## TableOptimizerRun 的结构
<a name="aws-glue-api-table-optimizers-TableOptimizerRun"></a>

包含表优化器运行的详细信息。

**字段**
+ `eventType` – UTF-8 字符串（有效值：`starting="STARTING"` \$1 `completed="COMPLETED"` \$1 `failed="FAILED"` \$1 `in_progress="IN_PROGRESS"`）。

  一种表示表优化器运行状态的事件类型。
+ `startTimestamp` – 时间戳。

  表示在 Lake Formation 中启动压缩作业的 epoch 时间戳。
+ `endTimestamp` – 时间戳。

  表示压缩作业结束的 epoch 时间戳。
+ `metrics` – 一个 [RunMetrics](#aws-glue-api-table-optimizers-RunMetrics) 对象。

  包含有关优化器运行的指标的 `RunMetrics` 对象。

  该成员已弃用。请参阅有关压缩、保留和孤立文件删除的独立指标成员。
+ `error` – UTF-8 字符串。

  优化器运行期间出现的错误。
+ `compactionMetrics` – 一个 [CompactionMetrics](#aws-glue-api-table-optimizers-CompactionMetrics) 对象。

  包含有关优化器运行的指标的 `CompactionMetrics` 对象。
+ `compactionStrategy` – UTF-8 字符串（有效值：`binpack="BINPACK"` \$1 `sort="SORT"` \$1 `z-order="ZORDER"`）。

  用于压缩运行的策略。指示为了确定在压缩过程中应如何选择和合并文件而应用的算法。有效值为：
  +  `binpack`：将小文件合并成较大的文件（目标大小通常超过 100MB），同时应用任何待执行的删除。对于大多数使用案例，这是推荐使用的压缩策略。
  +  `sort`：在压缩期间根据指定列整理数据，按层次排序，从而提高筛选出的操作的查询性能。当查询经常会筛选特定列时，建议使用此策略。要使用此策略，必须首先在 Iceberg 表属性中使用 `sort_order` 表属性定义排序顺序。
  +  `z-order`：通过将多个属性混合成一个可用于排序的标量值来优化数据的组织，从而实现跨多个维度高效查询。需要同时跨多个维度查询数据时，建议使用此策略。要使用此策略，必须首先在 Iceberg 表属性中使用 `sort_order` 表属性定义排序顺序。
+ `retentionMetrics` – 一个 [RetentionMetrics](#aws-glue-api-table-optimizers-RetentionMetrics) 对象。

  包含有关优化器运行的指标的 `RetentionMetrics` 对象。
+ `orphanFileDeletionMetrics` – 一个 [OrphanFileDeletionMetrics](#aws-glue-api-table-optimizers-OrphanFileDeletionMetrics) 对象。

  包含有关优化器运行指标的 `OrphanFileDeletionMetrics` 对象。

## BatchGetTableOptimizerEntry 的结构
<a name="aws-glue-api-table-optimizers-BatchGetTableOptimizerEntry"></a>

表示要在 `BatchGetTableOptimizer` 操作中检索的表优化器。

**字段**
+ `catalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的目录 ID。
+ `databaseName` – UTF-8 字符串，至少 1 个字节。

  表所在的目录中的数据库的名称。
+ `tableName` – UTF-8 字符串，至少 1 个字节。

  表的名称。
+ `type` – UTF-8 字符串（有效值：`compaction="COMPACTION"` \$1 `retention="RETENTION"` \$1 `orphan_file_deletion="ORPHAN_FILE_DELETION"`）。

  优化器的类型。

## BatchTableOptimizer 的结构
<a name="aws-glue-api-table-optimizers-BatchTableOptimizer"></a>

包含 `BatchGetTableOptimizer` 操作返回的表优化器之一的详细信息。

**字段**
+ `catalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的目录 ID。
+ `databaseName` – UTF-8 字符串，至少 1 个字节。

  表所在的目录中的数据库的名称。
+ `tableName` – UTF-8 字符串，至少 1 个字节。

  表的名称。
+ `tableOptimizer` – 一个 [TableOptimizer](#aws-glue-api-table-optimizers-TableOptimizer) 对象。

  包含有关表优化器配置和上次运行详细信息的 `TableOptimizer` 对象。

## BatchGetTableOptimizerError 的结构
<a name="aws-glue-api-table-optimizers-BatchGetTableOptimizerError"></a>

包含 `BatchGetTableOptimizer` 操作所返回错误列表中的某一个错误的详细信息。

**字段**
+ `error` – 一个 [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail) 对象。

  包含有关错误代码和错误消息详细信息的 `ErrorDetail` 对象。
+ `catalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的目录 ID。
+ `databaseName` – UTF-8 字符串，至少 1 个字节。

  表所在的目录中的数据库的名称。
+ `tableName` – UTF-8 字符串，至少 1 个字节。

  表的名称。
+ `type` – UTF-8 字符串（有效值：`compaction="COMPACTION"` \$1 `retention="RETENTION"` \$1 `orphan_file_deletion="ORPHAN_FILE_DELETION"`）。

  优化器的类型。

## RetentionConfiguration 结构
<a name="aws-glue-api-table-optimizers-RetentionConfiguration"></a>

快照保留优化器的配置。

**字段**
+ `icebergConfiguration` – 一个 [IcebergRetentionConfiguration](#aws-glue-api-table-optimizers-IcebergRetentionConfiguration) 对象。

  Iceberg 快照保留优化器的配置。

## IcebergRetentionConfiguration 结构
<a name="aws-glue-api-table-optimizers-IcebergRetentionConfiguration"></a>

Iceberg 快照保留优化器的配置。

**字段**
+ `snapshotRetentionPeriodInDays` – 数字（整数）。

  Iceberg 快照的保留天数。如果未提供任何输入，则将使用相应的 Iceberg 表配置字段；如果该字段不存在，则使用默认值 5。
+ `numberOfSnapshotsToRetain` – 数字（整数）。

  保留期内要保留的 Iceberg 快照数量。如果未提供任何输入，则将使用相应的 Iceberg 表配置字段；如果该字段不存在，则使用默认值 1。
+ `cleanExpiredFiles` – 布尔值。

  如果设置为 false，则仅从表元数据中删除快照，而不会删除底层数据和元数据文件。
+ `runRateInHours` – 数字（整数）。

  保留作业运行的时间间隔（以小时为单位）。该参数控制保留优化器为清理过期快照而运行的频率。该值必须在 3 到 168 小时（7 天）之间。如果未输入任何值，则使用默认值 24。

## OrphanFileDeletionConfiguration 结构
<a name="aws-glue-api-table-optimizers-OrphanFileDeletionConfiguration"></a>

孤立文件删除优化器的配置。

**字段**
+ `icebergConfiguration` – 一个 [IcebergOrphanFileDeletionConfiguration](#aws-glue-api-table-optimizers-IcebergOrphanFileDeletionConfiguration) 对象。

  Iceberg 孤立文件删除优化器的配置。

## IcebergOrphanFileDeletionConfiguration 结构
<a name="aws-glue-api-table-optimizers-IcebergOrphanFileDeletionConfiguration"></a>

Iceberg 孤立文件删除优化器的配置。

**字段**
+ `orphanFileRetentionPeriodInDays` – 数字（整数）。

  孤立文件在删除之前应保留的天数。如果未提供任何输入，则使用默认值 3。
+ `location` – UTF-8 字符串。

  指定要在其中查找文件的目录（默认为表所在的位置）。您可以选择子目录而不是顶层表的位置。
+ `runRateInHours` – 数字（整数）。

  孤立文件删除作业运行的时间间隔（以小时为单位）。该参数控制孤立文件删除优化器为清理孤立文件而运行的频率。该值必须在 3 到 168 小时（7 天）之间。如果未输入任何值，则使用默认值 24。

## CompactionMetrics 结构
<a name="aws-glue-api-table-optimizers-CompactionMetrics"></a>

包含有关优化器运行的压缩指标的结构。

**字段**
+ `IcebergMetrics` – 一个 [IcebergCompactionMetrics](#aws-glue-api-table-optimizers-IcebergCompactionMetrics) 对象。

  包含有关优化器运行的 Iceberg 压缩指标的结构。

## RetentionMetrics 结构
<a name="aws-glue-api-table-optimizers-RetentionMetrics"></a>

包含有关优化器运行的保留指标的结构。

**字段**
+ `IcebergMetrics` – 一个 [IcebergRetentionMetrics](#aws-glue-api-table-optimizers-IcebergRetentionMetrics) 对象。

  包含有关优化器运行的 Iceberg 保留指标的结构。

## OrphanFileDeletionMetrics 结构
<a name="aws-glue-api-table-optimizers-OrphanFileDeletionMetrics"></a>

包含有关优化器运行的孤立文件删除指标的结构。

**字段**
+ `IcebergMetrics` – 一个 [IcebergOrphanFileDeletionMetrics](#aws-glue-api-table-optimizers-IcebergOrphanFileDeletionMetrics) 对象。

  包含有关优化器运行的 Iceberg 孤立文件删除指标的结构。

## IcebergCompactionMetrics 结构
<a name="aws-glue-api-table-optimizers-IcebergCompactionMetrics"></a>

有关优化器运行的 Iceberg 压缩指标。

**字段**
+ `DpuHours` – 数字（double）。

  作业使用的 DPU 小时数。
+ `NumberOfDpus` – 数值（整型）。

  作业消耗的 DPU 数量，向上舍入到最接近的整数。
+ `JobDurationInHour` – 数字（double）。

  作业的持续时间（以小时为单位）。

## IcebergRetentionMetrics 结构
<a name="aws-glue-api-table-optimizers-IcebergRetentionMetrics"></a>

有关优化器运行的 Iceberg 快照保留指标。

**字段**
+ `DpuHours` – 数字（double）。

  作业使用的 DPU 小时数。
+ `NumberOfDpus` – 数值（整型）。

  作业消耗的 DPU 数量，向上舍入到最接近的整数。
+ `JobDurationInHour` – 数字（double）。

  作业的持续时间（以小时为单位）。

## IcebergOrphanFileDeletionMetrics 结构
<a name="aws-glue-api-table-optimizers-IcebergOrphanFileDeletionMetrics"></a>

有关优化器运行的 Iceberg 孤立文件删除指标。

**字段**
+ `DpuHours` – 数字（double）。

  作业使用的 DPU 小时数。
+ `NumberOfDpus` – 数值（整型）。

  作业消耗的 DPU 数量，向上舍入到最接近的整数。
+ `JobDurationInHour` – 数字（double）。

  作业的持续时间（以小时为单位）。

## RunMetrics 的结构
<a name="aws-glue-api-table-optimizers-RunMetrics"></a>

有关优化器运行的指标。

此结构已弃用。请参阅有关压缩、保留和孤立文件删除的独立指标成员。

**字段**
+ `NumberOfBytesCompacted` – UTF-8 字符串。

  由压缩作业运行移除的字节数。
+ `NumberOfFilesCompacted` – UTF-8 字符串。

  由压缩作业运行移除的文件数。
+ `NumberOfDpus` – UTF-8 字符串。

  作业消耗的 DPU 数量，向上舍入到最接近的整数。
+ `JobDurationInHour` – UTF-8 字符串。

  作业的持续时间（以小时为单位）。

## 操作
<a name="aws-glue-api-table-optimizers-actions"></a>
+ [GetTableOptimizer 操作（Python：get\$1table\$1optimizer）](#aws-glue-api-table-optimizers-GetTableOptimizer)
+ [BatchGetTableOptimizer 操作（Python：batch\$1get\$1table\$1optimizer）](#aws-glue-api-table-optimizers-BatchGetTableOptimizer)
+ [ListTableOptimizerRuns 操作（Python：list\$1table\$1optimizer\$1runs）](#aws-glue-api-table-optimizers-ListTableOptimizerRuns)
+ [CreateTableOptimizer 操作（Python：create\$1table\$1optimizer）](#aws-glue-api-table-optimizers-CreateTableOptimizer)
+ [DeleteTableOptimizer 操作（Python：delete\$1table\$1optimizer）](#aws-glue-api-table-optimizers-DeleteTableOptimizer)
+ [UpdateTableOptimizer 操作（Python：update\$1table\$1optimizer](#aws-glue-api-table-optimizers-UpdateTableOptimizer)

## GetTableOptimizer 操作（Python：get\$1table\$1optimizer）
<a name="aws-glue-api-table-optimizers-GetTableOptimizer"></a>

返回与指定表关联的所有优化器的配置。

**请求**
+ `CatalogId` –*必填项：*目录 id 字符串，长度不少于 1 个字节，并且不超过 255 个字节，并且符合 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  表的目录 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的目录中的数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的名称。
+ `Type` – *必填：* UTF-8 字符串（有效值：`compaction="COMPACTION"` \$1 `retention="RETENTION"` \$1 `orphan_file_deletion="ORPHAN_FILE_DELETION"`）。

  优化器的类型。

**响应**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的目录 ID。
+ `DatabaseName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的目录中的数据库的名称。
+ `TableName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的名称。
+ `TableOptimizer` – 一个 [TableOptimizer](#aws-glue-api-table-optimizers-TableOptimizer) 对象。

  与指定表关联的优化器。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `AccessDeniedException`
+ `InternalServiceException`
+ `ThrottlingException`

## BatchGetTableOptimizer 操作（Python：batch\$1get\$1table\$1optimizer）
<a name="aws-glue-api-table-optimizers-BatchGetTableOptimizer"></a>

返回指定表优化器的配置。

**请求**
+ `Entries` – *必填：*[BatchGetTableOptimizerEntry](#aws-glue-api-table-optimizers-BatchGetTableOptimizerEntry) 对象的数组。

  指定要检索的表优化器的 `BatchGetTableOptimizerEntry` 对象列表。

**响应**
+ `TableOptimizers` – [BatchTableOptimizer](#aws-glue-api-table-optimizers-BatchTableOptimizer) 对象的数组。

  `BatchTableOptimizer` 对象的列表。
+ `Failures` – [BatchGetTableOptimizerError](#aws-glue-api-table-optimizers-BatchGetTableOptimizerError) 对象的数组。

  操作中所出现错误的列表。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `AccessDeniedException`
+ `InternalServiceException`
+ `ThrottlingException`

## ListTableOptimizerRuns 操作（Python：list\$1table\$1optimizer\$1runs）
<a name="aws-glue-api-table-optimizers-ListTableOptimizerRuns"></a>

列出特定表的之前优化器运行历史记录。

**请求**
+ `CatalogId` –*必填项：*目录 id 字符串，长度不少于 1 个字节，并且不超过 255 个字节，并且符合 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  表的目录 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的目录中的数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的名称。
+ `Type` – *必填：* UTF-8 字符串（有效值：`compaction="COMPACTION"` \$1 `retention="RETENTION"` \$1 `orphan_file_deletion="ORPHAN_FILE_DELETION"`）。

  优化器的类型。
+ `MaxResults` – 数字（整数）。

  每次调用时将返回的最大优化器运行数。
+ `NextToken` – UTF-8 字符串。

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

**响应**
+ `CatalogId` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的目录 ID。
+ `DatabaseName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的目录中的数据库的名称。
+ `TableName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的名称。
+ `NextToken` – UTF-8 字符串。

  对返回的优化器运行列表进行分页的延续令牌（如果列表的当前段不是最后一段，则返回该令牌）。
+ `TableOptimizerRuns` – [TableOptimizerRun](#aws-glue-api-table-optimizers-TableOptimizerRun) 对象的数组。

  与表关联的优化器运行的列表。

**错误**
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `InvalidInputException`
+ `ValidationException`
+ `InternalServiceException`
+ `ThrottlingException`

## CreateTableOptimizer 操作（Python：create\$1table\$1optimizer）
<a name="aws-glue-api-table-optimizers-CreateTableOptimizer"></a>

为特定函数创建新的表优化器。

**请求**
+ `CatalogId` –*必填项：*目录 id 字符串，长度不少于 1 个字节，并且不超过 255 个字节，并且符合 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  表的目录 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的目录中的数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的名称。
+ `Type` – *必填：* UTF-8 字符串（有效值：`compaction="COMPACTION"` \$1 `retention="RETENTION"` \$1 `orphan_file_deletion="ORPHAN_FILE_DELETION"`）。

  优化器的类型。
+ `TableOptimizerConfiguration` – *必填：*一个 [TableOptimizerConfiguration](#aws-glue-api-table-optimizers-TableOptimizerConfiguration) 对象。

  表示表优化器的配置的 `TableOptimizerConfiguration` 对象。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `ValidationException`
+ `InvalidInputException`
+ `AccessDeniedException`
+ `AlreadyExistsException`
+ `InternalServiceException`
+ `ThrottlingException`

## DeleteTableOptimizer 操作（Python：delete\$1table\$1optimizer）
<a name="aws-glue-api-table-optimizers-DeleteTableOptimizer"></a>

删除一个表的一个优化器以及所有相关元数据。将不再对该表执行优化。

**请求**
+ `CatalogId` –*必填项：*目录 id 字符串，长度不少于 1 个字节，并且不超过 255 个字节，并且符合 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  表的目录 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的目录中的数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的名称。
+ `Type` – *必填：* UTF-8 字符串（有效值：`compaction="COMPACTION"` \$1 `retention="RETENTION"` \$1 `orphan_file_deletion="ORPHAN_FILE_DELETION"`）。

  优化器的类型。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `AccessDeniedException`
+ `InternalServiceException`
+ `ThrottlingException`

## UpdateTableOptimizer 操作（Python：update\$1table\$1optimizer
<a name="aws-glue-api-table-optimizers-UpdateTableOptimizer"></a>

更新现有表优化器的配置。

**请求**
+ `CatalogId` –*必填项：*目录 id 字符串，长度不少于 1 个字节，并且不超过 255 个字节，并且符合 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  表的目录 ID。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的目录中的数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的名称。
+ `Type` – *必填：* UTF-8 字符串（有效值：`compaction="COMPACTION"` \$1 `retention="RETENTION"` \$1 `orphan_file_deletion="ORPHAN_FILE_DELETION"`）。

  优化器的类型。
+ `TableOptimizerConfiguration` – *必填：*一个 [TableOptimizerConfiguration](#aws-glue-api-table-optimizers-TableOptimizerConfiguration) 对象。

  表示表优化器的配置的 `TableOptimizerConfiguration` 对象。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `AccessDeniedException`
+ `ValidationException`
+ `InternalServiceException`
+ `ThrottlingException`
+ `ConcurrentModificationException`

# 爬网程序和分类器 API
<a name="aws-glue-api-crawler"></a>

爬网程序和分类器 API 描述了 AWS Glue 爬网程序和分类器数据类型，并包含用于创建、删除、更新和列出爬网程序或分类器的 API。

**Topics**
+ [分类器 API](aws-glue-api-crawler-classifiers.md)
+ [爬网程序 API](aws-glue-api-crawler-crawling.md)
+ [列统计数据 API](aws-glue-api-crawler-column-statistics.md)
+ [爬网程序计划程序 API](aws-glue-api-crawler-scheduler.md)

# 分类器 API
<a name="aws-glue-api-crawler-classifiers"></a>

分类器 API 介绍 AWS Glue 分类器数据类型，并包含用于创建、删除、更新和列出分类器的 API。

## 数据类型
<a name="aws-glue-api-crawler-classifiers-objects"></a>
+ [Classifier 结构](#aws-glue-api-crawler-classifiers-Classifier)
+ [GrokClassifier 结构](#aws-glue-api-crawler-classifiers-GrokClassifier)
+ [XMLClassifier 结构](#aws-glue-api-crawler-classifiers-XMLClassifier)
+ [JsonClassifier 结构](#aws-glue-api-crawler-classifiers-JsonClassifier)
+ [CsvClassifier 结构](#aws-glue-api-crawler-classifiers-CsvClassifier)
+ [CreateGrokClassifierRequest 结构](#aws-glue-api-crawler-classifiers-CreateGrokClassifierRequest)
+ [UpdateGrokClassifierRequest 结构](#aws-glue-api-crawler-classifiers-UpdateGrokClassifierRequest)
+ [CreateXMLClassifierRequest 结构](#aws-glue-api-crawler-classifiers-CreateXMLClassifierRequest)
+ [UpdateXMLClassifierRequest 结构](#aws-glue-api-crawler-classifiers-UpdateXMLClassifierRequest)
+ [CreateJsonClassifierRequest 结构](#aws-glue-api-crawler-classifiers-CreateJsonClassifierRequest)
+ [UpdateJsonClassifierRequest 结构](#aws-glue-api-crawler-classifiers-UpdateJsonClassifierRequest)
+ [CreateCsvClassifierRequest 结构](#aws-glue-api-crawler-classifiers-CreateCsvClassifierRequest)
+ [UpdateCsvClassifierRequest 结构](#aws-glue-api-crawler-classifiers-UpdateCsvClassifierRequest)

## Classifier 结构
<a name="aws-glue-api-crawler-classifiers-Classifier"></a>

分类器会在爬网任务期间触发。分类器检查给定文件的格式是否可以处理。如果可以处理，分类器将以与该数据格式匹配的 `StructType` 对象的形式创建一个模式。

您可以使用 AWS Glue 提供的标准分类器，或自行编写分类器，以便更好地对数据源进行分类和指定要用于它们的合适架构。分类器可以是 `grok` 分类器、`XML` 分类器、`JSON` 分类器或自定义 `CSV` 分类器，它由 `Classifier` 对象中的字段之一指定。

**字段**
+ `GrokClassifier` – 一个 [GrokClassifier](#aws-glue-api-crawler-classifiers-GrokClassifier) 对象。

  使用 `grok` 的分类器。
+ `XMLClassifier` – 一个 [XMLClassifier](#aws-glue-api-crawler-classifiers-XMLClassifier) 对象。

  XML 内容的分类器。
+ `JsonClassifier` – 一个 [JsonClassifier](#aws-glue-api-crawler-classifiers-JsonClassifier) 对象。

  JSON 内容的分类器。
+ `CsvClassifier` – 一个 [CsvClassifier](#aws-glue-api-crawler-classifiers-CsvClassifier) 对象。

  逗号分隔值 (CSV) 的分类器。

## GrokClassifier 结构
<a name="aws-glue-api-crawler-classifiers-GrokClassifier"></a>

使用 `grok` 模式的分类器。

**字段**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分类器的名称。
+ `Classification` – *必填：*UTF-8 字符串。

  与分类器匹配的数据格式（例如，Twitter、JSON、Omniture 日志等）的标识符。
+ `CreationTime` – 时间戳。

  注册此分类器的时间。
+ `LastUpdated` – 时间戳。

  上次更新此分类器的时间。
+ `Version` – 数字（长型）。

  此分类器的版本。
+ `GrokPattern` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 2048 个字节，与 [A Logstash Grok string pattern](aws-glue-api-common.md#aws-glue-api-grok-pattern) 匹配。

  由此分类器应用于数据存储的 grok 模式。有关更多信息，请参阅[编写自定义分类器](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html)中的“内置模式”。
+ `CustomPatterns` – UTF-8 字符串，不超过 16000 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  由此分类器定义的可选自定义 grok 模式。有关更多信息，请参阅[编写自定义分类器](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html)中的“自定义模式”。

## XMLClassifier 结构
<a name="aws-glue-api-crawler-classifiers-XMLClassifier"></a>

`XML` 内容的分类器。

**字段**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分类器的名称。
+ `Classification` – *必填：*UTF-8 字符串。

  与分类器匹配的数据格式的标识符。
+ `CreationTime` – 时间戳。

  注册此分类器的时间。
+ `LastUpdated` – 时间戳。

  上次更新此分类器的时间。
+ `Version` – 数字（长型）。

  此分类器的版本。
+ `RowTag` – UTF-8 字符串。

  XML 标签，用于指定包含正在分析的 XML 文档中的每个记录的元素。无法识别自结束元素（以 `/>` 结束）。可以分析仅包含属性的空行元素，只要它以结束标签结束（例如，`<row item_a="A" item_b="B"></row>` 可以，但 `<row item_a="A" item_b="B" />` 不可以）。

## JsonClassifier 结构
<a name="aws-glue-api-crawler-classifiers-JsonClassifier"></a>

`JSON` 内容的分类器。

**字段**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分类器的名称。
+ `CreationTime` – 时间戳。

  注册此分类器的时间。
+ `LastUpdated` – 时间戳。

  上次更新此分类器的时间。
+ `Version` – 数字（长型）。

  此分类器的版本。
+ `JsonPath` – *必填：*UTF-8 字符串。

  一种分类器使用的 `JsonPath` 字符串，该字符串定义供分类器分类的 JSON 数据。AWS Glue 支持小部分适用于 JsonPath 的运算符，如[编写 JsonPath 自定义分类器](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json)中所述。

## CsvClassifier 结构
<a name="aws-glue-api-crawler-classifiers-CsvClassifier"></a>

自定义 `CSV` 内容的分类器。

**字段**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分类器的名称。
+ `CreationTime` – 时间戳。

  注册此分类器的时间。
+ `LastUpdated` – 时间戳。

  上次更新此分类器的时间。
+ `Version` – 数字（长型）。

  此分类器的版本。
+ `Delimiter` – UTF-8 字符串，长度不少于 1 个字节或超过 1 个字节，与 [Custom string pattern #26](aws-glue-api-common.md#regex_26) 匹配。

  一个自定义符号，表示分隔行中每个列条目的内容。
+ `QuoteSymbol` – UTF-8 字符串，长度不少于 1 个字节或超过 1 个字节，与 [Custom string pattern #26](aws-glue-api-common.md#regex_26) 匹配。

  一个自定义符号，表示将内容组合为单个列值的内容。它必须与列分隔符不同。
+ `ContainsHeader` – UTF-8 字符串（有效值：`UNKNOWN` \$1 `PRESENT` \$1 `ABSENT`）。

  指示 CSV 文件是否包含标头。
+ `Header` – UTF-8 字符串数组。

  表示列名称的字符串列表。
+ `DisableValueTrimming` – 布尔值。

  指定在标识列值类型之前不去除值。默认值为 `true`。
+ `AllowSingleColumn` – 布尔值。

  允许处理仅包含一列的文件。
+ `CustomDatatypeConfigured` – 布尔值。

  允许配置自定义数据类型。
+ `CustomDatatypes` – UTF-8 字符串数组。

  自定义数据类型列表包括“BINARY”、“BOOLEAN”、“DATE”、“DECIMAL”、“DOUBLE”、“FLOAT”、“INT”、“LONG”、“SHORT”、“STRING”、“TIMESTAMP”。
+ `Serde` – UTF-8 字符串（有效值：`OpenCSVSerDe` \$1 `LazySimpleSerDe` \$1 `None`）。

  设置用于在分类器中处理 CSV 的 SerDe，该分类器将应用于 Data Catalog。有效值包括 `OpenCSVSerDe`、`LazySimpleSerDe` 和 `None`。当您想让爬网程序执行检测时，可以指定 `None` 值。

## CreateGrokClassifierRequest 结构
<a name="aws-glue-api-crawler-classifiers-CreateGrokClassifierRequest"></a>

为要创建的 `CreateClassifier` 指定 `grok` 分类器。

**字段**
+ `Classification` – *必填：*UTF-8 字符串。

  与分类器匹配的数据格式 (例如，Twitter、JSON、Omniture 日志、Amazon CloudWatch Logs 等) 的标识符。
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  新分类器的名称。
+ `GrokPattern` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 2048 个字节，与 [A Logstash Grok string pattern](aws-glue-api-common.md#aws-glue-api-grok-pattern) 匹配。

  此分类器使用的 grok 模式。
+ `CustomPatterns` – UTF-8 字符串，不超过 16000 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  此分类器使用的可选自定义 grok 模式。

## UpdateGrokClassifierRequest 结构
<a name="aws-glue-api-crawler-classifiers-UpdateGrokClassifierRequest"></a>

指定要在传递到 `UpdateClassifier` 时更新的 grok 分类器。

**字段**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  `GrokClassifier` 的名称。
+ `Classification` – UTF-8 字符串。

  与分类器匹配的数据格式 (例如，Twitter、JSON、Omniture 日志、Amazon CloudWatch Logs 等) 的标识符。
+ `GrokPattern` – UTF-8 字符串，不少于 1 个字节或超过 2048 个字节，与 [A Logstash Grok string pattern](aws-glue-api-common.md#aws-glue-api-grok-pattern) 匹配。

  此分类器使用的 grok 模式。
+ `CustomPatterns` – UTF-8 字符串，不超过 16000 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  此分类器使用的可选自定义 grok 模式。

## CreateXMLClassifierRequest 结构
<a name="aws-glue-api-crawler-classifiers-CreateXMLClassifierRequest"></a>

为要创建的 `CreateClassifier` 指定 XML 分类器。

**字段**
+ `Classification` – *必填：*UTF-8 字符串。

  与分类器匹配的数据格式的标识符。
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分类器的名称。
+ `RowTag` – UTF-8 字符串。

  XML 标签，用于指定包含正在分析的 XML 文档中的每个记录的元素。无法识别自结束元素（以 `/>` 结束）。可以分析仅包含属性的空行元素，只要它以结束标签结束（例如，`<row item_a="A" item_b="B"></row>` 可以，但 `<row item_a="A" item_b="B" />` 不可以）。

## UpdateXMLClassifierRequest 结构
<a name="aws-glue-api-crawler-classifiers-UpdateXMLClassifierRequest"></a>

指定要更新的 XML 分类器。

**字段**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分类器的名称。
+ `Classification` – UTF-8 字符串。

  与分类器匹配的数据格式的标识符。
+ `RowTag` – UTF-8 字符串。

  XML 标签，用于指定包含正在分析的 XML 文档中的每个记录的元素。请注意，此标签无法识别自结束元素 (由 `/>` 结束)。可以分析仅包含属性的空行元素，只要它以结束标签结束（例如，`<row item_a="A" item_b="B"></row>` 可以，但 `<row item_a="A" item_b="B" />` 不可以）。

## CreateJsonClassifierRequest 结构
<a name="aws-glue-api-crawler-classifiers-CreateJsonClassifierRequest"></a>

为要创建的 `CreateClassifier` 指定 JSON 分类器。

**字段**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分类器的名称。
+ `JsonPath` – *必填：*UTF-8 字符串。

  一种分类器使用的 `JsonPath` 字符串，该字符串定义供分类器分类的 JSON 数据。AWS Glue 支持小部分适用于 JsonPath 的运算符，如[编写 JsonPath 自定义分类器](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json)中所述。

## UpdateJsonClassifierRequest 结构
<a name="aws-glue-api-crawler-classifiers-UpdateJsonClassifierRequest"></a>

指定要更新的 JSON 分类器。

**字段**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分类器的名称。
+ `JsonPath` – UTF-8 字符串。

  一种分类器使用的 `JsonPath` 字符串，该字符串定义供分类器分类的 JSON 数据。AWS Glue 支持小部分适用于 JsonPath 的运算符，如[编写 JsonPath 自定义分类器](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json)中所述。

## CreateCsvClassifierRequest 结构
<a name="aws-glue-api-crawler-classifiers-CreateCsvClassifierRequest"></a>

为要创建的 `CreateClassifier` 指定自定义 CSV 分类器。

**字段**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分类器的名称。
+ `Delimiter` – UTF-8 字符串，长度不少于 1 个字节或超过 1 个字节，与 [Custom string pattern #26](aws-glue-api-common.md#regex_26) 匹配。

  一个自定义符号，表示分隔行中每个列条目的内容。
+ `QuoteSymbol` – UTF-8 字符串，长度不少于 1 个字节或超过 1 个字节，与 [Custom string pattern #26](aws-glue-api-common.md#regex_26) 匹配。

  一个自定义符号，表示将内容组合为单个列值的内容。必须与列分隔符不同。
+ `ContainsHeader` – UTF-8 字符串（有效值：`UNKNOWN` \$1 `PRESENT` \$1 `ABSENT`）。

  指示 CSV 文件是否包含标头。
+ `Header` – UTF-8 字符串数组。

  表示列名称的字符串列表。
+ `DisableValueTrimming` – 布尔值。

  指定在标识列值类型之前不去除值。默认值为 true。
+ `AllowSingleColumn` – 布尔值。

  允许处理仅包含一列的文件。
+ `CustomDatatypeConfigured` – 布尔值。

  允许配置自定义数据类型。
+ `CustomDatatypes` – UTF-8 字符串数组。

  创建受支持的自定义数据类型列表。
+ `Serde` – UTF-8 字符串（有效值：`OpenCSVSerDe` \$1 `LazySimpleSerDe` \$1 `None`）。

  设置用于在分类器中处理 CSV 的 SerDe，该分类器将应用于 Data Catalog。有效值包括 `OpenCSVSerDe`、`LazySimpleSerDe` 和 `None`。当您想让爬网程序执行检测时，可以指定 `None` 值。

## UpdateCsvClassifierRequest 结构
<a name="aws-glue-api-crawler-classifiers-UpdateCsvClassifierRequest"></a>

指定要更新的自定义 CSV 分类器。

**字段**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分类器的名称。
+ `Delimiter` – UTF-8 字符串，长度不少于 1 个字节或超过 1 个字节，与 [Custom string pattern #26](aws-glue-api-common.md#regex_26) 匹配。

  一个自定义符号，表示分隔行中每个列条目的内容。
+ `QuoteSymbol` – UTF-8 字符串，长度不少于 1 个字节或超过 1 个字节，与 [Custom string pattern #26](aws-glue-api-common.md#regex_26) 匹配。

  一个自定义符号，表示将内容组合为单个列值的内容。它必须与列分隔符不同。
+ `ContainsHeader` – UTF-8 字符串（有效值：`UNKNOWN` \$1 `PRESENT` \$1 `ABSENT`）。

  指示 CSV 文件是否包含标头。
+ `Header` – UTF-8 字符串数组。

  表示列名称的字符串列表。
+ `DisableValueTrimming` – 布尔值。

  指定在标识列值类型之前不去除值。默认值为 true。
+ `AllowSingleColumn` – 布尔值。

  允许处理仅包含一列的文件。
+ `CustomDatatypeConfigured` – 布尔值。

  指定配置自定义数据类型。
+ `CustomDatatypes` – UTF-8 字符串数组。

  指定受支持的自定义数据类型列表。
+ `Serde` – UTF-8 字符串（有效值：`OpenCSVSerDe` \$1 `LazySimpleSerDe` \$1 `None`）。

  设置用于在分类器中处理 CSV 的 SerDe，该分类器将应用于 Data Catalog。有效值包括 `OpenCSVSerDe`、`LazySimpleSerDe` 和 `None`。当您想让爬网程序执行检测时，可以指定 `None` 值。

## 操作
<a name="aws-glue-api-crawler-classifiers-actions"></a>
+ [CreateClassifier 操作（Python：create\$1classifier）](#aws-glue-api-crawler-classifiers-CreateClassifier)
+ [DeleteClassifier 操作（Python：delete\$1classifier）](#aws-glue-api-crawler-classifiers-DeleteClassifier)
+ [GetClassifier 操作（Python：get\$1classifier）](#aws-glue-api-crawler-classifiers-GetClassifier)
+ [GetClassifiers 操作（Python：get\$1classifiers）](#aws-glue-api-crawler-classifiers-GetClassifiers)
+ [UpdateClassifier 操作（Python：update\$1classifier）](#aws-glue-api-crawler-classifiers-UpdateClassifier)

## CreateClassifier 操作（Python：create\$1classifier）
<a name="aws-glue-api-crawler-classifiers-CreateClassifier"></a>

在用户的账户中创建分类器。这可以是 `GrokClassifier`、`XMLClassifier`、`JsonClassifier` 或 `CsvClassifier`，具体取决于请求的哪个字段存在。

**请求**
+ `GrokClassifier` – 一个 [CreateGrokClassifierRequest](#aws-glue-api-crawler-classifiers-CreateGrokClassifierRequest) 对象。

  一个指定要创建的分类器的 `GrokClassifier` 对象。
+ `XMLClassifier` – 一个 [CreateXMLClassifierRequest](#aws-glue-api-crawler-classifiers-CreateXMLClassifierRequest) 对象。

  一个指定要创建的分类器的 `XMLClassifier` 对象。
+ `JsonClassifier` – 一个 [CreateJsonClassifierRequest](#aws-glue-api-crawler-classifiers-CreateJsonClassifierRequest) 对象。

  一个指定要创建的分类器的 `JsonClassifier` 对象。
+ `CsvClassifier` – 一个 [CreateCsvClassifierRequest](#aws-glue-api-crawler-classifiers-CreateCsvClassifierRequest) 对象。

  一个指定要创建的分类器的 `CsvClassifier` 对象。

**响应**
+ *无响应参数。*

**错误**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## DeleteClassifier 操作（Python：delete\$1classifier）
<a name="aws-glue-api-crawler-classifiers-DeleteClassifier"></a>

从数据目录中删除分类器。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的分类器名称。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `OperationTimeoutException`

## GetClassifier 操作（Python：get\$1classifier）
<a name="aws-glue-api-crawler-classifiers-GetClassifier"></a>

按名称检索分类器。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索的分类器的名称。

**响应**
+ `Classifier` – 一个 [分类器](#aws-glue-api-crawler-classifiers-Classifier) 对象。

  请求的分类器。

**错误**
+ `EntityNotFoundException`
+ `OperationTimeoutException`

## GetClassifiers 操作（Python：get\$1classifiers）
<a name="aws-glue-api-crawler-classifiers-GetClassifiers"></a>

列出数据目录中的所有分类器对象。

**请求**
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的列表的大小 (可选)。
+ `NextToken` – UTF-8 字符串。

  一个可选延续令牌。

**响应**
+ `Classifiers` – [分类器](#aws-glue-api-crawler-classifiers-Classifier) 对象的数组。

  请求的分类器对象的列表。
+ `NextToken` – UTF-8 字符串。

  一个延续令牌。

**错误**
+ `OperationTimeoutException`

## UpdateClassifier 操作（Python：update\$1classifier）
<a name="aws-glue-api-crawler-classifiers-UpdateClassifier"></a>

修改现有分类器（`GrokClassifier`、`XMLClassifier`、`JsonClassifier` 或 `CsvClassifier`，具体取决于存在的字段）。

**请求**
+ `GrokClassifier` – 一个 [UpdateGrokClassifierRequest](#aws-glue-api-crawler-classifiers-UpdateGrokClassifierRequest) 对象。

  一个包含已更新字段的 `GrokClassifier` 对象。
+ `XMLClassifier` – 一个 [UpdateXMLClassifierRequest](#aws-glue-api-crawler-classifiers-UpdateXMLClassifierRequest) 对象。

  一个包含已更新字段的 `XMLClassifier` 对象。
+ `JsonClassifier` – 一个 [UpdateJsonClassifierRequest](#aws-glue-api-crawler-classifiers-UpdateJsonClassifierRequest) 对象。

  一个包含已更新字段的 `JsonClassifier` 对象。
+ `CsvClassifier` – 一个 [UpdateCsvClassifierRequest](#aws-glue-api-crawler-classifiers-UpdateCsvClassifierRequest) 对象。

  一个包含已更新字段的 `CsvClassifier` 对象。

**响应**
+ *无响应参数。*

**错误**
+ `InvalidInputException`
+ `VersionMismatchException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`

# 爬网程序 API
<a name="aws-glue-api-crawler-crawling"></a>

爬网程序 API 介绍 AWS Glue 爬网程序数据类型，以及用于创建、删除、更新和列出爬网程序的 API。

## 数据类型
<a name="aws-glue-api-crawler-crawling-objects"></a>
+ [Crawler 结构](#aws-glue-api-crawler-crawling-Crawler)
+ [Schedule 结构](#aws-glue-api-crawler-crawling-Schedule)
+ [CrawlerTargets 结构](#aws-glue-api-crawler-crawling-CrawlerTargets)
+ [S3Target 结构](#aws-glue-api-crawler-crawling-S3Target)
+ [S3DeltaCatalogTarget 结构](#aws-glue-api-crawler-crawling-S3DeltaCatalogTarget)
+ [S3DeltaDirectTarget 结构](#aws-glue-api-crawler-crawling-S3DeltaDirectTarget)
+ [JdbcTarget 结构](#aws-glue-api-crawler-crawling-JdbcTarget)
+ [MongoDBTarget 结构](#aws-glue-api-crawler-crawling-MongoDBTarget)
+ [DynamoDBTarget 结构](#aws-glue-api-crawler-crawling-DynamoDBTarget)
+ [DeltaTarget 结构](#aws-glue-api-crawler-crawling-DeltaTarget)
+ [IcebergTarget 结构](#aws-glue-api-crawler-crawling-IcebergTarget)
+ [HudiTarget 结构](#aws-glue-api-crawler-crawling-HudiTarget)
+ [CatalogTarget 结构](#aws-glue-api-crawler-crawling-CatalogTarget)
+ [CrawlerMetrics 结构](#aws-glue-api-crawler-crawling-CrawlerMetrics)
+ [CrawlerHistory 结构](#aws-glue-api-crawler-crawling-CrawlerHistory)
+ [CrawlsFilter 结构](#aws-glue-api-crawler-crawling-CrawlsFilter)
+ [SchemaChangePolicy 结构](#aws-glue-api-crawler-crawling-SchemaChangePolicy)
+ [LastCrawlInfo 结构](#aws-glue-api-crawler-crawling-LastCrawlInfo)
+ [RecrawlPolicy 结构](#aws-glue-api-crawler-crawling-RecrawlPolicy)
+ [LineageConfiguration 结构](#aws-glue-api-crawler-crawling-LineageConfiguration)
+ [LakeFormationConfiguration 结构](#aws-glue-api-crawler-crawling-LakeFormationConfiguration)

## Crawler 结构
<a name="aws-glue-api-crawler-crawling-Crawler"></a>

指定一个爬网程序，该程序将检查数据源并使用分类器来尝试确定其架构。如果成功，该爬网程序将记录与 AWS Glue Data Catalog 中的数据源相关的元数据。

**Fields**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  爬网程序的名称。
+ `Role` – UTF-8 字符串。

  用于访问客户资源的 IAM 角色的 Amazon 资源名称（ARN），如 Amazon Simple Storage Service (Amazon S3) 数据。
+ `Targets` – 一个 [CrawlerTargets](#aws-glue-api-crawler-crawling-CrawlerTargets) 对象。

  要爬网的目标的集合。
+ `DatabaseName` – UTF-8 字符串。

  存储爬网程序输出的数据库的名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  爬网程序的描述。
+ `Classifiers` – UTF-8 字符串数组。

  指定与爬网程序关联的自定义分类器的 UTF-8 字符串列表。
+ `RecrawlPolicy` – 一个 [RecrawlPolicy](#aws-glue-api-crawler-crawling-RecrawlPolicy) 对象。

  指定是否再次网络爬取整个数据集，还是仅网络爬取自上次爬网程序运行以来添加的文件夹的策略。
+ `SchemaChangePolicy` – 一个 [SchemaChangePolicy](#aws-glue-api-crawler-crawling-SchemaChangePolicy) 对象。

  指定爬网程序的更新和删除行为的策略。
+ `LineageConfiguration` – 一个 [LineageConfiguration](#aws-glue-api-crawler-crawling-LineageConfiguration) 对象。

  指定是否为爬网程序启用数据系统的配置。
+ `State` – UTF-8 字符串（有效值：`READY` \$1`RUNNING` \$1`STOPPING` ）。

  指示是爬网程序正在运行还是运行正在等待处理。
+ `TablePrefix` – UTF-8 字符串，长度不超过 128 个字节。

  添加到创建的表的名称的前缀。
+ `Schedule` – 一个 [计划](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-Schedule) 对象。

  对于计划的爬网程序，是爬网程序运行时的计划。
+ `CrawlElapsedTime` – 数字（长型）。

  如果爬网程序正在运行，则包含自上次爬网开始已用的总时间。
+ `CreationTime` – 时间戳。

  创建爬网程序的时间。
+ `LastUpdated` – 时间戳。

  上次更新爬网程序的时间。
+ `LastCrawl` – 一个 [LastCrawlInfo](#aws-glue-api-crawler-crawling-LastCrawlInfo) 对象。

  上次爬网的状态，以及出错时可能显示的错误信息。
+ `Version` – 数字（长型）。

  爬网程序的版本。
+ `Configuration` – UTF-8 字符串。

  爬网程序配置信息。此受版本控制的 JSON 字符串允许用户指定爬网程序的行为的各个方面。有关更多信息，请参阅[设置爬网程序配置选项](https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html)。
+ `CrawlerSecurityConfiguration` – UTF-8 字符串，长度不超过 128 个字节。

  该爬网程序将使用的 `SecurityConfiguration` 结构的名称。
+ `LakeFormationConfiguration` – 一个 [LakeFormationConfiguration](#aws-glue-api-crawler-crawling-LakeFormationConfiguration) 对象。

  指定爬网程序是否应使用爬网程序的 AWS Lake Formation 凭证来替代 IAM 角色凭证。

## Schedule 结构
<a name="aws-glue-api-crawler-crawling-Schedule"></a>

一个使用 `cron` 语句计划事件的计划对象。

**Fields**
+ `ScheduleExpression` – UTF-8 字符串。

  用于指定计划的 `cron` 表达式 (请参阅[用于作业和爬网程序的基于时间的计划](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html)）。例如，要每天 12:15 UTC 运行某些任务，您应该指定：`cron(15 12 * * ? *)`。
+ `State` – UTF-8 字符串（有效值：`SCHEDULED` \$1`NOT_SCHEDULED` \$1`TRANSITIONING` ）。

  计划的状态。

## CrawlerTargets 结构
<a name="aws-glue-api-crawler-crawling-CrawlerTargets"></a>

指定要爬网的数据存储。

**Fields**
+ `S3Targets` – [S3Target](#aws-glue-api-crawler-crawling-S3Target) 对象的数组。

  指定 Amazon Simple Storage Service（Amazon S3）目标。
+ `JdbcTargets` – [JdbcTarget](#aws-glue-api-crawler-crawling-JdbcTarget) 对象的数组。

  指定 JDBC 目标。
+ `MongoDBTargets` – [MongoDBTarget](#aws-glue-api-crawler-crawling-MongoDBTarget) 对象的数组。

  指定 Amazon DocumentDB 或 MongoDB 目标。
+ `DynamoDBTargets` – [DynamoDBTarget](#aws-glue-api-crawler-crawling-DynamoDBTarget) 对象的数组。

  指定 Amazon DynamoDB 目标。
+ `CatalogTargets` – [CatalogTarget](#aws-glue-api-crawler-crawling-CatalogTarget) 对象的数组。

  指定 AWS Glue Data Catalog 目标。
+ `DeltaTargets` – [DeltaTarget](#aws-glue-api-crawler-crawling-DeltaTarget) 对象的数组。

  指定 Delta 数据存储目标。
+ `IcebergTargets` – [IcebergTarget](#aws-glue-api-crawler-crawling-IcebergTarget) 对象的数组。

  指定 Apache Iceberg 数据存储目标。
+ `HudiTargets` – [HudiTarget](#aws-glue-api-crawler-crawling-HudiTarget) 对象的数组。

  指定 Apache Hudi 数据存储目标。

## S3Target 结构
<a name="aws-glue-api-crawler-crawling-S3Target"></a>

指定 Amazon Simple Storage Service（Amazon S3）中的数据存储。

**Fields**
+ `Path` – UTF-8 字符串。

  Amazon S3 目标的路径。
+ `Exclusions` – UTF-8 字符串数组。

  要从爬网中排除的 glob 模式的列表。有关更多信息，请参阅[使用爬网程序为表编制目录](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html)。
+ `ConnectionName`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  允许作业或爬网程序在 Amazon Virtual Private Cloud（Amazon VPC）内访问 Amazon S3 中的数据的连接名称。
+ `SampleSize` – 数字（整数）。

  设置网络爬取数据集中的示例文件时，每个叶文件夹中要网络爬取的文件数。如果未设置，则会网络爬取所有文件。有效值是介于 1 到 249 之间的整数。
+ `EventQueueArn` – UTF-8 字符串。

  有效的 Amazon SQS ARN。例如 `arn:aws:sqs:region:account:sqs`。
+ `DlqEventQueueArn` – UTF-8 字符串。

  有效的 Amazon 死信 SQS ARN。例如 `arn:aws:sqs:region:account:deadLetterQueue`。

## S3DeltaCatalogTarget 结构
<a name="aws-glue-api-crawler-crawling-S3DeltaCatalogTarget"></a>

在 AWS Glue Data Catalog 中指定写入 Delta Lake 数据来源的目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为数据目标输入的节点。
+ `PartitionKeys` – UTF-8 字符串数组。

  使用一系列键指定本机分区。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要写入的数据库中的表的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要向其写入的数据库的名称。
+ `AdditionalOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定用于连接器的其他连接选项。
+ `SchemaChangePolicy` – 一个 [CatalogSchemaChangePolicy](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CatalogSchemaChangePolicy) 对象。

  一项指定爬网程序的更新行为的策略。
+ `AutoDataQuality` – 一个 [AutoDataQuality](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AutoDataQuality) 对象。

  指定是否为 S3 Delta 目录目标自动启用数据质量评估。设置为 `true` 时，则在写入操作期间自动执行数据质量检查。
+ `OutputSchemas` – [GlueSchema](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 S3 Delta 目录目标的数据架构。

## S3DeltaDirectTarget 结构
<a name="aws-glue-api-crawler-crawling-S3DeltaDirectTarget"></a>

在 Amazon S3 中指定写入 Delta Lake 数据来源的目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为数据目标输入的节点。
+ `PartitionKeys` – UTF-8 字符串数组。

  使用一系列键指定本机分区。
+ `Path` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要写入的 Delta Lake 数据来源的 Amazon S3 路径。
+ `Compression` – *必填：*UTF-8 字符串（有效值：`uncompressed="UNCOMPRESSED"` \$1 `snappy="SNAPPY"`）。

  指定数据压缩方式。通常，如果数据有标准文件扩展名，则不需要指定。可能的值为 `"gzip"` 和 `"bzip"`。
+ `NumberTargetPartitions` – UTF-8 字符串。

  指定在 Amazon S3 上分发 Delta Lake 数据集文件的目标分区数。
+ `Format` – *必填：*UTF-8 字符串（有效值：`json="JSON"` \$1 `csv="CSV"` \$1 `avro="AVRO"` \$1 `orc="ORC"` \$1 `parquet="PARQUET"` \$1 `hudi="HUDI"` \$1 `delta="DELTA"` \$1 `iceberg="ICEBERG"` \$1 `hyper="HYPER"` \$1 `xml="XML"`）。

  指定目标的数据输出格式。
+ `AdditionalOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定用于连接器的其他连接选项。
+ `SchemaChangePolicy` – 一个 [DirectSchemaChangePolicy](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-DirectSchemaChangePolicy) 对象。

  一项指定爬网程序的更新行为的策略。
+ `AutoDataQuality` – 一个 [AutoDataQuality](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-AutoDataQuality) 对象。

  指定是否为 S3 Delta 直接目标自动启用数据质量评估。设置为 `true` 时，则在写入操作期间自动执行数据质量检查。

## JdbcTarget 结构
<a name="aws-glue-api-crawler-crawling-JdbcTarget"></a>

指定要爬网的 JDBC 数据存储。

**Fields**
+ `ConnectionName`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  要用于连接到 JDBC 目标的连接的名称。
+ `Path` – UTF-8 字符串。

  JDBC 目标的路径。
+ `Exclusions` – UTF-8 字符串数组。

  要从爬网中排除的 glob 模式的列表。有关更多信息，请参阅[使用爬网程序为表编制目录](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html)。
+ `EnableAdditionalMetadata` – UTF-8 字符串数组。

  将值指定为 `RAWTYPES` 或 `COMMENTS`，以在表响应中启用其他元数据。`RAWTYPES` 提供原生级别的数据类型。`COMMENTS` 提供与数据库中的列或表相关的注释。

  如果您不需要其他元数据，请将该字段留空。

## MongoDBTarget 结构
<a name="aws-glue-api-crawler-crawling-MongoDBTarget"></a>

指定要网络爬取的 Amazon DocumentDB 或 MongoDB 数据存储。

**Fields**
+ `ConnectionName`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  要用于连接到 Amazon DocumentDB 或 MongoDB 目标的连接名称。
+ `Path` – UTF-8 字符串。

  Amazon DocumentDB 或 MongoDB 目标（数据库/集合）的路径。
+ `ScanAll` – 布尔值。

  指示是扫描所有记录，还是对表中的行进行采样。当表不是高吞吐量表时，扫描所有记录会花费很长时间。

  值为 `true` 表示扫描所有记录，值为 `false` 表示对记录进行采样。如果未指定任何值，则该值默认为 `true`。

## DynamoDBTarget 结构
<a name="aws-glue-api-crawler-crawling-DynamoDBTarget"></a>

指定 Amazon DynamoDB 表以爬网。

**Fields**
+ `Path` – UTF-8 字符串。

  要爬网的 DynamoDB 表的名称。
+ `scanAll` – 布尔值。

  指示是扫描所有记录，还是对表中的行进行采样。当表不是高吞吐量表时，扫描所有记录会花费很长时间。

  值为 `true` 表示扫描所有记录，值为 `false` 表示对记录进行采样。如果未指定任何值，则该值默认为 `true`。
+ `scanRate` – 数字（double）。

  AWS Glue 爬网程序使用的已配置读取容量单位的百分比。读取容量单位是一个由 DynamoDB 定义的术语，它是一个数值，用作每秒可对表执行的读取次数的速率限制器。

  有效值为空或一个介于 0.1 和 1.5 之间的值。当用户未提供值时，使用空值，该值默认为已配置的读取容量单位的 1/2（对于预配置的表）或配置的最大读取容量单位的 1/4（对于使用按需模式的表）。

## DeltaTarget 结构
<a name="aws-glue-api-crawler-crawling-DeltaTarget"></a>

指定 Delta 数据存储，爬取一个或多个 Delta 表。

**Fields**
+ `DeltaTables` – UTF-8 字符串数组。

  指向 Delta 表的 Amazon S3 路径列表。
+ `ConnectionName`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  要用于连接到 Delta 表目标的连接名称。
+ `WriteManifest` – 布尔值。

  指定是否将清单文件写入 Delta 表路径。
+ `CreateNativeDeltaTable` – 布尔值。

  指定爬网程序是否将创建原生表，以允许与支持直接查询 Delta 事务日志的查询引擎集成。

## IcebergTarget 结构
<a name="aws-glue-api-crawler-crawling-IcebergTarget"></a>

指定 Amazon S3 中存储 Iceberg 表的 Apache Iceberg 数据来源。

**Fields**
+ `Paths` – UTF-8 字符串数组。

  一个或多个 Amazon S3 路径，其中包含作为 `s3://bucket/prefix` 的 Iceberg 元数据文件夹。
+ `ConnectionName`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  要用于连接到 Iceberg 目标的连接的名称。
+ `Exclusions` – UTF-8 字符串数组。

  要从爬网中排除的 glob 模式的列表。有关更多信息，请参阅[使用爬网程序为表编制目录](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html)。
+ `MaximumTraversalDepth` – 数字（整数）。

  爬网程序可以遍历的最大 Amazon S3 路径深度，以发现 Amazon S3 路径中的 Iceberg 元数据文件夹。用于限制爬网程序运行时间。

## HudiTarget 结构
<a name="aws-glue-api-crawler-crawling-HudiTarget"></a>

指定 Apache Hudi 数据来源。

**Fields**
+ `Paths` – UTF-8 字符串数组。

  Hudi 的 Amazon S3 位置字符串数组，每个位置字符串都指示 Hudi 表的元数据文件所在的根文件夹。Hudi 文件夹可能位于根文件夹的子文件夹中。

  爬网程序将扫描路径下的所有文件夹，寻找 Hudi 文件夹。
+ `ConnectionName`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  要用于连接到 Hudi 目标的连接的名称。如果您的 Hudi 文件存储在需要 VPC 授权的存储桶中，则可以在此处设置其连接属性。
+ `Exclusions` – UTF-8 字符串数组。

  要从爬网中排除的 glob 模式的列表。有关更多信息，请参阅[使用爬网程序为表编制目录](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html)。
+ `MaximumTraversalDepth` – 数字（整数）。

  爬网程序可以遍历的最大 Amazon S3 路径深度，以发现 Amazon S3 路径中的 Hudi 元数据文件夹。用于限制爬网程序运行时间。

## CatalogTarget 结构
<a name="aws-glue-api-crawler-crawling-CatalogTarget"></a>

指定 AWS Glue Data Catalog 目标。

**Fields**
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要同步的数据库的名称。
+ `Tables` – *必填：*UTF-8 字符串数组，至少 1 个字符串。

  要同步的表的列表。
+ `ConnectionName`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  当使用与 `Catalog` 连接类型配对的 `NETWORK` 连接类型时，作为网络爬取目标的 Amazon S3 支持的数据目录表的连接名称。
+ `EventQueueArn` – UTF-8 字符串。

  有效的 Amazon SQS ARN。例如 `arn:aws:sqs:region:account:sqs`。
+ `DlqEventQueueArn` – UTF-8 字符串。

  有效的 Amazon 死信 SQS ARN。例如 `arn:aws:sqs:region:account:deadLetterQueue`。

## CrawlerMetrics 结构
<a name="aws-glue-api-crawler-crawling-CrawlerMetrics"></a>

指定爬网程序的指标。

**Fields**
+ `CrawlerName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  爬网程序的名称。
+ `TimeLeftSeconds` – 数字（双数），至多为“无”。

  完成正在运行的爬网的估计剩余时间。
+ `StillEstimating` – 布尔值。

  如果爬网程序仍在估算完成此运行所需的时长，则为 True。
+ `LastRuntimeSeconds` – 数字（双数），至多为“无”。

  爬网程序的最近一次运行的持续时间 (秒)。
+ `MedianRuntimeSeconds` – 数字（双数），至多为“无”。

  此爬网程序的运行的持续时间中值 (秒)。
+ `TablesCreated` – 数字（整数），至多为“无”。

  此爬网程序创建的表的数量。
+ `TablesUpdated` – 数字（整数），至多为“无”。

  此爬网程序更新的表的数量。
+ `TablesDeleted` – 数字（整数），至多为“无”。

  此爬网程序删除的表的数量。

## CrawlerHistory 结构
<a name="aws-glue-api-crawler-crawling-CrawlerHistory"></a>

包含有关运行爬网程序的信息。

**Fields**
+ `CrawlId` – UTF-8 字符串。

  每个爬取的 UUID 标识符。
+ `State` – UTF-8 字符串（有效值：`RUNNING` \$1`COMPLETED` \$1`FAILED` \$1`STOPPED` ）。

  爬网的状态。
+ `StartTime` – 时间戳。

  爬网操作的开始日期和时间。
+ `EndTime` – 时间戳。

  爬网操作的结束日期和时间。
+ `Summary` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  JSON 中特定爬取的运行摘要。包含已添加、更新或删除的目录表和分区。
+ `ErrorMessage` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  如果发生错误，则为与爬网关联的错误消息。
+ `LogGroup` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节，与 [Log group string pattern](aws-glue-api-common.md#aws-glue-api-regex-logGroup-id) 匹配。

  与爬网关联的日志组。
+ `LogStream` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节，与 [Log-stream string pattern](aws-glue-api-common.md#aws-glue-api-regex-logStream-id) 匹配。

  与爬网关联的日志流。
+ `MessagePrefix` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  有关此爬网的 CloudWatch 消息的前缀。
+ `DPUHour` – 数字（双数），至多为“无”。

  用于爬取的数据处理单元（DPU）的数量（以小时为单位）。

## CrawlsFilter 结构
<a name="aws-glue-api-crawler-crawling-CrawlsFilter"></a>

可用于筛选指定爬网程序的爬网程序运行的字段、比较运算符和值的列表。

**Fields**
+ `FieldName` – UTF-8 字符串（有效值：`CRAWL_ID` \$1`STATE` \$1`START_TIME` \$1`END_TIME` \$1`DPU_HOUR` ）。

  用于筛选指定爬网程序的爬网程序运行的键。每个字段名称的有效值为：
  + `CRAWL_ID`：表示爬取的 UUID 标识符的字符串。
  + `STATE`：表示爬取状态的字符串。
  + `START_TIME` 和 `END_TIME`：纪元时间戳（以毫秒为单位）。
  + `DPU_HOUR`：用于爬网的数据处理单元（DPU）的数量（以小时为单位）。
+ `FilterOperator` – UTF-8 字符串（有效值：`GT` \$1`GE` \$1`LT` \$1`LE` \$1`EQ` \$1`NE` ）。

  对值进行操作的已定义比较运算符。可用的运算符有：
  + `GT`：大于。
  + `GE`：大于或等于。
  + `LT`：小于。
  + `LE`：小于或等于。
  + `EQ`：等于。
  + `NE`：不等于。
+ `FieldValue` – UTF-8 字符串。

  为在爬取字段上进行比较而提供的值。

## SchemaChangePolicy 结构
<a name="aws-glue-api-crawler-crawling-SchemaChangePolicy"></a>

一项指定爬网程序的更新和删除行为的策略。

**Fields**
+ `UpdateBehavior` – UTF-8 字符串（有效值：`LOG` \$1`UPDATE_IN_DATABASE` ）。

  爬网程序发现已更改的架构时的更新行为。
+ `DeleteBehavior` – UTF-8 字符串（有效值：`LOG` \$1`DELETE_FROM_DATABASE` \$1`DEPRECATE_IN_DATABASE` ）。

  爬网程序发现已删除的对象时的删除行为。

## LastCrawlInfo 结构
<a name="aws-glue-api-crawler-crawling-LastCrawlInfo"></a>

有关最近一次爬网的状态和错误信息。

**Fields**
+ `Status` – UTF-8 字符串（有效值：`SUCCEEDED` \$1`CANCELLED` \$1`FAILED` ）。

  上次爬网的状态。
+ `ErrorMessage` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  如果出现错误，则为有关上次爬网的错误信息。
+ `LogGroup` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节，与 [Log group string pattern](aws-glue-api-common.md#aws-glue-api-regex-logGroup-id) 匹配。

  上次爬网的日志组。
+ `LogStream` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节，与 [Log-stream string pattern](aws-glue-api-common.md#aws-glue-api-regex-logStream-id) 匹配。

  上次爬网的日志流。
+ `MessagePrefix` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  有关此爬网的消息的前缀。
+ `StartTime` – 时间戳。

  爬网开始的时间。

## RecrawlPolicy 结构
<a name="aws-glue-api-crawler-crawling-RecrawlPolicy"></a>

在第一次网络爬取完成后对 Amazon S3 数据源进行网络爬取时，请指定是再次网络爬取整个数据集还是仅网络爬取自上次爬网程序运行以来添加的文件夹。有关更多信息，请参阅开发人员指南中的 [AWS Glue 中的增量爬网](https://docs.aws.amazon.com/glue/latest/dg/incremental-crawls.html)。

**Fields**
+ `RecrawlBehavior` – UTF-8 字符串（有效值：`CRAWL_EVERYTHING` \$1`CRAWL_NEW_FOLDERS_ONLY` \$1`CRAWL_EVENT_MODE` ）。

  指定是否再次网络爬取整个数据集还是仅网络爬取自上次爬网程序运行以来添加的文件夹。

  值 `CRAWL_EVERYTHING` 指定再次网络爬取整个数据集。

  值 `CRAWL_NEW_FOLDERS_ONLY` 指定仅网络爬取自上次爬网程序运行以来添加的文件夹。

  `CRAWL_EVENT_MODE` 的值指定只网络爬取由 Amazon S3 事件标识的更改。

## LineageConfiguration 结构
<a name="aws-glue-api-crawler-crawling-LineageConfiguration"></a>

指定爬网程序的数据系统配置设置。

**Fields**
+ `CrawlerLineageSettings` – UTF-8 字符串（有效值：`ENABLE` \$1`DISABLE` ）。

  指定是否已为爬网程序启用数据关联。有效值为：
  + ENABLE：启用爬网程序的数据关联
  + DISABLE：禁用爬网程序的数据关联

## LakeFormationConfiguration 结构
<a name="aws-glue-api-crawler-crawling-LakeFormationConfiguration"></a>

指定爬网程序的 AWS Lake Formation 配置设置。

**Fields**
+ `UseLakeFormationCredentials` – 布尔值。

  指定是否应使用爬网程序的 AWS Lake Formation 凭证来替代 IAM 角色凭证。
+ `AccountId` – UTF-8 字符串，长度不超过 12 个字节。

  对于跨账户爬取是必需的。如果是与目标数据相同的账户爬取，可以将其保留为空。

## 操作
<a name="aws-glue-api-crawler-crawling-actions"></a>
+ [CreateCrawler 操作（Python：create\$1crawler）](#aws-glue-api-crawler-crawling-CreateCrawler)
+ [DeleteCrawler 操作（Python：delete\$1crawler）](#aws-glue-api-crawler-crawling-DeleteCrawler)
+ [GetCrawler 操作（Python：get\$1crawler）](#aws-glue-api-crawler-crawling-GetCrawler)
+ [GetCrawlers 操作（Python：get\$1crawlers）](#aws-glue-api-crawler-crawling-GetCrawlers)
+ [GetCrawlerMetrics 操作（Python：get\$1crawler\$1metrics）](#aws-glue-api-crawler-crawling-GetCrawlerMetrics)
+ [UpdateCrawler 操作（Python：update\$1crawler）](#aws-glue-api-crawler-crawling-UpdateCrawler)
+ [StartCrawler 操作（Python：start\$1crawler）](#aws-glue-api-crawler-crawling-StartCrawler)
+ [StopCrawler 操作（Python：stop\$1crawler）](#aws-glue-api-crawler-crawling-StopCrawler)
+ [BatchGetCrawlers 操作（Python：batch\$1get\$1crawlers）](#aws-glue-api-crawler-crawling-BatchGetCrawlers)
+ [ListCrawlers 操作（Python：list\$1crawlers）](#aws-glue-api-crawler-crawling-ListCrawlers)
+ [ListCrawls 操作（Python：list\$1crawls）](#aws-glue-api-crawler-crawling-ListCrawls)

## CreateCrawler 操作（Python：create\$1crawler）
<a name="aws-glue-api-crawler-crawling-CreateCrawler"></a>

使用指定的目标、角色、配置和可选计划创建新的爬网程序。必须指定至少一个爬网目标（在 `s3Targets` 字段、`jdbcTargets` 字段或 `DynamoDBTargets` 字段中）。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  新爬网程序的名称。
+ `Role` – *必填：*UTF-8 字符串。

  新爬网程序用来访问客户资源的 IAM 角色或 IAM 角色的 Amazon Resource Name (ARN)。
+ `DatabaseName` – UTF-8 字符串。

  在其中写入结果的 AWS Glue 数据库，例如：`arn:aws:daylight:us-east-1::database/sometable/*`。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  新爬网程序的描述。
+ `Targets` – *必填：*一个 [CrawlerTargets](#aws-glue-api-crawler-crawling-CrawlerTargets) 对象。

  要爬网的目标的集合列表。
+ `Schedule` – UTF-8 字符串。

  用于指定计划的 `cron` 表达式 (请参阅[用于作业和爬网程序的基于时间的计划](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html)）。例如，要每天 12:15 UTC 运行某些任务，您应该指定：`cron(15 12 * * ? *)`。
+ `Classifiers` – UTF-8 字符串数组。

  用户已注册的自定义分类器的列表。默认情况下，所有内置分类器均包含在爬网中，但这些自定义分类器始终会覆盖给定分类的默认分类器。
+ `TablePrefix` – UTF-8 字符串，长度不超过 128 个字节。

  用于创建的目录表的表前缀。
+ `SchemaChangePolicy` – 一个 [SchemaChangePolicy](#aws-glue-api-crawler-crawling-SchemaChangePolicy) 对象。

  适用于爬网程序的更新和删除行为的策略。
+ `RecrawlPolicy` – 一个 [RecrawlPolicy](#aws-glue-api-crawler-crawling-RecrawlPolicy) 对象。

  指定是否再次网络爬取整个数据集，还是仅网络爬取自上次爬网程序运行以来添加的文件夹的策略。
+ `LineageConfiguration` – 一个 [LineageConfiguration](#aws-glue-api-crawler-crawling-LineageConfiguration) 对象。

  指定爬网程序的数据系统配置设置。
+ `LakeFormationConfiguration` – 一个 [LakeFormationConfiguration](#aws-glue-api-crawler-crawling-LakeFormationConfiguration) 对象。

  指定爬网程序的 AWS Lake Formation 配置设置。
+ `Configuration` – UTF-8 字符串。

  爬网程序配置信息。此受版本控制的 JSON 字符串允许用户指定爬网程序的行为的各个方面。有关更多信息，请参阅[设置爬网程序配置选项](https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html)。
+ `CrawlerSecurityConfiguration` – UTF-8 字符串，长度不超过 128 个字节。

  该爬网程序将使用的 `SecurityConfiguration` 结构的名称。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  要用于此爬网程序请求的标签。您可以使用标签来限制对爬网程序的访问。有关 AWS Glue 中的标签的更多信息，请参阅开发人员指南中的 [AWS Glue 中的 AWS 标签](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html)。

**响应**
+ *无响应参数。*

**错误**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`

## DeleteCrawler 操作（Python：delete\$1crawler）
<a name="aws-glue-api-crawler-crawling-DeleteCrawler"></a>

从 AWS Glue Data Catalog中删除指定爬网程序，除非爬网程序状态为 `RUNNING`。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的爬网程序的名称。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `CrawlerRunningException`
+ `SchedulerTransitioningException`
+ `OperationTimeoutException`

## GetCrawler 操作（Python：get\$1crawler）
<a name="aws-glue-api-crawler-crawling-GetCrawler"></a>

检索指定爬网程序的元数据。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索其元数据的爬网程序的名称。

**响应**
+ `Crawler` – 一个 [爬网程序](#aws-glue-api-crawler-crawling-Crawler) 对象。

  指定爬网程序的元数据。

**错误**
+ `EntityNotFoundException`
+ `OperationTimeoutException`

## GetCrawlers 操作（Python：get\$1crawlers）
<a name="aws-glue-api-crawler-crawling-GetCrawlers"></a>

检索在客户账户中定义的所有爬网程序的元数据。

**请求**
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  每次调用时要返回的爬网程序的数量。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果这是延续请求)。

**响应**
+ `Crawlers` – [爬网程序](#aws-glue-api-crawler-crawling-Crawler) 对象的数组。

  爬网程序元数据的列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果返回的列表未到达此客户账户中定义的令牌的结尾)。

**错误**
+ `OperationTimeoutException`

## GetCrawlerMetrics 操作（Python：get\$1crawler\$1metrics）
<a name="aws-glue-api-crawler-crawling-GetCrawlerMetrics"></a>

检索有关指定爬网程序的指标。

**请求**
+ `CrawlerNameList` – UTF-8 字符串数组，不超过 100 个字符串。

  有关要检索其指标的爬网程序的名称的列表。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的列表的最大大小。
+ `NextToken` – UTF-8 字符串。

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

**响应**
+ `CrawlerMetricsList` – [CrawlerMetrics](#aws-glue-api-crawler-crawling-CrawlerMetrics) 对象的数组。

  指定爬网程序的指标的列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果返回的列表不包含上一个可用的指标)。

**错误**
+ `OperationTimeoutException`

## UpdateCrawler 操作（Python：update\$1crawler）
<a name="aws-glue-api-crawler-crawling-UpdateCrawler"></a>

更新爬网程序。如果爬网程序正在运行，您必须在更新它之前使用 `StopCrawler` 停止它。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  新爬网程序的名称。
+ `Role` – UTF-8 字符串。

  新爬网程序用于访问客户资源的 IAM 角色或 IAM 角色的 Amazon Resource Name (ARN)。
+ `DatabaseName` – UTF-8 字符串。

  在其中存储结果的 AWS Glue 数据库，例如：`arn:aws:daylight:us-east-1::database/sometable/*`。
+ `Description` – UTF-8 字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  新爬网程序的描述。
+ `Targets` – 一个 [CrawlerTargets](#aws-glue-api-crawler-crawling-CrawlerTargets) 对象。

  要爬网的目标的列表。
+ `Schedule` – UTF-8 字符串。

  用于指定计划的 `cron` 表达式 (请参阅[用于作业和爬网程序的基于时间的计划](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html)）。例如，要每天 12:15 UTC 运行某些任务，您应该指定：`cron(15 12 * * ? *)`。
+ `Classifiers` – UTF-8 字符串数组。

  用户已注册的自定义分类器的列表。默认情况下，所有内置分类器均包含在爬网中，但这些自定义分类器始终会覆盖给定分类的默认分类器。
+ `TablePrefix` – UTF-8 字符串，长度不超过 128 个字节。

  用于创建的目录表的表前缀。
+ `SchemaChangePolicy` – 一个 [SchemaChangePolicy](#aws-glue-api-crawler-crawling-SchemaChangePolicy) 对象。

  适用于爬网程序的更新和删除行为的策略。
+ `RecrawlPolicy` – 一个 [RecrawlPolicy](#aws-glue-api-crawler-crawling-RecrawlPolicy) 对象。

  指定是否再次网络爬取整个数据集，还是仅网络爬取自上次爬网程序运行以来添加的文件夹的策略。
+ `LineageConfiguration` – 一个 [LineageConfiguration](#aws-glue-api-crawler-crawling-LineageConfiguration) 对象。

  指定爬网程序的数据系统配置设置。
+ `LakeFormationConfiguration` – 一个 [LakeFormationConfiguration](#aws-glue-api-crawler-crawling-LakeFormationConfiguration) 对象。

  指定爬网程序的 AWS Lake Formation 配置设置。
+ `Configuration` – UTF-8 字符串。

  爬网程序配置信息。此受版本控制的 JSON 字符串允许用户指定爬网程序的行为的各个方面。有关更多信息，请参阅[设置爬网程序配置选项](https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html)。
+ `CrawlerSecurityConfiguration` – UTF-8 字符串，长度不超过 128 个字节。

  该爬网程序将使用的 `SecurityConfiguration` 结构的名称。

**响应**
+ *无响应参数。*

**错误**
+ `InvalidInputException`
+ `VersionMismatchException`
+ `EntityNotFoundException`
+ `CrawlerRunningException`
+ `OperationTimeoutException`

## StartCrawler 操作（Python：start\$1crawler）
<a name="aws-glue-api-crawler-crawling-StartCrawler"></a>

使用指定爬网程序启动爬网，无论计划了什么。如果爬网程序已在运行，则返回 [CrawlerRunningException](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-exceptions.html#aws-glue-api-exceptions-CrawlerRunningException)。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要启动的爬网程序的名称。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `CrawlerRunningException`
+ `OperationTimeoutException`

## StopCrawler 操作（Python：stop\$1crawler）
<a name="aws-glue-api-crawler-crawling-StopCrawler"></a>

如果指定爬网程序正在运行，请停止爬网。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要停止的爬网程序的名称。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `CrawlerNotRunningException`
+ `CrawlerStoppingException`
+ `OperationTimeoutException`

## BatchGetCrawlers 操作（Python：batch\$1get\$1crawlers）
<a name="aws-glue-api-crawler-crawling-BatchGetCrawlers"></a>

返回给定爬网程序名称列表的资源元数据的列表。调用 `ListCrawlers` 操作后，您可以调用此操作来访问您有权访问的数据。此操作支持所有 IAM 权限，包括使用标签的权限条件。

**请求**
+ `CrawlerNames` – *必填：*UTF-8 字符串数组，不超过 100 个字符串。

  爬网程序名称列表，这些名称可能是通过 `ListCrawlers` 操作返回的名称。

**响应**
+ `Crawlers` – [爬网程序](#aws-glue-api-crawler-crawling-Crawler) 对象的数组。

  爬网程序定义的列表。
+ `CrawlersNotFound` – UTF-8 字符串数组，不超过 100 个字符串。

  未找到的 Crawler 名称的列表。

**错误**
+ `InvalidInputException`
+ `OperationTimeoutException`

## ListCrawlers 操作（Python：list\$1crawlers）
<a name="aws-glue-api-crawler-crawling-ListCrawlers"></a>

检索此 AWS 账户中所有爬网程序资源的名称或带指定标签的资源。此操作可让您查看您账户中可用的资源及其名称。

此操作采用可选的 `Tags` 字段，您可以将其用作响应的筛选器，以便将标记的资源作为一个组进行检索。如果您选择使用标签筛选，则仅检索带标签的资源。

**请求**
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的列表的最大大小。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果这是延续请求)。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  指定仅返回这些已标记的资源。

**响应**
+ `CrawlerNames` – UTF-8 字符串数组，不超过 100 个字符串。

  账户中所有爬网程序的名称或带指定标签的爬网程序。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果返回的列表不包含上一个可用的指标)。

**错误**
+ `OperationTimeoutException`

## ListCrawls 操作（Python：list\$1crawls）
<a name="aws-glue-api-crawler-crawling-ListCrawls"></a>

返回指定爬网程序的所有爬取结果。仅返回自爬网程序历史记录功能启动之日起发生的爬网操作，最多只能保留 12 个月的爬取结果。较早的爬取结果将不会被返回。

您可以使用此 API 执行以下操作：
+ 检索指定爬网程序的所有爬网。
+ 在有限的计数内检索指定爬网程序的所有爬取结果。
+ 检索指定爬网程序在特定时间范围内的所有爬取结果。
+ 检索具有特定状态、爬网 ID 或 DPU 小时值的指定爬网程序的所有爬取结果。

**请求**
+ `CrawlerName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索其运行的爬网程序的名称。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的最大结果数量。默认值为 20，最大值为 100。
+ `Filters` – [CrawlsFilter](#aws-glue-api-crawler-crawling-CrawlsFilter) 对象的数组。

  按照您在 `CrawlsFilter` 对象列表中指定的标准筛选爬取结果。
+ `NextToken` – UTF-8 字符串。

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

**响应**
+ `Crawls` – [CrawlerHistory](#aws-glue-api-crawler-crawling-CrawlerHistory) 对象的数组。

  代表符合您的标准的爬取运行的 `CrawlerHistory` 对象列表。
+ `NextToken` – UTF-8 字符串。

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

**错误**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`

# 列统计数据 API
<a name="aws-glue-api-crawler-column-statistics"></a>

列统计数据 API 介绍了用于返回表中各列统计数据的 AWS Glue API。

## 数据类型
<a name="aws-glue-api-crawler-column-statistics-objects"></a>
+ [ColumnStatisticsTaskRun 结构](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRun)
+ [ColumnStatisticsTaskSettings 结构](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskSettings)
+ [ExecutionAttempt 结构](#aws-glue-api-crawler-column-statistics-ExecutionAttempt)

## ColumnStatisticsTaskRun 结构
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRun"></a>

显示列统计数据运行详细信息的对象。

**字段**
+ `CustomerId` – UTF-8 字符串，长度不超过 12 个字节。

  AWS 账户 ID。
+ `ColumnStatisticsTaskRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  特定列统计数据任务运行的标识符。
+ `DatabaseName` – UTF-8 字符串。

  表所在的数据库。
+ `TableName` – UTF-8 字符串。

  生成列统计数据的表的名称。
+ `ColumnNameList` – UTF-8 字符串数组。

  列名称的列表。如果不提供此参数，则默认情况下将使用表的所有列名。
+ `CatalogID` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `Role` – UTF-8 字符串。

  服务为了生成统计数据而代入的 IAM 角色。
+ `SampleSize` – 数值（双精度），不超过 100。

  用于生成统计数据的行百分比。如果不提供此参数，则将用整个表来生成统计数据。
+ `SecurityConfiguration` – UTF-8 字符串，长度不超过 128 个字节。

  用于为列统计数据任务运行的 CloudWatch 日志加密的安全配置的名称。
+ `NumberOfWorkers` - 数字（整数），至少为 1。

  生成列统计数据的 Worker 线程数。此作业已预先配置为可自动扩展至不超过 25 个实例。
+ `WorkerType` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于生成统计数据的 Worker 线程类型。默认值为 `g.1x`。
+ `ComputationType` – UTF-8 字符串（有效值：`FULL` \$1 `INCREMENTAL`）。

  列统计数据计算的类型。
+ `Status` – UTF-8 字符串（有效值：`STARTING` \$1 `RUNNING` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `STOPPED`）。

  任务运行的状态。
+ `CreationTime` – 时间戳。

  此任务的创建时间。
+ `LastUpdated` – 时间戳。

  上次修改此任务的时间点。
+ `StartTime` – 时间戳。

  任务的开始时间。
+ `EndTime` – 时间戳。

  任务的结束时间。
+ `ErrorMessage` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  作业的错误消息。
+ `DPUSeconds` – 数字（双数），至多为“无”。

  所有自动扩展的 Worker 线程的计算 DPU 使用量（以秒为单位）。

## ColumnStatisticsTaskSettings 结构
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskSettings"></a>

列统计数据任务的设置。

**字段**
+ `DatabaseName` – UTF-8 字符串。

  表所在的数据库的名称。
+ `TableName` – UTF-8 字符串。

  要生成列统计数据的表的名称。
+ `Schedule` – 一个 [计划](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-Schedule) 对象。

  运行列统计数据的计划，以 CRON 语法指定。
+ `ColumnNameList` – UTF-8 字符串数组。

  要运行统计数据的列名称的列表。
+ `CatalogID` – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据库所在的数据目录的 ID。
+ `Role` – UTF-8 字符串。

  用于运行列统计数据的角色。
+ `SampleSize` – 数值（双精度），不超过 100。

  要采样的数据的百分比。
+ `SecurityConfiguration` – UTF-8 字符串，长度不超过 128 个字节。

  用于加密 CloudWatch 日志的安全配置的名称。
+ `ScheduleType` – UTF-8 字符串（有效值：`CRON` \$1 `AUTO`）。

  列统计数据任务的计划类型。可能的值可能为 `CRON` 或 `AUTO`。
+ `SettingSource` – UTF-8 字符串（有效值：`CATALOG` \$1 `TABLE`）。

  列统计数据任务的设置来源。可能的值可能为 `CATALOG` 或 `TABLE`。
+ `LastExecutionAttempt` – 一个 [ExecutionAttempt](#aws-glue-api-crawler-column-statistics-ExecutionAttempt) 对象。

  列统计数据任务运行的最后一个 `ExecutionAttempt`。

## ExecutionAttempt 结构
<a name="aws-glue-api-crawler-column-statistics-ExecutionAttempt"></a>

列统计数据任务运行的运行尝试。

**字段**
+ `Status` – UTF-8 字符串（有效值：`FAILED` \$1 `STARTED`）。

  最后一个列统计数据任务运行的状态。
+ `ColumnStatisticsTaskRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  最后一个列统计数据任务运行的任务运行 ID。
+ `ExecutionTimestamp` – 时间戳。

  最后一个列统计数据任务运行发生的时间戳。
+ `ErrorMessage` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  与最后一个列统计数据任务运行关联的错误消息。

## 操作
<a name="aws-glue-api-crawler-column-statistics-actions"></a>
+ [StartColumnStatisticsTaskRun 操作（Python：start\$1column\$1statistics\$1task\$1run）](#aws-glue-api-crawler-column-statistics-StartColumnStatisticsTaskRun)
+ [GetColumnStatisticsTaskRun 操作（Python：get\$1column\$1statistics\$1task\$1run）](#aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskRun)
+ [GetColumnStatisticsTaskRuns 操作（Python：get\$1column\$1statistics\$1task\$1runs）](#aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskRuns)
+ [ListColumnStatisticsTaskRuns 操作（Python：list\$1column\$1statistics\$1task\$1runs）](#aws-glue-api-crawler-column-statistics-ListColumnStatisticsTaskRuns)
+ [StopColumnStatisticsTaskRun 操作（Python：stop\$1column\$1statistics\$1task\$1run）](#aws-glue-api-crawler-column-statistics-StopColumnStatisticsTaskRun)
+ [CreateColumnStatisticsTaskSettings 操作（Python：create\$1column\$1statistics\$1task\$1settings）](#aws-glue-api-crawler-column-statistics-CreateColumnStatisticsTaskSettings)
+ [UpdateColumnStatisticsTaskSettings 操作（Python：update\$1column\$1statistics\$1task\$1settings）](#aws-glue-api-crawler-column-statistics-UpdateColumnStatisticsTaskSettings)
+ [GetColumnStatisticsTaskSettings 操作（Python：get\$1column\$1statistics\$1task\$1settings）](#aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskSettings)
+ [DeleteColumnStatisticsTaskSettings 操作（Python：delete\$1column\$1statistics\$1task\$1settings）](#aws-glue-api-crawler-column-statistics-DeleteColumnStatisticsTaskSettings)
+ [StartColumnStatisticsTaskRunSchedule 操作（Python：start\$1column\$1statistics\$1task\$1run\$1schedule）](#aws-glue-api-crawler-column-statistics-StartColumnStatisticsTaskRunSchedule)
+ [StopColumnStatisticsTaskRunSchedule 操作（Python：stop\$1column\$1statistics\$1task\$1run\$1schedule）](#aws-glue-api-crawler-column-statistics-StopColumnStatisticsTaskRunSchedule)

## StartColumnStatisticsTaskRun 操作（Python：start\$1column\$1statistics\$1task\$1run）
<a name="aws-glue-api-crawler-column-statistics-StartColumnStatisticsTaskRun"></a>

为指定的表和列启动列统计数据任务运行。

**请求**
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要生成统计数据的表的名称。
+ `ColumnNameList` – UTF-8 字符串数组。

  生成统计数据的列名列表。如果不提供此参数，则默认情况下将使用表的所有列名。
+ `Role` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  服务为了生成统计数据而代入的 IAM 角色。
+ `SampleSize` – 数值（双精度），不超过 100。

  用于生成统计数据的行百分比。如果不提供此参数，则将用整个表来生成统计数据。
+ `CatalogID` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据目录的 ID。如果没有提供，则默认情况下使用 AWS 账户 ID。
+ `SecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于为列统计数据任务运行的 CloudWatch 日志加密的安全配置的名称。

**响应**
+ `ColumnStatisticsTaskRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  列统计数据任务运行的标识符。

**错误**
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ColumnStatisticsTaskRunningException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `InvalidInputException`

## GetColumnStatisticsTaskRun 操作（Python：get\$1column\$1statistics\$1task\$1run）
<a name="aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskRun"></a>

在已知任务运行 ID 的情况下，获取任务运行的相关元数据/信息。

**请求**
+ `ColumnStatisticsTaskRunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  特定列统计数据任务运行的标识符。

**响应**
+ `ColumnStatisticsTaskRun` – 一个 [ColumnStatisticsTaskRun](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRun) 对象。

  表示列统计数据运行详细信息的 `ColumnStatisticsTaskRun` 对象。

**错误**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## GetColumnStatisticsTaskRuns 操作（Python：get\$1column\$1statistics\$1task\$1runs）
<a name="aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskRuns"></a>

检索与指定表关联的所有运行的信息。

**请求**
+ `DatabaseName` – *必填：*UTF-8 字符串。

  表所在的数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的名称。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  响应的最大大小。
+ `NextToken` – UTF-8 字符串。

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

**响应**
+ `ColumnStatisticsTaskRuns` – [ColumnStatisticsTaskRun](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRun) 对象的数组。

  列统计数据任务运行列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌（如果尚未返回所有任务运行）。

**错误**
+ `OperationTimeoutException`

## ListColumnStatisticsTaskRuns 操作（Python：list\$1column\$1statistics\$1task\$1runs）
<a name="aws-glue-api-crawler-column-statistics-ListColumnStatisticsTaskRuns"></a>

列出特定账户的所有任务运行。

**请求**
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  响应的最大大小。
+ `NextToken` – UTF-8 字符串。

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

**响应**
+ `ColumnStatisticsTaskRunIds` – UTF-8 字符串数组，不超过 100 个字符串。

  列统计数据任务运行 ID 列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌（如果尚未返回所有任务运行 ID）。

**错误**
+ `OperationTimeoutException`

## StopColumnStatisticsTaskRun 操作（Python：stop\$1column\$1statistics\$1task\$1run）
<a name="aws-glue-api-crawler-column-statistics-StopColumnStatisticsTaskRun"></a>

停止指定表的任务运行。

**请求**
+ `DatabaseName` – *必填：*UTF-8 字符串。

  表所在的数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表的名称。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `ColumnStatisticsTaskNotRunningException`
+ `ColumnStatisticsTaskStoppingException`
+ `OperationTimeoutException`

## CreateColumnStatisticsTaskSettings 操作（Python：create\$1column\$1statistics\$1task\$1settings）
<a name="aws-glue-api-crawler-column-statistics-CreateColumnStatisticsTaskSettings"></a>

为列统计数据任务创建设置。

**请求**
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要生成列统计数据的表的名称。
+ `Role` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于运行列统计数据的角色。
+ `Schedule` – UTF-8 字符串。

  运行列统计数据的计划，以 CRON 语法指定。
+ `ColumnNameList` – UTF-8 字符串数组。

  要运行统计数据的列名称的列表。
+ `SampleSize` – 数值（双精度），不超过 100。

  要采样的数据的百分比。
+ `CatalogID` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据库所在的数据目录的 ID。
+ `SecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于加密 CloudWatch 日志的安全配置的名称。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  标签的映射。

**响应**
+ *无响应参数。*

**错误**
+ `AlreadyExistsException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ColumnStatisticsTaskRunningException`

## UpdateColumnStatisticsTaskSettings 操作（Python：update\$1column\$1statistics\$1task\$1settings）
<a name="aws-glue-api-crawler-column-statistics-UpdateColumnStatisticsTaskSettings"></a>

更新列统计数据任务的设置。

**请求**
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要生成列统计数据的表的名称。
+ `Role` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于运行列统计数据的角色。
+ `Schedule` – UTF-8 字符串。

  运行列统计数据的计划，以 CRON 语法指定。
+ `ColumnNameList` – UTF-8 字符串数组。

  要运行统计数据的列名称的列表。
+ `SampleSize` – 数值（双精度），不超过 100。

  要采样的数据的百分比。
+ `CatalogID` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据库所在的数据目录的 ID。
+ `SecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于加密 CloudWatch 日志的安全配置的名称。

**响应**
+ *无响应参数。*

**错误**
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `VersionMismatchException`
+ `OperationTimeoutException`

## GetColumnStatisticsTaskSettings 操作（Python：get\$1column\$1statistics\$1task\$1settings）
<a name="aws-glue-api-crawler-column-statistics-GetColumnStatisticsTaskSettings"></a>

获取列统计数据任务的设置。

**请求**
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索列统计数据的表的名称。

**响应**
+ `ColumnStatisticsTaskSettings` – 一个 [ColumnStatisticsTaskSettings](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskSettings) 对象。

  表示列统计数据任务的设置的 `ColumnStatisticsTaskSettings` 对象。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## DeleteColumnStatisticsTaskSettings 操作（Python：delete\$1column\$1statistics\$1task\$1settings）
<a name="aws-glue-api-crawler-column-statistics-DeleteColumnStatisticsTaskSettings"></a>

删除列统计数据任务的设置。

**请求**
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除列统计数据的表的名称。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## StartColumnStatisticsTaskRunSchedule 操作（Python：start\$1column\$1statistics\$1task\$1run\$1schedule）
<a name="aws-glue-api-crawler-column-statistics-StartColumnStatisticsTaskRunSchedule"></a>

启动列统计数据任务运行计划。

**请求**
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要启动列统计数据任务运行计划的表的名称。

**响应**
+ *无响应参数。*

**错误**
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## StopColumnStatisticsTaskRunSchedule 操作（Python：stop\$1column\$1statistics\$1task\$1run\$1schedule）
<a name="aws-glue-api-crawler-column-statistics-StopColumnStatisticsTaskRunSchedule"></a>

停止列统计数据任务运行计划。

**请求**
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表所在的数据库的名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要停止列统计数据任务运行计划的表的名称。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## 异常
<a name="aws-glue-api-crawler-column-statistics-exceptions"></a>
+ [ColumnStatisticsTaskRunningException 结构](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRunningException)
+ [ColumnStatisticsTaskNotRunningException 结构](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskNotRunningException)
+ [ColumnStatisticsTaskStoppingException 结构](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskStoppingException)
+ [ColumnStatisticsTaskAutoConcurrencyLimitException 结构](#aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskAutoConcurrencyLimitException)
+ [InvalidCatalogSettingException 结构](#aws-glue-api-crawler-column-statistics-InvalidCatalogSettingException)

## ColumnStatisticsTaskRunningException 结构
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskRunningException"></a>

在运行列统计数据生成作业时尝试启动其他作业引发的异常。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## ColumnStatisticsTaskNotRunningException 结构
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskNotRunningException"></a>

在没有任务运行时尝试停止任务运行引发的异常。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## ColumnStatisticsTaskStoppingException 结构
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskStoppingException"></a>

在尝试停止任务运行引发的异常。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## ColumnStatisticsTaskAutoConcurrencyLimitException 结构
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskAutoConcurrencyLimitException"></a>

当您已经达到并发自动统计数据作业的限制时引发异常。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## InvalidCatalogSettingException 结构
<a name="aws-glue-api-crawler-column-statistics-InvalidCatalogSettingException"></a>

当目录设置有问题时引发异常。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

# 爬网程序计划程序 API
<a name="aws-glue-api-crawler-scheduler"></a>

爬网程序调度器 API 介绍 AWS Glue 爬网程序数据类型，以及用于创建、删除、更新和列出爬网程序的 API。

## 数据类型
<a name="aws-glue-api-crawler-scheduler-objects"></a>
+ [Schedule 结构](#aws-glue-api-crawler-scheduler-Schedule)

## Schedule 结构
<a name="aws-glue-api-crawler-scheduler-Schedule"></a>

一个使用 `cron` 语句计划事件的计划对象。

**字段**
+ `ScheduleExpression` – UTF-8 字符串。

  用于指定计划的 `cron` 表达式 (请参阅[用于作业和爬网程序的基于时间的计划](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html)）。例如，要每天 12:15 UTC 运行某些任务，您应该指定：`cron(15 12 * * ? *)`。
+ `State` – UTF-8 字符串（有效值：`SCHEDULED` \$1 `NOT_SCHEDULED` \$1 `TRANSITIONING`）。

  计划的状态。

## 操作
<a name="aws-glue-api-crawler-scheduler-actions"></a>
+ [UpdateCrawlerSchedule 操作（Python：update\$1crawler\$1schedule）](#aws-glue-api-crawler-scheduler-UpdateCrawlerSchedule)
+ [StartCrawlerSchedule 操作（Python：start\$1crawler\$1schedule）](#aws-glue-api-crawler-scheduler-StartCrawlerSchedule)
+ [StopCrawlerSchedule 操作（Python：stop\$1crawler\$1schedule）](#aws-glue-api-crawler-scheduler-StopCrawlerSchedule)

## UpdateCrawlerSchedule 操作（Python：update\$1crawler\$1schedule）
<a name="aws-glue-api-crawler-scheduler-UpdateCrawlerSchedule"></a>

使用 `cron` 表达式更新爬网程序的计划。

**请求**
+ `CrawlerName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要更新其计划的爬网程序的名称。
+ `Schedule` – UTF-8 字符串。

  用于指定计划的更新的 `cron` 表达式（请参阅[用于作业和爬网程序的基于时间的计划](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html)）。例如，要每天 12:15 UTC 运行某些任务，您应该指定：`cron(15 12 * * ? *)`。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `VersionMismatchException`
+ `SchedulerTransitioningException`
+ `OperationTimeoutException`

## StartCrawlerSchedule 操作（Python：start\$1crawler\$1schedule）
<a name="aws-glue-api-crawler-scheduler-StartCrawlerSchedule"></a>

将指定爬网程序的计划状态更改为 `SCHEDULED`，除非爬网程序已在运行或者计划状态已为 `SCHEDULED`。

**请求**
+ `CrawlerName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要计划的爬网程序的名称。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `SchedulerRunningException`
+ `SchedulerTransitioningException`
+ `NoScheduleException`
+ `OperationTimeoutException`

## StopCrawlerSchedule 操作（Python：stop\$1crawler\$1schedule）
<a name="aws-glue-api-crawler-scheduler-StopCrawlerSchedule"></a>

将指定爬网程序的计划状态设置为 `NOT_SCHEDULED`，但不停止爬网程序 (如果已在运行)。

**请求**
+ `CrawlerName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要设置其计划状态的爬网程序的名称。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `SchedulerNotRunningException`
+ `SchedulerTransitioningException`
+ `OperationTimeoutException`

# 自动生成 ETL 脚本 API
<a name="aws-glue-api-etl-script-generation"></a>

ETL 脚本生成 API 介绍用于在 AWS Glue 中生成 ETL 脚本的数据类型和 API。

## 数据类型
<a name="aws-glue-api-etl-script-generation-objects"></a>
+ [CodeGenNode 结构](#aws-glue-api-etl-script-generation-CodeGenNode)
+ [CodeGenNodeArg 结构](#aws-glue-api-etl-script-generation-CodeGenNodeArg)
+ [CodeGenEdge 结构](#aws-glue-api-etl-script-generation-CodeGenEdge)
+ [Location 结构](#aws-glue-api-etl-script-generation-Location)
+ [CatalogEntry 结构](#aws-glue-api-etl-script-generation-CatalogEntry)
+ [MappingEntry 结构](#aws-glue-api-etl-script-generation-MappingEntry)

## CodeGenNode 结构
<a name="aws-glue-api-etl-script-generation-CodeGenNode"></a>

表示有向无环图 (DAG) 中的节点

**字段**
+ `Id` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Identifier string pattern](aws-glue-api-common.md#aws-glue-api-regex-id) 匹配。

  节点图中唯一的节点标识符。
+ `NodeType` – *必填：*UTF-8 字符串。

  该节点的类型。
+ `Args` – *必填：*[CodeGenNodeArg](#aws-glue-api-etl-script-generation-CodeGenNodeArg) 对象的数组，不超过 50 个结构。

  节点的属性，采用名称-值对形式。
+ `LineNumber` – 数字（整数）。

  节点的行号。

## CodeGenNodeArg 结构
<a name="aws-glue-api-etl-script-generation-CodeGenNodeArg"></a>

节点的参数或属性。

**字段**
+ `Name` – *必填：*UTF-8 字符串。

  参数或属性的名称。
+ `Value` – *必填：*UTF-8 字符串。

  参数或属性的值。
+ `Param` – 布尔值。

  如果值用作参数，则为 True。

## CodeGenEdge 结构
<a name="aws-glue-api-etl-script-generation-CodeGenEdge"></a>

表示有向无环图 (DAG) 中的方向边缘。

**字段**
+ `Source` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Identifier string pattern](aws-glue-api-common.md#aws-glue-api-regex-id) 匹配。

  边缘开始的节点的 ID。
+ `Target` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Identifier string pattern](aws-glue-api-common.md#aws-glue-api-regex-id) 匹配。

  边缘结束的节点的 ID。
+ `TargetParameter` – UTF-8 字符串。

  边缘的目标。

## Location 结构
<a name="aws-glue-api-etl-script-generation-Location"></a>

资源的位置。

**字段**
+ `Jdbc` – [CodeGenNodeArg](#aws-glue-api-etl-script-generation-CodeGenNodeArg) 对象的数组，不超过 50 个结构。

  JDBC 位置。
+ `S3` – [CodeGenNodeArg](#aws-glue-api-etl-script-generation-CodeGenNodeArg) 对象的数组，不超过 50 个结构。

  Amazon Simple Storage Service (Amazon S3) 位置
+ `DynamoDB` – [CodeGenNodeArg](#aws-glue-api-etl-script-generation-CodeGenNodeArg) 对象的数组，不超过 50 个结构。

  Amazon DynamoDB 表位置。

## CatalogEntry 结构
<a name="aws-glue-api-etl-script-generation-CatalogEntry"></a>

在 AWS Glue Data Catalog 中指定表定义。

**字段**
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  表元数据所在的数据库。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  相关表的名称。

## MappingEntry 结构
<a name="aws-glue-api-etl-script-generation-MappingEntry"></a>

定义映射。

**字段**
+ `SourceTable` – UTF-8 字符串。

  源表的名称。
+ `SourcePath` – UTF-8 字符串。

   源路径。
+ `SourceType` – UTF-8 字符串。

  源类型
+ `TargetTable` – UTF-8 字符串。

  目标表。
+ `TargetPath` – UTF-8 字符串。

  目标路径。
+ `TargetType` – UTF-8 字符串。

  目标类型。

## 操作
<a name="aws-glue-api-etl-script-generation-actions"></a>
+ [CreateScript 操作（Python：create\$1script）](#aws-glue-api-etl-script-generation-CreateScript)
+ [GetDataflowGraph 操作（Python：get\$1dataflow\$1graph）](#aws-glue-api-etl-script-generation-GetDataflowGraph)
+ [GetMapping 操作（Python：get\$1mapping）](#aws-glue-api-etl-script-generation-GetMapping)
+ [GetPlan 操作（Python：get\$1plan）](#aws-glue-api-etl-script-generation-GetPlan)

## CreateScript 操作（Python：create\$1script）
<a name="aws-glue-api-etl-script-generation-CreateScript"></a>

将有向无环图 (DAG) 转换为代码。

**请求**
+ `DagNodes` – [CodeGenNode](#aws-glue-api-etl-script-generation-CodeGenNode) 对象的数组。

  DAG 中的节点的列表。
+ `DagEdges` – [CodeGenEdge](#aws-glue-api-etl-script-generation-CodeGenEdge) 对象的数组。

  DAG 中的边缘的列表。
+ `Language` – UTF-8 字符串（有效值：`PYTHON` \$1 `SCALA`）。

  从 DAG 生成的代码的编程语言。

**响应**
+ `PythonScript` – UTF-8 字符串。

  从 DAG 生成的 Python 脚本。
+ `ScalaCode` – UTF-8 字符串。

  从 DAG 生成的 Scala 代码。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## GetDataflowGraph 操作（Python：get\$1dataflow\$1graph）
<a name="aws-glue-api-etl-script-generation-GetDataflowGraph"></a>

将 Python 脚本转换为有向无环图 (DAG)。

**请求**
+ `PythonScript` – UTF-8 字符串。

  要转换的 Python 脚本。

**响应**
+ `DagNodes` – [CodeGenNode](#aws-glue-api-etl-script-generation-CodeGenNode) 对象的数组。

  生成的 DAG 中的节点的列表。
+ `DagEdges` – [CodeGenEdge](#aws-glue-api-etl-script-generation-CodeGenEdge) 对象的数组。

  生成的 DAG 中的边缘的列表。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## GetMapping 操作（Python：get\$1mapping）
<a name="aws-glue-api-etl-script-generation-GetMapping"></a>

创建映射。

**请求**
+ `Source` – *必填：*一个 [CatalogEntry](#aws-glue-api-etl-script-generation-CatalogEntry) 对象。

  指定源表。
+ `Sinks` – [CatalogEntry](#aws-glue-api-etl-script-generation-CatalogEntry) 对象的数组。

  目标表的列表。
+ `Location` – 一个 [位置](#aws-glue-api-etl-script-generation-Location) 对象。

  映射的参数。

**响应**
+ `Mapping` – *必填：*[MappingEntry](#aws-glue-api-etl-script-generation-MappingEntry) 对象的数组。

  指定目标的映射的列表。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `EntityNotFoundException`

## GetPlan 操作（Python：get\$1plan）
<a name="aws-glue-api-etl-script-generation-GetPlan"></a>

获取代码以执行指定的映射。

**请求**
+ `Mapping` – *必填：*[MappingEntry](#aws-glue-api-etl-script-generation-MappingEntry) 对象的数组。

  从源表到目标表的映射的列表。
+ `Source` – *必填：*一个 [CatalogEntry](#aws-glue-api-etl-script-generation-CatalogEntry) 对象。

  源表。
+ `Sinks` – [CatalogEntry](#aws-glue-api-etl-script-generation-CatalogEntry) 对象的数组。

  目标表。
+ `Location` – 一个 [位置](#aws-glue-api-etl-script-generation-Location) 对象。

  映射的参数。
+ `Language` – UTF-8 字符串（有效值：`PYTHON` \$1 `SCALA`）。

  用于执行映射的代码的编程语言。
+ `AdditionalPlanOptionsMap` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  用于保存其他可选键值参数的映射。

  目前支持以下键值对：
  + `inferSchema` – 指定是否为 AWS Glue 任务生成的默认脚本将 `inferSchema` 设置为 true 或 false。例如，要将 `inferSchema` 设置为 true，则传递以下键值对：

    `--additional-plan-options-map '{"inferSchema":"true"}'`

**响应**
+ `PythonScript` – UTF-8 字符串。

  用于执行映射的 Python 脚本。
+ `ScalaCode` – UTF-8 字符串。

  用于执行映射的 Scala 代码。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

# 可视化作业 API
<a name="aws-glue-api-visual-job-api"></a>

可视化作业 API 允许您使用表示 ‭AWS Glue‬ 作业的可视化配置的 JSON 对象中 AWS Glue API 的创建数据集成作业。

提供了一系列 `CodeGenConfigurationNodes`，用于创建或更新任务 API，以在 AWS Glue Studio 中为已创建的任务注册 DAG，并生成关联的代码。

## 数据类型
<a name="aws-glue-api-visual-job-api-objects"></a>
+ [CodeGenConfigurationNode 结构](#aws-glue-api-visual-job-api-CodeGenConfigurationNode)
+ [JDBCConnectoOptions 结构](#aws-glue-api-visual-job-api-JDBCConnectorOptions)
+ [StreamingDataPreviewOptions 结构](#aws-glue-api-visual-job-api-StreamingDataPreviewOptions)
+ [AthenaConnectorSource 结构](#aws-glue-api-visual-job-api-AthenaConnectorSource)
+ [JDBCConnectorSource 结构](#aws-glue-api-visual-job-api-JDBCConnectorSource)
+ [SparkConnectorSource 结构](#aws-glue-api-visual-job-api-SparkConnectorSource)
+ [CatalogSource 结构](#aws-glue-api-visual-job-api-CatalogSource)
+ [MySQLCatalogSource 结构](#aws-glue-api-visual-job-api-MySQLCatalogSource)
+ [PostgreSQLCatalogSource 结构](#aws-glue-api-visual-job-api-PostgreSQLCatalogSource)
+ [OracleSQLCatalogSource 结构](#aws-glue-api-visual-job-api-OracleSQLCatalogSource)
+ [MicrosoftSQLServerCatalogSource 结构](#aws-glue-api-visual-job-api-MicrosoftSQLServerCatalogSource)
+ [CatalogKinesisSource 结构](#aws-glue-api-visual-job-api-CatalogKinesisSource)
+ [DirectKinesisSource 结构](#aws-glue-api-visual-job-api-DirectKinesisSource)
+ [KinesisStreamingSourceOptions 结构](#aws-glue-api-visual-job-api-KinesisStreamingSourceOptions)
+ [CatalogKafkaSource 结构](#aws-glue-api-visual-job-api-CatalogKafkaSource)
+ [DirectKafkaSource 结构](#aws-glue-api-visual-job-api-DirectKafkaSource)
+ [KafkaStreamingSourceOptions 结构](#aws-glue-api-visual-job-api-KafkaStreamingSourceOptions)
+ [RedshiftSource 结构](#aws-glue-api-visual-job-api-RedshiftSource)
+ [AmazonRedshiftSource 结构](#aws-glue-api-visual-job-api-AmazonRedshiftSource)
+ [AmazonRedshiftNodeData 结构](#aws-glue-api-visual-job-api-AmazonRedshiftNodeData)
+ [AmazonRedshiftAdvancedOption 结构](#aws-glue-api-visual-job-api-AmazonRedshiftAdvancedOption)
+ [选项结构](#aws-glue-api-visual-job-api-Option)
+ [S3CatalogSource 结构](#aws-glue-api-visual-job-api-S3CatalogSource)
+ [S3SourceAdditionalOptions 结构](#aws-glue-api-visual-job-api-S3SourceAdditionalOptions)
+ [S3CsvSource 结构](#aws-glue-api-visual-job-api-S3CsvSource)
+ [DirectJDBCSource 结构](#aws-glue-api-visual-job-api-DirectJDBCSource)
+ [S3DirectSourceAdditionalOptions 结构](#aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions)
+ [S3JsonSource 结构](#aws-glue-api-visual-job-api-S3JsonSource)
+ [S3ParquetSource 结构](#aws-glue-api-visual-job-api-S3ParquetSource)
+ [S3DeltaSource 结构](#aws-glue-api-visual-job-api-S3DeltaSource)
+ [S3CatalogDeltaSource 结构](#aws-glue-api-visual-job-api-S3CatalogDeltaSource)
+ [CatalogDeltaSource 结构](#aws-glue-api-visual-job-api-CatalogDeltaSource)
+ [S3HudiSource 结构](#aws-glue-api-visual-job-api-S3HudiSource)
+ [S3CatalogHudiSource 结构](#aws-glue-api-visual-job-api-S3CatalogHudiSource)
+ [S3ExcelSource 结构](#aws-glue-api-visual-job-api-S3ExcelSource)
+ [CatalogHudiSource 结构](#aws-glue-api-visual-job-api-CatalogHudiSource)
+ [DynamoDBCatalogSource 结构](#aws-glue-api-visual-job-api-DynamoDBCatalogSource)
+ [RelationalCatalogSource 结构](#aws-glue-api-visual-job-api-RelationalCatalogSource)
+ [JDBCConnectorTarget 结构](#aws-glue-api-visual-job-api-JDBCConnectorTarget)
+ [SparkConnectorTarget 结构](#aws-glue-api-visual-job-api-SparkConnectorTarget)
+ [BasicCatalogTarget 结构](#aws-glue-api-visual-job-api-BasicCatalogTarget)
+ [MySQLCatalogTarget 结构](#aws-glue-api-visual-job-api-MySQLCatalogTarget)
+ [PostgreSQLCatalogTarget 结构](#aws-glue-api-visual-job-api-PostgreSQLCatalogTarget)
+ [OracleSQLCatalogTarget 结构](#aws-glue-api-visual-job-api-OracleSQLCatalogTarget)
+ [MicrosoftSQLServerCatalogTarget 结构](#aws-glue-api-visual-job-api-MicrosoftSQLServerCatalogTarget)
+ [RedshiftTarget 结构](#aws-glue-api-visual-job-api-RedshiftTarget)
+ [AmazonRedshiftTarget 结构](#aws-glue-api-visual-job-api-AmazonRedshiftTarget)
+ [UpsertRedshiftTargetOptions 结构](#aws-glue-api-visual-job-api-UpsertRedshiftTargetOptions)
+ [S3CatalogTarget 结构](#aws-glue-api-visual-job-api-S3CatalogTarget)
+ [S3GlueParquetTarget 结构](#aws-glue-api-visual-job-api-S3GlueParquetTarget)
+ [CatalogSchemaChangePolicy 结构](#aws-glue-api-visual-job-api-CatalogSchemaChangePolicy)
+ [S3DirectTarget 结构](#aws-glue-api-visual-job-api-S3DirectTarget)
+ [S3HudiCatalogTarget 结构](#aws-glue-api-visual-job-api-S3HudiCatalogTarget)
+ [S3HudiDirectTarget 结构](#aws-glue-api-visual-job-api-S3HudiDirectTarget)
+ [S3DeltaCatalogTarget 结构](#aws-glue-api-visual-job-api-S3DeltaCatalogTarget)
+ [S3DeltaDirectTarget 结构](#aws-glue-api-visual-job-api-S3DeltaDirectTarget)
+ [S3HyperDirectTarget 结构](#aws-glue-api-visual-job-api-S3HyperDirectTarget)
+ [S3IcebergDirectTarget 结构](#aws-glue-api-visual-job-api-S3IcebergDirectTarget)
+ [DirectSchemaChangePolicy 结构](#aws-glue-api-visual-job-api-DirectSchemaChangePolicy)
+ [ApplyMapping 结构](#aws-glue-api-visual-job-api-ApplyMapping)
+ [Mapping 结构](#aws-glue-api-visual-job-api-Mapping)
+ [SelectFields 结构](#aws-glue-api-visual-job-api-SelectFields)
+ [DropFields 结构](#aws-glue-api-visual-job-api-DropFields)
+ [RenameField 结构](#aws-glue-api-visual-job-api-RenameField)
+ [Spigot 结构](#aws-glue-api-visual-job-api-Spigot)
+ [Join 结构](#aws-glue-api-visual-job-api-Join)
+ [JoinColumn 结构](#aws-glue-api-visual-job-api-JoinColumn)
+ [SplitFields 结构](#aws-glue-api-visual-job-api-SplitFields)
+ [SelectFromCollection 结构](#aws-glue-api-visual-job-api-SelectFromCollection)
+ [FillMissingValues 结构](#aws-glue-api-visual-job-api-FillMissingValues)
+ [Filter 结构](#aws-glue-api-visual-job-api-Filter)
+ [FilterExpression 结构](#aws-glue-api-visual-job-api-FilterExpression)
+ [FilterValue 结构](#aws-glue-api-visual-job-api-FilterValue)
+ [CustomCode 结构](#aws-glue-api-visual-job-api-CustomCode)
+ [SparkSQL 结构](#aws-glue-api-visual-job-api-SparkSQL)
+ [SqlAlias 结构](#aws-glue-api-visual-job-api-SqlAlias)
+ [DropNullFields 结构](#aws-glue-api-visual-job-api-DropNullFields)
+ [NullCheckBoxList 结构](#aws-glue-api-visual-job-api-NullCheckBoxList)
+ [NullValueField 结构](#aws-glue-api-visual-job-api-NullValueField)
+ [Datatype 结构](#aws-glue-api-visual-job-api-Datatype)
+ [Merge 结构](#aws-glue-api-visual-job-api-Merge)
+ [Union 结构](#aws-glue-api-visual-job-api-Union)
+ [PIIDetection 结构](#aws-glue-api-visual-job-api-PIIDetection)
+ [Aggregate 结构](#aws-glue-api-visual-job-api-Aggregate)
+ [DropDuplicates 结构](#aws-glue-api-visual-job-api-DropDuplicates)
+ [GovernedCatalogTarget 结构](#aws-glue-api-visual-job-api-GovernedCatalogTarget)
+ [GovernedCatalogSource 结构](#aws-glue-api-visual-job-api-GovernedCatalogSource)
+ [聚合操作结构](#aws-glue-api-visual-job-api-AggregateOperation)
+ [GlueSchema 结构](#aws-glue-api-visual-job-api-GlueSchema)
+ [GlueStudioSchemaColumn 结构](#aws-glue-api-visual-job-api-GlueStudioSchemaColumn)
+ [GlueStudioColumn 结构](#aws-glue-api-visual-job-api-GlueStudioColumn)
+ [DynamicTransform 结构](#aws-glue-api-visual-job-api-DynamicTransform)
+ [TransformConfigParameter 结构](#aws-glue-api-visual-job-api-TransformConfigParameter)
+ [EvaluateDataQuality 结构](#aws-glue-api-visual-job-api-EvaluateDataQuality)
+ [DQResultsPublishingOptions 结构](#aws-glue-api-visual-job-api-DQResultsPublishingOptions)
+ [DQStopJobOnFailureOptions 结构](#aws-glue-api-visual-job-api-DQStopJobOnFailureOptions)
+ [EvaluateDataQualityMultiFrame 结构](#aws-glue-api-visual-job-api-EvaluateDataQualityMultiFrame)
+ [脚本结构](#aws-glue-api-visual-job-api-Recipe)
+ [RecipeReference 结构](#aws-glue-api-visual-job-api-RecipeReference)
+ [SnowflakeNodeData 结构](#aws-glue-api-visual-job-api-SnowflakeNodeData)
+ [SnowflakeSource 结构](#aws-glue-api-visual-job-api-SnowflakeSource)
+ [SnowflakeTarget 结构](#aws-glue-api-visual-job-api-SnowflakeTarget)
+ [ConnectorDataSource 的结构](#aws-glue-api-visual-job-api-ConnectorDataSource)
+ [ConnectorDataTarget 的结构](#aws-glue-api-visual-job-api-ConnectorDataTarget)
+ [RecipeStep 结构](#aws-glue-api-visual-job-api-RecipeStep)
+ [RecipeAction 结构](#aws-glue-api-visual-job-api-RecipeAction)
+ [ConditionExpression 结构](#aws-glue-api-visual-job-api-ConditionExpression)
+ [S3CatalogIcebergSource 结构](#aws-glue-api-visual-job-api-S3CatalogIcebergSource)
+ [CatalogIcebergSource 结构](#aws-glue-api-visual-job-api-CatalogIcebergSource)
+ [S3IcebergCatalogTarget 结构](#aws-glue-api-visual-job-api-S3IcebergCatalogTarget)
+ [DynamoDBELTConnectorSource 结构](#aws-glue-api-visual-job-api-DynamoDBELTConnectorSource)
+ [DDBELTConnectionOptions 结构](#aws-glue-api-visual-job-api-DDBELTConnectionOptions)
+ [DDBELTCatalogAdditionalOptions 结构](#aws-glue-api-visual-job-api-DDBELTCatalogAdditionalOptions)
+ [路由结构](#aws-glue-api-visual-job-api-Route)
+ [GroupFilters 结构](#aws-glue-api-visual-job-api-GroupFilters)
+ [AutoDataQuality 结构](#aws-glue-api-visual-job-api-AutoDataQuality)

## CodeGenConfigurationNode 结构
<a name="aws-glue-api-visual-job-api-CodeGenConfigurationNode"></a>

`CodeGenConfigurationNode` 枚举全部有效的节点类型。可以填充其中一个成员变量，并且只能填充一个。

**Fields**
+ `AthenaConnectorSource` – 一个 [AthenaConnectorSource](#aws-glue-api-visual-job-api-AthenaConnectorSource) 对象。

  指定一个指向 Amazon Athena 数据源的连接器。
+ `JDBCConnectorSource` – 一个 [JDBCConnectorSource](#aws-glue-api-visual-job-api-JDBCConnectorSource) 对象。

  指定一个指向 JDBC 数据源的连接器。
+ `SparkConnectorSource` – 一个 [SparkConnectorSource](#aws-glue-api-visual-job-api-SparkConnectorSource) 对象。

  指定一个指向 Apache Spark 数据源的连接器。
+ `CatalogSource` – 一个 [CatalogSource](#aws-glue-api-visual-job-api-CatalogSource) 对象。

  指定 AWS Glue 数据目录中的一个数据存储。
+ `RedshiftSource` – 一个 [RedshiftSource](#aws-glue-api-visual-job-api-RedshiftSource) 对象。

  指定一个 Amazon Redshift 数据存储。
+ `S3CatalogSource` – 一个 [S3CatalogSource](#aws-glue-api-visual-job-api-S3CatalogSource) 对象。

  指定 AWS Glue 数据目录中的一个 Amazon S3 数据存储。
+ `S3CsvSource` – 一个 [S3CsvSource](#aws-glue-api-visual-job-api-S3CsvSource) 对象。

  指定一个存储在 Amazon S3 中的命令分隔值 (CSV) 数据存储。
+ `S3JsonSource` – 一个 [S3JsonSource](#aws-glue-api-visual-job-api-S3JsonSource) 对象。

  指定一个存储在 Amazon S3 中的 JSON 数据存储。
+ `S3ParquetSource` – 一个 [S3ParquetSource](#aws-glue-api-visual-job-api-S3ParquetSource) 对象。

  指定一个存储在 Amazon S3 中的 Apache Parquet 数据存储。
+ `RelationalCatalogSource` – 一个 [RelationalCatalogSource](#aws-glue-api-visual-job-api-RelationalCatalogSource) 对象。

  指定 AWS Glue Data Catalog 中的一个关系目录数据存储。
+ `DynamoDBCatalogSource` – 一个 [DynamoDBCatalogSource](#aws-glue-api-visual-job-api-DynamoDBCatalogSource) 对象。

  指定 AWS Glue Data Catalog 中的一个 DynamoDBC 目录数据存储。
+ `JDBCConnectorTarget` – 一个 [JDBCConnectorTarget](#aws-glue-api-visual-job-api-JDBCConnectorTarget) 对象。

  指定一个在 Apache Paric 列式存储中写入 Amazon S3 的数据目标。
+ `SparkConnectorTarget` – 一个 [SparkConnectorTarget](#aws-glue-api-visual-job-api-SparkConnectorTarget) 对象。

  指定一个使用 Apache Spark 连接器的目标。
+ `CatalogTarget` – 一个 [BasicCatalogTarget](#aws-glue-api-visual-job-api-BasicCatalogTarget) 对象。

  指定一个使用 AWS Glue 数据目录表的目标。
+ `RedshiftTarget` – 一个 [RedshiftTarget](#aws-glue-api-visual-job-api-RedshiftTarget) 对象。

  指定一个使用 Amazon Redshift 的目标。
+ `S3CatalogTarget` – 一个 [S3CatalogTarget](#aws-glue-api-visual-job-api-S3CatalogTarget) 对象。

  指定一个使用 AWS Glue 数据目录写入 Amazon S3 的数据目标。
+ `S3GlueParquetTarget` – 一个 [S3GlueParquetTarget](#aws-glue-api-visual-job-api-S3GlueParquetTarget) 对象。

  指定一个在 Apache Paric 列式存储中写入 Amazon S3 的数据目标。
+ `S3DirectTarget` – 一个 [S3DirectTarget](#aws-glue-api-visual-job-api-S3DirectTarget) 对象。

  指定一个写入 Amazon S3 的数据目标。
+ `ApplyMapping` – 一个 [ApplyMapping](#aws-glue-api-visual-job-api-ApplyMapping) 对象。

  指定一个将数据源中的数据属性键映射到数据目标中的数据属性键的转换。您可以重命名键、修改键的数据类型以及选择要从数据集中删除的键。
+ `SelectFields` – 一个 [SelectFields](#aws-glue-api-visual-job-api-SelectFields) 对象。

  指定一个选择要保留的数据属性键的转换。
+ `DropFields` – 一个 [DropFields](#aws-glue-api-visual-job-api-DropFields) 对象。

  指定一个选择要删除的数据属性键的转换。
+ `RenameField` – 一个 [RenameField](#aws-glue-api-visual-job-api-RenameField) 对象。

  指定一个重命名单个数据属性键的转换。
+ `Spigot` – 一个 [Spigot](#aws-glue-api-visual-job-api-Spigot) 对象。

  指定一个将数据样本写入 Amazon S3 存储桶的转换。
+ `Join` – 一个 [Join](#aws-glue-api-visual-job-api-Join) 对象。

  指定一个转换，它将使用指定数据属性键上的比较短语将两个数据集联接到一个数据集。您可以使用内部、外部、左、右、左半和左反联接。
+ `SplitFields` – 一个 [SplitFields](#aws-glue-api-visual-job-api-SplitFields) 对象。

  指定一个将数据属性键拆分为两个 `DynamicFrames` 的转换。输出是 `DynamicFrames` 的集合：一个包含选定的数据属性键，另一个包含剩余的数据属性键。
+ `SelectFromCollection` – 一个 [SelectFromCollection](#aws-glue-api-visual-job-api-SelectFromCollection) 对象。

  指定一个从 `DynamicFrames` 的集合中选择一个 `DynamicFrame` 的转换。输出是选定的 `DynamicFrame`
+ `FillMissingValues` – 一个 [FillMissingValues](#aws-glue-api-visual-job-api-FillMissingValues) 对象。

  指定一个转换，它将查找数据集中缺少值的记录，并添加包含通过推算确定的值的新字段。输入数据集用于训练机器学习模型，该模型确定缺失值应该是什么。
+ `Filter` – 一个 [筛选条件](#aws-glue-api-visual-job-api-Filter) 对象。

  指定一个转换，它将基于筛选条件将一个数据集拆分为两个。
+ `CustomCode` – 一个 [CustomCode](#aws-glue-api-visual-job-api-CustomCode) 对象。

  指定一个转换，它将使用您提供的自定义代码执行数据转换。输出是 DynamicFrames 的集合。
+ `SparkSQL` – 一个 [SparkSQL](#aws-glue-api-visual-job-api-SparkSQL) 对象。

  指定一个转换，您可以在其中使用 Spark SQL 语法输入 SQL 查询以转换数据。输出为单个 `DynamicFrame`。
+ `DirectKinesisSource` – 一个 [DirectKinesisSource](#aws-glue-api-visual-job-api-DirectKinesisSource) 对象。

  指定一个直接 Amazon Kinesis 数据源。
+ `DirectKafkaSource` – 一个 [DirectKafkaSource](#aws-glue-api-visual-job-api-DirectKafkaSource) 对象。

  指定一个 Apache Kafka 数据存储。
+ `CatalogKinesisSource` – 一个 [CatalogKinesisSource](#aws-glue-api-visual-job-api-CatalogKinesisSource) 对象。

  指定 AWS Glue 数据目录中的一个 Kinesis 数据源。
+ `CatalogKafkaSource` – 一个 [CatalogKafkaSource](#aws-glue-api-visual-job-api-CatalogKafkaSource) 对象。

  指定数据目录中的一个 Apache Kafka 数据存储。
+ `DropNullFields` – 一个 [DropNullFields](#aws-glue-api-visual-job-api-DropNullFields) 对象。

  指定一个转换，如果列中的所有值均为“null”，则该转换将从数据集中删除这些列。预设情况下，AWS Glue Studio 将识别 null 对象，但是某些值，如空字符串、“null”字符串、-1 整数或其他占位符（如零），不会被自动识别为 null。
+ `Merge` – 一个 [Merge](#aws-glue-api-visual-job-api-Merge) 对象。

  指定一个转换，它将基于指定的主键将 `DynamicFrame` 与暂存 `DynamicFrame` 合并以标识记录。不会对重复记录（具有相同主键的记录）去除重复。
+ `Union` – 一个 [Union](#aws-glue-api-visual-job-api-Union) 对象。

  指定一个转换，它将两个或更多数据集中的行合并到单个结果中。
+ `PIIDetection` – 一个 [PIIDetection](#aws-glue-api-visual-job-api-PIIDetection) 对象。

  指定用于识别、删除或掩盖 PII 数据的转换。
+ `Aggregate` – 一个 [聚合](#aws-glue-api-visual-job-api-Aggregate) 对象。

  指定一个转换，用于按选定字段对行进行分组并通过指定函数计算聚合值。
+ `DropDuplicates` – 一个 [DropDuplicates](#aws-glue-api-visual-job-api-DropDuplicates) 对象。

  指定一个用于从数据集中删除重复数据行的转换。
+ `GovernedCatalogTarget` – 一个 [GovernedCatalogTarget](#aws-glue-api-visual-job-api-GovernedCatalogTarget) 对象。

  指定一个用于写入监管目录的数据目标。
+ `GovernedCatalogSource` – 一个 [GovernedCatalogSource](#aws-glue-api-visual-job-api-GovernedCatalogSource) 对象。

  指定监管数据目录中的一个数据源。
+ `MicrosoftSQLServerCatalogSource` – 一个 [MicrosoftSQLServerCatalogSource](#aws-glue-api-visual-job-api-MicrosoftSQLServerCatalogSource) 对象。

  在 AWS Glue 数据目录中指定一个 Microsoft SQL Server 数据源。
+ `MySQLCatalogSource` – 一个 [MySQLCatalogSource](#aws-glue-api-visual-job-api-MySQLCatalogSource) 对象。

  指定 AWS Glue 数据目录中的一个 MySQL 数据源。
+ `OracleSQLCatalogSource` – 一个 [OracleSQLCatalogSource](#aws-glue-api-visual-job-api-OracleSQLCatalogSource) 对象。

  指定 AWS Glue 数据目录中的一个 Oracle 数据源。
+ `PostgreSQLCatalogSource` – 一个 [PostgreSQLCatalogSource](#aws-glue-api-visual-job-api-PostgreSQLCatalogSource) 对象。

  指定 AWS Glue 数据目录中的一个 PostgresSQL 数据源。
+ `MicrosoftSQLServerCatalogTarget` – 一个 [MicrosoftSQLServerCatalogTarget](#aws-glue-api-visual-job-api-MicrosoftSQLServerCatalogTarget) 对象。

  指定一个使用 Microsoft SQL 的目标。
+ `MySQLCatalogTarget` – 一个 [MySQLCatalogTarget](#aws-glue-api-visual-job-api-MySQLCatalogTarget) 对象。

  指定一个使用 MySQL 的目标。
+ `OracleSQLCatalogTarget` – 一个 [OracleSQLCatalogTarget](#aws-glue-api-visual-job-api-OracleSQLCatalogTarget) 对象。

  指定一个使用 Oracle SQL 的目标。
+ `PostgreSQLCatalogTarget` – 一个 [PostgreSQLCatalogTarget](#aws-glue-api-visual-job-api-PostgreSQLCatalogTarget) 对象。

  指定一个使用 Postgres SQL 的目标。
+ `Route` – 一个 [路线](#aws-glue-api-visual-job-api-Route) 对象。

  指定一个路由节点，该节点根据定义的筛选条件，将数据定向到不同的输出路径。
+ `DynamicTransform` – 一个 [DynamicTransform](#aws-glue-api-visual-job-api-DynamicTransform) 对象。

  指定由用户创建的自定义视觉转换。
+ `EvaluateDataQuality` – 一个 [EvaluateDataQuality](#aws-glue-api-visual-job-api-EvaluateDataQuality) 对象。

  指定您的数据质量评估标准。
+ `S3CatalogHudiSource` – 一个 [S3CatalogHudiSource](#aws-glue-api-visual-job-api-S3CatalogHudiSource) 对象。

  指定在 AWS Glue Data Catalog 中注册的 Hudi 数据来源。数据来源必须存储在 Amazon S3 中。
+ `CatalogHudiSource` – 一个 [CatalogHudiSource](#aws-glue-api-visual-job-api-CatalogHudiSource) 对象。

  指定在 AWS Glue Data Catalog 中注册的 Hudi 数据来源。
+ `S3HudiSource` – 一个 [S3HudiSource](#aws-glue-api-visual-job-api-S3HudiSource) 对象。

  指定存储在 Amazon S3 中的 Hudi 数据来源。
+ `S3HudiCatalogTarget` – 一个 [S3HudiCatalogTarget](#aws-glue-api-visual-job-api-S3HudiCatalogTarget) 对象。

  在 AWS Glue Data Catalog 中指定写入 Hudi 数据来源的目标。
+ `S3HudiDirectTarget` – 一个 [S3HudiDirectTarget](#aws-glue-api-visual-job-api-S3HudiDirectTarget) 对象。

  指定在 Amazon S3 中写入 Hudi 数据来源的目标。
+ `S3CatalogDeltaSource` – 一个 [S3CatalogDeltaSource](#aws-glue-api-visual-job-api-S3CatalogDeltaSource) 对象。

  指定在 AWS Glue Data Catalog 中注册的 Delta Lake 数据来源。数据来源必须存储在 Amazon S3 中。
+ `CatalogDeltaSource` – 一个 [CatalogDeltaSource](#aws-glue-api-visual-job-api-CatalogDeltaSource) 对象。

  指定在 AWS Glue Data Catalog 中注册的 Delta Lake 数据来源。
+ `S3DeltaSource` – 一个 [S3DeltaSource](#aws-glue-api-visual-job-api-S3DeltaSource) 对象。

  指定存储在 Amazon S3 中的 Delta Lake 数据来源。
+ `S3DeltaCatalogTarget` – 一个 [S3DeltaCatalogTarget](#aws-glue-api-visual-job-api-S3DeltaCatalogTarget) 对象。

  在 AWS Glue Data Catalog 中指定写入 Delta Lake 数据来源的目标。
+ `S3DeltaDirectTarget` – 一个 [S3DeltaDirectTarget](#aws-glue-api-visual-job-api-S3DeltaDirectTarget) 对象。

  在 Amazon S3 中指定写入 Delta Lake 数据来源的目标。
+ `AmazonRedshiftSource` – 一个 [AmazonRedshiftSource](#aws-glue-api-visual-job-api-AmazonRedshiftSource) 对象。

  指定在 Amazon Redshift 中写入数据来源的目标。
+ `AmazonRedshiftTarget` – 一个 [AmazonRedshiftTarget](#aws-glue-api-visual-job-api-AmazonRedshiftTarget) 对象。

  指定在 Amazon Redshift 中写入数据目标的目标。
+ `EvaluateDataQualityMultiFrame` – 一个 [EvaluateDataQualityMultiFrame](#aws-glue-api-visual-job-api-EvaluateDataQualityMultiFrame) 对象。

  指定您的数据质量评估标准。允许多个输入数据并返回动态帧的集合。
+ `Recipe` – 一个 [Recipe](#aws-glue-api-visual-job-api-Recipe) 对象。

  指定 AWS Glue DataBrew 脚本节点。
+ `SnowflakeSource` – 一个 [SnowflakeSource](#aws-glue-api-visual-job-api-SnowflakeSource) 对象。

  指定 Snowflake 数据来源。
+ `SnowflakeTarget` – 一个 [SnowflakeTarget](#aws-glue-api-visual-job-api-SnowflakeTarget) 对象。

  指定写入 Snowflake 数据来源的目标。
+ `ConnectorDataSource` – 一个 [ConnectorDataSource](#aws-glue-api-visual-job-api-ConnectorDataSource) 对象。

  指定使用标准连接选项生成的源。
+ `ConnectorDataTarget` – 一个 [ConnectorDataTarget](#aws-glue-api-visual-job-api-ConnectorDataTarget) 对象。

  指定使用标准连接选项生成的目标。
+ `S3CatalogIcebergSource` – 一个 [s3catalogicebergSourc](#aws-glue-api-visual-job-api-S3CatalogIcebergSource) 对象。

  指定在 AWS Glue Data Catalog 中注册的 Apache Iceberg 数据来源。Iceberg 数据来源必须存储在 Amazon S3 中。
+ `CatalogIcebergSource` – 一个 [CatalogIcebergSource](#aws-glue-api-visual-job-api-CatalogIcebergSource) 对象。

  指定在 AWS Glue Data Catalog 中注册的 Apache Iceberg 数据来源。
+ `S3IcebergCatalogTarget` – 一个 [S3IcebergCatalogTarget](#aws-glue-api-visual-job-api-S3IcebergCatalogTarget) 对象。

  指定一个 Apache Iceberg 目录目标，该目标将数据写入 Amazon S3 并在 AWS Glue Data Catalog 中注册该表。
+ `S3IcebergDirectTarget` – 一个 [S3IcebergDirectTarget](#aws-glue-api-visual-job-api-S3IcebergDirectTarget) 对象。

  定义将数据作为 Apache Iceberg 表写入 Amazon S3 的配置参数。
+ `S3ExcelSource` – 一个 [S3ExcelSource](#aws-glue-api-visual-job-api-S3ExcelSource) 对象。

  定义从 Amazon S3 读取 Excel 文件的配置参数。
+ `S3HyperDirectTarget` – 一个 [S3HyperDirectTarget](#aws-glue-api-visual-job-api-S3HyperDirectTarget) 对象。

  定义使用 HyperDirect 优化将数据写入 Amazon S3 的配置参数。
+ `DynamoDBELTConnectorSource` – 一个 [DynamoDBELTConnectorSource](#aws-glue-api-visual-job-api-DynamoDBELTConnectorSource) 对象。

  指定用于从 DynamoDB 表中提取数据的 DynamoDB ELT 连接器源。

## JDBCConnectoOptions 结构
<a name="aws-glue-api-visual-job-api-JDBCConnectorOptions"></a>

用于连接器的其他连接选项。

**Fields**
+ `FilterPredicate` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  用于筛选源中的数据的额外条件子句。例如：

  `BillingCity='Mountain View'`

  使用查询（而不是表名称）时，您应验证查询是否适用于指定的 `filterPredicate`。
+ `PartitionColumn` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  用于分区的整数列的名称。此选项仅在包含 `lowerBound`、`upperBound` 和 `numPartitions` 时有效。此选项的工作方式与 Spark SQL JDBC 阅读器中的工作方式相同。
+ `LowerBound` – 数字（长型），至多为“无”。

  用于确定分区步长的最小 `partitionColumn` 值。
+ `UpperBound` – 数字（长型），至多为“无”。

  用于确定分区步长的最大 `partitionColumn` 值。
+ `NumPartitions` – 数字（长型），至多为“无”。

  分区的数量。此值以及 `lowerBound`（包含）和 `upperBound`（排除）为用于拆分 `partitionColumn` 而生成的 `WHERE` 子句表达式构成分区步长。
+ `JobBookmarkKeys` – UTF-8 字符串数组。

  要作为排序依据的任务书签键的名称。
+ `JobBookmarkKeysSortOrder` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定升序或降序排序顺序。
+ `DataTypeMapping` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串（有效值：`ARRAY` \$1`BIGINT` \$1`BINARY` \$1`BIT` \$1`BLOB` \$1`BOOLEAN` \$1`CHAR` \$1`CLOB` \$1`DATALINK` \$1`DATE` \$1`DECIMAL` \$1`DISTINCT` \$1`DOUBLE` \$1`FLOAT` \$1`INTEGER` \$1`JAVA_OBJECT` \$1`LONGNVARCHAR` \$1`LONGVARBINARY` \$1`LONGVARCHAR` \$1`NCHAR` \$1`NCLOB` \$1`NULL` \$1`NUMERIC` \$1`NVARCHAR` \$1`OTHER` \$1`REAL` \$1`REF` \$1`REF_CURSOR` \$1`ROWID` \$1`SMALLINT` \$1`SQLXML` \$1`STRUCT` \$1`TIME` \$1`TIME_WITH_TIMEZONE` \$1`TIMESTAMP` \$1`TIMESTAMP_WITH_TIMEZONE` \$1`TINYINT` \$1`VARBINARY` \$1`VARCHAR` ）。

  每个值都是一个 UTF-8字符串（有效值：`DATE` \$1`STRING` \$1`TIMESTAMP` \$1`INT` \$1`FLOAT` \$1`LONG` \$1`BIGDECIMAL` \$1`BYTE` \$1`SHORT` \$1`DOUBLE` ）。

  用于构建从 JDBC 数据类型到 AWS Glue 数据类型的映射的自定义数据类型映射。例如，选项 `"dataTypeMapping":{"FLOAT":"STRING"}` 会通过调用驱动程序的 `ResultSet.getString()` 方法，将 JDBC 类型 `FLOAT` 的数据字段映射到 Java `String` 类型，并将其用于构建 AWS Glue 记录。`ResultSet` 对象由每个驱动程序实现，因此行为特定于您使用的驱动程序。请参阅 JDBC 驱动程序的文档，了解驱动程序执行转换的方式。

## StreamingDataPreviewOptions 结构
<a name="aws-glue-api-visual-job-api-StreamingDataPreviewOptions"></a>

指定与用于查看数据样本的数据预览相关的选项。

**Fields**
+ `PollingTime` – 数字（长度），至少为 10。

  轮询时间（以毫秒为单位）。
+ `RecordPollingLimit` – 数字（长度），至少为 1。

  已轮询的记录的数量限制。

## AthenaConnectorSource 结构
<a name="aws-glue-api-visual-job-api-AthenaConnectorSource"></a>

指定一个指向 Amazon Athena 数据源的连接器。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据源的名称。
+ `ConnectionName` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  与连接器关联的连接的名称。
+ `ConnectorName` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  协助访问 AWS Glue Studio 中的数据存储的连接器的名称。
+ `ConnectionType` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定指向 Amazon Athena 数据存储的连接的连接类型，如 marketplace.athena 或 custom.athena。
+ `ConnectionTable` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  数据源中的表的名称。
+ `SchemaName` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的 CloudWatch 日志组的名称。例如 `/aws-glue/jobs/output`。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定自定义 Athena 源的数据架构。

## JDBCConnectorSource 结构
<a name="aws-glue-api-visual-job-api-JDBCConnectorSource"></a>

指定一个指向 JDBC 数据源的连接器。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据源的名称。
+ `ConnectionName` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  与连接器关联的连接的名称。
+ `ConnectorName` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  协助访问 AWS Glue Studio 中的数据存储的连接器的名称。
+ `ConnectionType` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定指向 JDBC 数据存储的连接的连接类型，如 marketplace.jdbc 或 custom.jdbc。
+ `AdditionalOptions` – 一个 [JDBCConnectorOptions](#aws-glue-api-visual-job-api-JDBCConnectorOptions) 对象。

  用于连接器的其他连接选项。
+ `ConnectionTable` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  数据源中的表的名称。
+ `Query` – UTF-8 字符串，与 [Custom string pattern #62](aws-glue-api-common.md#regex_62) 匹配。

  从中获取数据的表或 SQL 查询。您可以指定 `ConnectionTable` 或 `query`，但不能同时指定两者。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定自定义 JDBC 源的数据架构。

## SparkConnectorSource 结构
<a name="aws-glue-api-visual-job-api-SparkConnectorSource"></a>

指定一个指向 Apache Spark 数据源的连接器。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据源的名称。
+ `ConnectionName` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  与连接器关联的连接的名称。
+ `ConnectorName` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  协助访问 AWS Glue Studio 中的数据存储的连接器的名称。
+ `ConnectionType` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定指向 Apache Spark 数据存储的连接的连接类型，如 marketplace.spark 或 custom.spark。
+ `AdditionalOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  用于连接器的其他连接选项。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定自定义 Spark 源的数据架构。

## CatalogSource 结构
<a name="aws-glue-api-visual-job-api-CatalogSource"></a>

指定 AWS Glue 数据目录中的一个数据存储。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据存储的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库的名称。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库中的表的名称。
+ `PartitionPredicate` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

   满足此谓词的分区将被删除。这些分区中保留期内的文件不会被删除。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定目录源的数据架构。

## MySQLCatalogSource 结构
<a name="aws-glue-api-visual-job-api-MySQLCatalogSource"></a>

指定 AWS Glue 数据目录中的一个 MySQL 数据源。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据源的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库的名称。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库中的表的名称。

## PostgreSQLCatalogSource 结构
<a name="aws-glue-api-visual-job-api-PostgreSQLCatalogSource"></a>

指定 AWS Glue 数据目录中的一个 PostgresSQL 数据源。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据源的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库的名称。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库中的表的名称。

## OracleSQLCatalogSource 结构
<a name="aws-glue-api-visual-job-api-OracleSQLCatalogSource"></a>

指定 AWS Glue 数据目录中的一个 Oracle 数据源。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据源的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库的名称。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库中的表的名称。

## MicrosoftSQLServerCatalogSource 结构
<a name="aws-glue-api-visual-job-api-MicrosoftSQLServerCatalogSource"></a>

在 AWS Glue 数据目录中指定一个 Microsoft SQL Server 数据源。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据源的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库的名称。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库中的表的名称。

## CatalogKinesisSource 结构
<a name="aws-glue-api-visual-job-api-CatalogKinesisSource"></a>

指定 AWS Glue 数据目录中的一个 Kinesis 数据源。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据源的名称。
+ `WindowSize` – 数字（整数），至多为“无”。

  处理每个微批处理所花费的时间量。
+ `DetectSchema` – 布尔值。

  是否从传入的数据中自动确定架构。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库中的表的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库的名称。
+ `StreamingOptions` – 一个 [KinesisStreamingSourceOptions](#aws-glue-api-visual-job-api-KinesisStreamingSourceOptions) 对象。

  用于 Kinesis 串流数据源的其他选项。
+ `DataPreviewOptions` – 一个 [StreamingDataPreviewOptions](#aws-glue-api-visual-job-api-StreamingDataPreviewOptions) 对象。

  用于数据预览的其他选项。

## DirectKinesisSource 结构
<a name="aws-glue-api-visual-job-api-DirectKinesisSource"></a>

指定一个直接 Amazon Kinesis 数据源。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据源的名称。
+ `WindowSize` – 数字（整数），至多为“无”。

  处理每个微批处理所花费的时间量。
+ `DetectSchema` – 布尔值。

  是否从传入的数据中自动确定架构。
+ `StreamingOptions` – 一个 [KinesisStreamingSourceOptions](#aws-glue-api-visual-job-api-KinesisStreamingSourceOptions) 对象。

  用于 Kinesis 串流数据源的其他选项。
+ `DataPreviewOptions` – 一个 [StreamingDataPreviewOptions](#aws-glue-api-visual-job-api-StreamingDataPreviewOptions) 对象。

  用于数据预览的其他选项。

## KinesisStreamingSourceOptions 结构
<a name="aws-glue-api-visual-job-api-KinesisStreamingSourceOptions"></a>

用于 Amazon Kinesis 串流数据源的其他选项。

**Fields**
+ `EndpointUrl` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  Kinesis 端点的 URL。
+ `StreamName` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  Kinesis 数据流的名称。
+ `Classification` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  一个可选分类。
+ `Delimiter` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定分隔符。
+ `StartingPosition` – UTF-8 字符串（有效值：`latest="LATEST"` \$1`trim_horizon="TRIM_HORIZON"` \$1`earliest="EARLIEST"` \$1`timestamp="TIMESTAMP"` ）。

  要从中读取数据的 Kinesis 数据流中的起始位置。可能的值是 `"latest"`、`"trim_horizon"`、`"earliest"` 或以模式 `yyyy-mm-ddTHH:MM:SSZ` 采用 UTC 格式的时间戳字符串（其中 `Z` 表示带有 \$1/-的 UTC 时区偏移量。例如：“2023-04-04T08:00:00-04:00”）。默认值为 `"latest"`。

  注意：仅 AWS Glue 版本 4.0 或更高版本支持使用 UTC 格式的时间戳字符串值来表示“startingPosition”。
+ `MaxFetchTimeInMs` – 数字（长型），至多为“无”。

  作业执行程序从 Kinesis 数据流中读取当前批处理记录所花费的最长时间，以毫秒为单位指定。在这段时间内可以进行多次 `GetRecords` API 调用。默认值为 `1000`。
+ `MaxFetchRecordsPerShard` – 数字（长型），至多为“无”。

  每个微批次将从 Kinesis 数据流中的每个分片获取的最大记录数。注意：如果流式传输作业已经从 Kinesis 读取了额外的记录（在同一个 get-records 调用中），则客户端可以超过此限制。如果 `MaxFetchRecordsPerShard` 需要严格，则必须是 `MaxRecordPerRead` 的整数倍。默认值为 `100000`。
+ `MaxRecordPerRead` – 数字（长型），至多为“无”。

  每项 getRecords 操作中要从 Kinesis 数据流获取的最大记录数。默认值为 `10000`。
+ `AddIdleTimeBetweenReads` – 布尔值。

  在两项连续 getRecords 操作之间添加时间延迟。默认值为 `"False"`。此选项仅适用于 AWS Glue 版本 2.0 及更高版本。
+ `IdleTimeBetweenReadsInMs` – 数字（长型），至多为“无”。

  两项连续 getRecords 操作之间的最短时间延迟，以毫秒为单位指定。默认值为 `1000`。此选项仅适用于 AWS Glue 版本 2.0 及更高版本。
+ `DescribeShardInterval` – 数字（长型），至多为“无”。

  两次 ListShards API 调用之间的最短时间间隔，供您的脚本考虑重新分区。默认值为 `1s`。
+ `NumRetries` – 数字（整数），至多为“无”。

  Kinesis Data Streams API 请求的最大重试次数。默认值为 `3`。
+ `RetryIntervalMs` – 数字（长型），至多为“无”。

  重试 Kinesis Data Streams API 调用之前的冷却时间（以毫秒为单位指定）。默认值为 `1000`。
+ `MaxRetryIntervalMs` – 数字（长型），至多为“无”。

  Kinesis Data Streams API 调用的两次重试之间的最长冷却时间（以毫秒为单位指定）。默认值为 `10000`。
+ `AvoidEmptyBatches` – 布尔值。

  在批处理开始之前检查 Kinesis 数据流中是否有未读数据，避免创建空白微批处理任务。默认值为 `"False"`。
+ `StreamArn` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  Kinesis 数据流的 Amazon Resource Name (ARN)。
+ `RoleArn` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要使用 AWS Security Token Service (AWS STS) 代入的角色的 Amazon Resource Name (ARN)。此角色必须拥有针对 Kinesis 数据流执行描述或读取记录操作的权限。在访问其他账户中的数据流时，必须使用此参数。与 `"awsSTSSessionName"` 结合使用。
+ `RoleSessionName` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  使用 AWS STS 代入角色的会话的标识符。在访问其他账户中的数据流时，必须使用此参数。与 `"awsSTSRoleARN"` 结合使用。
+ `AddRecordTimestamp` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  当选项设置为 'true' 时，数据输出将包含一个名为 "\$1\$1src\$1timestamp" 的附加列，表示数据流收到相应记录的时间。默认值为‘false’。4.0 或更高 AWS Glue 版本支持此选项。
+ `EmitConsumerLagMetrics` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  当此选项设置为 'true' 时，对于每个批次，它将向 CloudWatch 发布数据流接收到的最早记录与该记录到达 AWS Glue 之间的时长指标。指标名称为 "glue.driver.streaming.maxConsumerLagInMs"。默认值为‘false’。4.0 或更高 AWS Glue 版本支持此选项。
+ `StartingTimestamp` – UTF-8 字符串。

  Kinesis 数据流中开始读取数据的记录的时间戳。可能的值是以模式 `yyyy-mm-ddTHH:MM:SSZ` 采用 UTC 格式的时间戳字符串（其中 表示带有 \$1/-的 UTC 时区偏移量。例如：“2023-04-04T08:00:00\$108:00”）。
+ `FanoutConsumerARN` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  Kinesis 数据流增强型扇出式消费者的 Amazon 资源名称（ARN）。指定后即会启用增强型扇出功能，实现专用吞吐量和更低延迟的数据消费能力。

## CatalogKafkaSource 结构
<a name="aws-glue-api-visual-job-api-CatalogKafkaSource"></a>

指定数据目录中的一个 Apache Kafka 数据存储。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据存储的名称。
+ `WindowSize` – 数字（整数），至多为“无”。

  处理每个微批处理所花费的时间量。
+ `DetectSchema` – 布尔值。

  是否从传入的数据中自动确定架构。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库中的表的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库的名称。
+ `StreamingOptions` – 一个 [KafkaStreamingSourceOptions](#aws-glue-api-visual-job-api-KafkaStreamingSourceOptions) 对象。

  指定串流选项。
+ `DataPreviewOptions` – 一个 [StreamingDataPreviewOptions](#aws-glue-api-visual-job-api-StreamingDataPreviewOptions) 对象。

  指定与用于查看数据样本的数据预览相关的选项。

## DirectKafkaSource 结构
<a name="aws-glue-api-visual-job-api-DirectKafkaSource"></a>

指定一个 Apache Kafka 数据存储。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据存储的名称。
+ `StreamingOptions` – 一个 [KafkaStreamingSourceOptions](#aws-glue-api-visual-job-api-KafkaStreamingSourceOptions) 对象。

  指定串流选项。
+ `WindowSize` – 数字（整数），至多为“无”。

  处理每个微批处理所花费的时间量。
+ `DetectSchema` – 布尔值。

  是否从传入的数据中自动确定架构。
+ `DataPreviewOptions` – 一个 [StreamingDataPreviewOptions](#aws-glue-api-visual-job-api-StreamingDataPreviewOptions) 对象。

  指定与用于查看数据样本的数据预览相关的选项。

## KafkaStreamingSourceOptions 结构
<a name="aws-glue-api-visual-job-api-KafkaStreamingSourceOptions"></a>

用于串流的其他选项。

**Fields**
+ `BootstrapServers` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  引导服务器 URL 的列表，例如，作为 `b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094`。此选项必须在 API 调用中指定，或在数据目录的表元数据中定义。
+ `SecurityProtocol` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  用于与代理通信的协议。可能的值为 `"SSL"` 或 `"PLAINTEXT"`。
+ `ConnectionName` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  连接的名称。
+ `TopicName` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  Apache Kafka 中指定的主题名称。您必须指定 `"topicName"`、`"assign"` 或 `"subscribePattern"` 中的至少一个。
+ `Assign` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要使用的特定 `TopicPartitions`。您必须指定 `"topicName"`、`"assign"` 或 `"subscribePattern"` 中的至少一个。
+ `SubscribePattern` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  标识要订阅的主题列表的 Java 正则表达式字符串。您必须指定 `"topicName"`、`"assign"` 或 `"subscribePattern"` 中的至少一个。
+ `Classification` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  一个可选分类。
+ `Delimiter` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定分隔符。
+ `StartingOffsets` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  Kafka 主题中读取数据的起始位置。可能的值为 `"earliest"` 或 `"latest"`。默认值为 `"latest"`。
+ `EndingOffsets` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  批处理查询结束时的终点。可能值为 `"latest"`，或者为每个 `TopicPartition` 指定结束偏移的 JSON 字符串。
+ `PollTimeoutMs` – 数字（长型），至多为“无”。

  Spark 任务执行程序中，从 Kafka 轮询数据的超时时间（以毫秒为单位）。默认值为 `512`。
+ `NumRetries` – 数字（整数），至多为“无”。

  获取 Kafka 偏移失败前的重试次数。默认值为 `3`。
+ `RetryIntervalMs` – 数字（长型），至多为“无”。

  重试获取 Kafka 偏移前的等待时间（以毫秒为单位）。默认值为 `10`。
+ `MaxOffsetsPerTrigger` – 数字（长型），至多为“无”。

  每个触发间隔处理的最大偏移数的速率限制。指定的总偏移数跨不同卷的 `topicPartitions` 按比例分割。默认值为 null，表示该消费者将读取所有偏移量直至已知的最新偏移量。
+ `MinPartitions` – 数字（整数），至多为“无”。

  从 Kafka 读取数据的所需最小分区数。默认值为 null，这意味着 Spark 分区数等于 Kafka 分区数。
+ `IncludeHeaders` – 布尔值。

  是否包含 Kafka 标头。当选项设置为“true”时，数据输出将包含一个名为“glue\$1streaming\$1kafka\$1headers”的附加列，类型为 `Array[Struct(key: String, value: String)]`。默认值为“false”。此选项仅适用于 AWS Glue 版本 3.0 或更高版本。
+ `AddRecordTimestamp` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  当选项设置为 'true' 时，数据输出将包含一个名为 "\$1\$1src\$1timestamp" 的附加列，表示主题收到相应记录的时间。默认值为‘false’。4.0 或更高 AWS Glue 版本支持此选项。
+ `EmitConsumerLagMetrics` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  当此选项设置为 'true' 时，对于每个批次，它将向 CloudWatch 发布主题接收到的最早记录与该记录到达 AWS Glue 之间的时长指标。指标名称为 "glue.driver.streaming.maxConsumerLagInMs"。默认值为‘false’。4.0 或更高 AWS Glue 版本支持此选项。
+ `StartingTimestamp` – UTF-8 字符串。

  Kafka 主题中开始读取数据的记录时间戳。可能的值是以模式 `yyyy-mm-ddTHH:MM:SSZ` 采用 UTC 格式的时间戳字符串（其中 表示带有 \$1/-的 UTC 时区偏移量。例如：“2023-04-04T08:00:00\$108:00”）。

  只能设置一个 `StartingTimestamp` 或 `StartingOffsets`。

## RedshiftSource 结构
<a name="aws-glue-api-visual-job-api-RedshiftSource"></a>

指定一个 Amazon Redshift 数据存储。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  Amazon Redshift 数据存储的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库表。
+ `RedshiftTmpDir` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  从数据库中复制时，可以用于暂存临时数据的 Amazon S3 路径。
+ `TmpDirIAMRole` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  拥有权限的 IAM 角色。

## AmazonRedshiftSource 结构
<a name="aws-glue-api-visual-job-api-AmazonRedshiftSource"></a>

指定 Amazon Redshift 来源。

**Fields**
+ `Name` – UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  Amazon Redshift 来源的名称。
+ `Data` – 一个 [AmazonRedshiftNodeData](#aws-glue-api-visual-job-api-AmazonRedshiftNodeData) 对象。

  指定 Amazon Redshift 源节点的数据。

## AmazonRedshiftNodeData 结构
<a name="aws-glue-api-visual-job-api-AmazonRedshiftNodeData"></a>

指定一个 Amazon Redshift 节点。

**Fields**
+ `AccessType` – UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  Redshift 连接的访问类型。可以是直接连接或目录连接。
+ `SourceType` – UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  用于指定特定表是源查询还是自定义查询的源类型。
+ `Connection` – 一个 [选项](#aws-glue-api-visual-job-api-Option) 对象。

  与 Redshift 集群的 AWS Glue 连接。
+ `Schema` – 一个 [选项](#aws-glue-api-visual-job-api-Option) 对象。

  使用直接连接时的 Redshift 架构名称。
+ `Table` – 一个 [选项](#aws-glue-api-visual-job-api-Option) 对象。

  使用直接连接时的 Redshift 表名称。
+ `CatalogDatabase` – 一个 [选项](#aws-glue-api-visual-job-api-Option) 对象。

  使用数据目录时的 AWS Glue Data Catalog 数据库的名称。
+ `CatalogTable` – 一个 [选项](#aws-glue-api-visual-job-api-Option) 对象。

  使用数据目录时的 AWS Glue Data Catalog 表名。
+ `CatalogRedshiftSchema` – UTF-8 字符串。

  使用数据目录时的 Redshift 架构名称。
+ `CatalogRedshiftTable` – UTF-8 字符串。

  要从中进行读取的数据库表。
+ `TempDir` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  从数据库中复制时，可以用于暂存临时数据的 Amazon S3 路径。
+ `IamRole` – 一个 [选项](#aws-glue-api-visual-job-api-Option) 对象。

  可选。连接到 S3 时使用的角色名称。留空时，IAM 角色将默认为作业中的角色。
+ `AdvancedOptions` – [AmazonRedshiftAdvancedOption](#aws-glue-api-visual-job-api-AmazonRedshiftAdvancedOption) 对象的数组。

  连接到 Redshift 集群时为可选值。
+ `SampleQuery` – UTF-8 字符串。

  当源类型为“查询”时，用于从 Redshift 源中获取数据的 SQL。
+ `PreAction` – UTF-8 字符串。

  使用 upsert 运行 MERGE 或 APPEND 之前使用的 SQL。
+ `PostAction` – UTF-8 字符串。

  使用 upsert 运行 MERGE 或 APPEND 之前使用的 SQL。
+ `Action` – UTF-8 字符串。

  指定写入 Redshift 集群的操作方式。
+ `TablePrefix` – UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  指定表的前缀。
+ `Upsert` – 布尔值。

  执行 APPEND 时，在 Redshift 上使用的操作会失效。
+ `MergeAction` – UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  该操作用于确定如何处理 Redshift 接收器中的 MERGE。
+ `MergeWhenMatched` – UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  当现有记录与新记录匹配时，该操作用于确定如何处理 Redshift 接收器中的 MERGE。
+ `MergeWhenNotMatched` – UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  当现有记录与新记录不匹配时，该操作用于确定如何处理 Redshift 接收器中的 MERGE。
+ `MergeClause` – UTF-8 字符串。

  自定义合并中用于处理匹配记录的 SQL。
+ `CrawlerConnection` – UTF-8 字符串。

  指定与所用目录表关联的连接的名称。
+ `TableSchema` – [选项](#aws-glue-api-visual-job-api-Option) 对象的数组。

  给定节点的架构输出数组。
+ `StagingTable` – UTF-8 字符串。

  使用 upsert 执行 MERGE 或 APPEND 时使用的临时暂存表的名称。
+ `SelectedColumns` – [选项](#aws-glue-api-visual-job-api-Option) 对象的数组。

  使用 upsert 执行 MERGE 或 APPEND 时用于确定匹配记录的列名列表。

## AmazonRedshiftAdvancedOption 结构
<a name="aws-glue-api-visual-job-api-AmazonRedshiftAdvancedOption"></a>

连接到 Redshift 集群时指定可选值。

**Fields**
+ `Key` – UTF-8 字符串。

  其他连接选项的键。
+ `Value` – UTF-8 字符串。

  其他连接选项的值。

## 选项结构
<a name="aws-glue-api-visual-job-api-Option"></a>

指定选项值。

**Fields**
+ `Value` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定选项的值。
+ `Label` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定选项的标签。
+ `Description` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定选项的描述。

## S3CatalogSource 结构
<a name="aws-glue-api-visual-job-api-S3CatalogSource"></a>

指定 AWS Glue 数据目录中的一个 Amazon S3 数据存储。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据存储的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库表。
+ `PartitionPredicate` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  满足此谓词的分区将被删除。这些分区中保留期内的文件不会被删除。设置为 `""` – 默认情况下为空。
+ `AdditionalOptions` – 一个 [S3SourceAdditionalOptions](#aws-glue-api-visual-job-api-S3SourceAdditionalOptions) 对象。

  指定其他连接选项。

## S3SourceAdditionalOptions 结构
<a name="aws-glue-api-visual-job-api-S3SourceAdditionalOptions"></a>

为 Amazon S3 数据存储指定其他连接选项。

**Fields**
+ `BoundedSize` – 数字（长型）。

  设置要处理的数据集的目标大小的上限（以字节为单位）。
+ `BoundedFiles` – 数字（长型）。

  设置要处理的文件的目标数量的上限。

## S3CsvSource 结构
<a name="aws-glue-api-visual-job-api-S3CsvSource"></a>

指定一个存储在 Amazon S3 中的命令分隔值 (CSV) 数据存储。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据存储的名称。
+ `Paths` – *必填*：UTF-8 字符串数组。

  要从中进行读取的 Amazon S3 路径的列表。
+ `CompressionType` – UTF-8 字符串（有效值：`gzip="GZIP"` \$1`bzip2="BZIP2"` ）。

  指定数据压缩方式。通常，如果数据有标准文件扩展名，则不需要指定。可能的值为 `"gzip"` 和 `"bzip"`。
+ `Exclusions` – UTF-8 字符串数组。

  包含要排除的 Unix 样式 glob 模式的 JSON 列表的字符串。例如，"[\$1"\$1\$1.pdf\$1"]" 排除所有 PDF 文件。
+ `GroupSize` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  目标组大小（以字节为单位）。默认值根据输入数据大小和群集大小进行计算。当少于 50,000 个输入文件时，`"groupFiles"` 必须设置为 `"inPartition"`，此选项才能生效。
+ `GroupFiles` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  当输入包含超过 50,000 个文件时，预设情况下将启用文件分组。当少于 50,000 个文件时，要启用分组，请将此参数设置为“inPartition”。当超过 50,000 个文件时，若要禁用分组，请将此参数设置为 `"none"`。
+ `Recurse` – 布尔值。

  如果设置为 true（真），则以递归方式读取指定路径下的所有子目录中的文件。
+ `MaxBand` – 数字（整数），至多为“无”。

  此选项控制 s3 列表可能保持一致的持续时间（以毫秒为单位）。当使用 JobBookmarks 来表明 Amazon S3 最终一致性时，将专门跟踪修改时间戳处于最后 maxBand 毫秒内的文件。大多数用户不需要设置此选项。默认值为 900000 毫秒或 15 分钟。
+ `MaxFilesInBand` – 数字（整数），至多为“无”。

  此选项指定在最后 maxBand 秒内可保存的最大文件数量。如果超过此值，额外的文件将会跳过，且只能在下一次作业运行中处理。
+ `AdditionalOptions` – 一个 [S3DirectSourceAdditionalOptions](#aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions) 对象。

  指定其他连接选项。
+ `Separator` – *必填*：UTF-8 字符串（有效值：`comma="COMMA"` \$1 `ctrla="CTRLA"` \$1 `pipe="PIPE"` \$1 `semicolon="SEMICOLON"` \$1 `tab="TAB"`）。

  指定分隔符。默认值为逗号：“,”，但也可以指定任何其他字符。
+ `Escaper` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定要用于转义的字符。此选项仅在读取 CSV 文件时使用。默认值为 `none`。如果启用，则按原样使用紧跟其后的字符，一小组已知的转义符（`\n`、`\r`、`\t` 和 `\0`）除外。
+ `QuoteChar` – *必填*：UTF-8 字符串（有效值：`quote="QUOTE"` \$1 `quillemet="QUILLEMET"` \$1 `single_quote="SINGLE_QUOTE"` \$1 `disabled="DISABLED"`）。

  指定要用于引用的字符。默认值为双引号：`'"'`。将这设置为 `-1` 可完全关闭引用。
+ `Multiline` – 布尔值。

  指定单个记录能否跨越多行的布尔值。当字段包含带引号的换行符时，会出现此选项。如果有任何记录跨越多行，则您必须将此选项设置为 True（真）。默认值为 `False`，它允许在分析过程中更积极地拆分文件。
+ `WithHeader` – 布尔值。

  指定是否将第一行视为标题的布尔值。默认值为 `False`。
+ `WriteHeader` – 布尔值。

  指定是否将标题写入输出的布尔值。默认值为 `True`。
+ `SkipFirst` – 布尔值。

  指定是否跳过第一个数据行的布尔值。默认值为 `False`。
+ `OptimizePerformance` – 布尔值。

  指定是否使用高级 SIMD CSV 读取器以及基于 Apache Arrow 的列式内存格式的布尔值。（仅在 AWS Glue 版本 3.0 中提供。）
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 S3 CSV 源的数据架构。

## DirectJDBCSource 结构
<a name="aws-glue-api-visual-job-api-DirectJDBCSource"></a>

指定直接 JDBC 数据源连接。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  JDBC 数据源连接的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  JDBC 数据源连接的数据库。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  JDBC 数据源连接的表。
+ `ConnectionName` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  JDBC 数据源的连接名称。
+ `ConnectionType` – *必填*：UTF-8 字符串（有效值：`sqlserver` \$1 `mysql` \$1 `oracle` \$1 `postgresql` \$1 `redshift`）。

  JDBC 源的连接类型。
+ `RedshiftTmpDir` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  JDBC Redshift 数据源的临时目录。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定直接 JDBC 源的数据架构。

## S3DirectSourceAdditionalOptions 结构
<a name="aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions"></a>

为 Amazon S3 数据存储指定其他连接选项。

**Fields**
+ `BoundedSize` – 数字（长型）。

  设置要处理的数据集的目标大小的上限（以字节为单位）。
+ `BoundedFiles` – 数字（长型）。

  设置要处理的文件的目标数量的上限。
+ `EnableSamplePath` – 布尔值。

  设置选项以启用示例路径。
+ `SamplePath` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  如果启用，请指定示例路径。

## S3JsonSource 结构
<a name="aws-glue-api-visual-job-api-S3JsonSource"></a>

指定一个存储在 Amazon S3 中的 JSON 数据存储。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据存储的名称。
+ `Paths` – *必填*：UTF-8 字符串数组。

  要从中进行读取的 Amazon S3 路径的列表。
+ `CompressionType` – UTF-8 字符串（有效值：`gzip="GZIP"` \$1`bzip2="BZIP2"` ）。

  指定数据压缩方式。通常，如果数据有标准文件扩展名，则不需要指定。可能的值为 `"gzip"` 和 `"bzip"`。
+ `Exclusions` – UTF-8 字符串数组。

  包含要排除的 Unix 样式 glob 模式的 JSON 列表的字符串。例如，"[\$1"\$1\$1.pdf\$1"]" 排除所有 PDF 文件。
+ `GroupSize` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  目标组大小（以字节为单位）。默认值根据输入数据大小和群集大小进行计算。当少于 50,000 个输入文件时，`"groupFiles"` 必须设置为 `"inPartition"`，此选项才能生效。
+ `GroupFiles` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  当输入包含超过 50,000 个文件时，预设情况下将启用文件分组。当少于 50,000 个文件时，要启用分组，请将此参数设置为“inPartition”。当超过 50,000 个文件时，若要禁用分组，请将此参数设置为 `"none"`。
+ `Recurse` – 布尔值。

  如果设置为 true（真），则以递归方式读取指定路径下的所有子目录中的文件。
+ `MaxBand` – 数字（整数），至多为“无”。

  此选项控制 s3 列表可能保持一致的持续时间（以毫秒为单位）。当使用 JobBookmarks 来表明 Amazon S3 最终一致性时，将专门跟踪修改时间戳处于最后 maxBand 毫秒内的文件。大多数用户不需要设置此选项。默认值为 900000 毫秒或 15 分钟。
+ `MaxFilesInBand` – 数字（整数），至多为“无”。

  此选项指定在最后 maxBand 秒内可保存的最大文件数量。如果超过此值，额外的文件将会跳过，且只能在下一次作业运行中处理。
+ `AdditionalOptions` – 一个 [S3DirectSourceAdditionalOptions](#aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions) 对象。

  指定其他连接选项。
+ `JsonPath` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  定义 JSON 数据的 JsonPath 字符串。
+ `Multiline` – 布尔值。

  指定单个记录能否跨越多行的布尔值。当字段包含带引号的换行符时，会出现此选项。如果有任何记录跨越多行，则您必须将此选项设置为 True（真）。默认值为 `False`，它允许在分析过程中更积极地拆分文件。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 S3 JSON 源的数据架构。

## S3ParquetSource 结构
<a name="aws-glue-api-visual-job-api-S3ParquetSource"></a>

指定一个存储在 Amazon S3 中的 Apache Parquet 数据存储。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据存储的名称。
+ `Paths` – *必填*：UTF-8 字符串数组。

  要从中进行读取的 Amazon S3 路径的列表。
+ `CompressionType` – UTF-8 字符串（有效值：`snappy="SNAPPY"` \$1`lzo="LZO"` \$1`gzip="GZIP"` \$1`brotli="BROTLI"` \$1`lz4="LZ4"` \$1`uncompressed="UNCOMPRESSED"` \$1`none="NONE"` ）。

  指定数据压缩方式。通常，如果数据有标准文件扩展名，则不需要指定。可能的值为 `"gzip"` 和 `"bzip"`。
+ `Exclusions` – UTF-8 字符串数组。

  包含要排除的 Unix 样式 glob 模式的 JSON 列表的字符串。例如，"[\$1"\$1\$1.pdf\$1"]" 排除所有 PDF 文件。
+ `GroupSize` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  目标组大小（以字节为单位）。默认值根据输入数据大小和群集大小进行计算。当少于 50,000 个输入文件时，`"groupFiles"` 必须设置为 `"inPartition"`，此选项才能生效。
+ `GroupFiles` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  当输入包含超过 50,000 个文件时，预设情况下将启用文件分组。当少于 50,000 个文件时，要启用分组，请将此参数设置为“inPartition”。当超过 50,000 个文件时，若要禁用分组，请将此参数设置为 `"none"`。
+ `Recurse` – 布尔值。

  如果设置为 true（真），则以递归方式读取指定路径下的所有子目录中的文件。
+ `MaxBand` – 数字（整数），至多为“无”。

  此选项控制 s3 列表可能保持一致的持续时间（以毫秒为单位）。当使用 JobBookmarks 来表明 Amazon S3 最终一致性时，将专门跟踪修改时间戳处于最后 maxBand 毫秒内的文件。大多数用户不需要设置此选项。默认值为 900000 毫秒或 15 分钟。
+ `MaxFilesInBand` – 数字（整数），至多为“无”。

  此选项指定在最后 maxBand 秒内可保存的最大文件数量。如果超过此值，额外的文件将会跳过，且只能在下一次作业运行中处理。
+ `AdditionalOptions` – 一个 [S3DirectSourceAdditionalOptions](#aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions) 对象。

  指定其他连接选项。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 S3 Parquet 源的数据架构。

## S3DeltaSource 结构
<a name="aws-glue-api-visual-job-api-S3DeltaSource"></a>

指定存储在 Amazon S3 中的 Delta Lake 数据来源。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  Delta Lake 源的名称。
+ `Paths` – *必填*：UTF-8 字符串数组。

  要从中进行读取的 Amazon S3 路径的列表。
+ `AdditionalDeltaOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定其他连接选项。
+ `AdditionalOptions` – 一个 [S3DirectSourceAdditionalOptions](#aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions) 对象。

  为连接器指定其他选项。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 Delta Lake 源的数据架构。

## S3CatalogDeltaSource 结构
<a name="aws-glue-api-visual-job-api-S3CatalogDeltaSource"></a>

指定在 AWS Glue Data Catalog 中注册的 Delta Lake 数据来源。数据来源必须存储在 Amazon S3 中。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  Delta Lake 数据源的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库的名称。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库中的表的名称。
+ `AdditionalDeltaOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定其他连接选项。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 Delta Lake 源的数据架构。

## CatalogDeltaSource 结构
<a name="aws-glue-api-visual-job-api-CatalogDeltaSource"></a>

指定在 AWS Glue Data Catalog 中注册的 Delta Lake 数据来源。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  Delta Lake 数据源的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库的名称。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库中的表的名称。
+ `AdditionalDeltaOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定其他连接选项。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 Delta Lake 源的数据架构。

## S3HudiSource 结构
<a name="aws-glue-api-visual-job-api-S3HudiSource"></a>

指定存储在 Amazon S3 中的 Hudi 数据来源。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  Hudi 源的名称。
+ `Paths` – *必填*：UTF-8 字符串数组。

  要从中进行读取的 Amazon S3 路径的列表。
+ `AdditionalHudiOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定其他连接选项。
+ `AdditionalOptions` – 一个 [S3DirectSourceAdditionalOptions](#aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions) 对象。

  为连接器指定其他选项。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 Hudi 源的数据架构。

## S3CatalogHudiSource 结构
<a name="aws-glue-api-visual-job-api-S3CatalogHudiSource"></a>

指定在 AWS Glue Data Catalog 中注册的 Hudi 数据来源。Hudi 数据来源必须存储在 Amazon S3 中。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据来源的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库的名称。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库中的表的名称。
+ `AdditionalHudiOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定其他连接选项。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 Hudi 源的数据架构。

## S3ExcelSource 结构
<a name="aws-glue-api-visual-job-api-S3ExcelSource"></a>

指定 S3 Excel 数据来源。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  S3 Excel 数据来源的名称。
+ `Paths` – *必填*：UTF-8 字符串数组。

  Excel 文件所在的 S3 路径。
+ `CompressionType` – UTF-8 字符串（有效值：`snappy="SNAPPY"` \$1`lzo="LZO"` \$1`gzip="GZIP"` \$1`brotli="BROTLI"` \$1`lz4="LZ4"` \$1`uncompressed="UNCOMPRESSED"` \$1`none="NONE"` ）。

  Excel 文件使用的压缩格式。
+ `Exclusions` – UTF-8 字符串数组。

  从处理中排除特定文件或路径的模式。
+ `GroupSize` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  定义批处理的文件组的大小。
+ `GroupFiles` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定如何对文件进行分组处理。
+ `Recurse` – 布尔值。

  指示是否递归处理子目录。
+ `MaxBand` – 数字（整数），至多为“无”。

  要使用的最大处理带数。
+ `MaxFilesInBand` – 数字（整数），至多为“无”。

  每个带中要处理的最大文件数。
+ `AdditionalOptions` – 一个 [S3DirectSourceAdditionalOptions](#aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions) 对象。

  S3 直接源处理的附加配置选项。
+ `NumberRows` – 数字（长型）。

  每个 Excel 文件要处理的行数。
+ `SkipFooter` – 数字（整数），至多为“无”。

  每个 Excel 文件末尾要跳过的行数。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  要应用于已处理数据的 AWS Glue 架构。

## CatalogHudiSource 结构
<a name="aws-glue-api-visual-job-api-CatalogHudiSource"></a>

指定在 AWS Glue Data Catalog 中注册的 Hudi 数据来源。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据来源的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库的名称。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库中的表的名称。
+ `AdditionalHudiOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定其他连接选项。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 Hudi 源的数据架构。

## DynamoDBCatalogSource 结构
<a name="aws-glue-api-visual-job-api-DynamoDBCatalogSource"></a>

指定 AWS Glue 数据目录中的一个 DynamoDB 数据源。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据源的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库的名称。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库中的表的名称。
+ `PitrEnabled` – 布尔值。

  指定是否为 DynamoDB 表启用时间点故障恢复（PITR）。设置为 `true` 时，允许从特定时间点读取。默认值为 `false`。
+ `AdditionalOptions` – 一个 [DDBELTCatalogAdditionalOptions](#aws-glue-api-visual-job-api-DDBELTCatalogAdditionalOptions) 对象。

  指定 DynamoDB 数据来源的其他连接选项。

## RelationalCatalogSource 结构
<a name="aws-glue-api-visual-job-api-RelationalCatalogSource"></a>

指定 AWS Glue 数据目录中的一个关系数据库数据源。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据源的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库的名称。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库中的表的名称。

## JDBCConnectorTarget 结构
<a name="aws-glue-api-visual-job-api-JDBCConnectorTarget"></a>

指定一个在 Apache Paric 列式存储中写入 Amazon S3 的数据目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为数据目标输入的节点。
+ `ConnectionName` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  与连接器关联的连接的名称。
+ `ConnectionTable` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  数据目标中表的名称。
+ `ConnectorName` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  将使用的连接器的名称。
+ `ConnectionType` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定指向 JDBC 数据目标的连接的连接类型，如 marketplace.jdbc 或 custom.jdbc。
+ `AdditionalOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  用于连接器的其他连接选项。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 JDBC 目标的数据架构。

## SparkConnectorTarget 结构
<a name="aws-glue-api-visual-job-api-SparkConnectorTarget"></a>

指定一个使用 Apache Spark 连接器的目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为数据目标输入的节点。
+ `ConnectionName` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  Apache Spark 连接器的连接名称。
+ `ConnectorName` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  Apache Spark 连接器的名称。
+ `ConnectionType` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定指向 Apache Spark 数据存储的连接的连接类型，如 marketplace.spark 或 custom.spark。
+ `AdditionalOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  用于连接器的其他连接选项。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定自定义 Spark 目标的数据架构。

## BasicCatalogTarget 结构
<a name="aws-glue-api-visual-job-api-BasicCatalogTarget"></a>

指定一个使用 AWS Glue 数据目录表的目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为数据目标输入的节点。
+ `PartitionKeys` – UTF-8 字符串数组。

  用于根据特定密钥或一组密钥在多个分区或分片之间分配数据的分区键。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  包含您要用作目标的表的数据库。此数据库必须已存在于数据目录中。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  定义输出数据架构的表。此表必须已存在于数据目录中。

## MySQLCatalogTarget 结构
<a name="aws-glue-api-visual-job-api-MySQLCatalogTarget"></a>

指定一个使用 MySQL 的目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为数据目标输入的节点。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要向其写入的数据库的名称。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要写入的数据库中的表的名称。

## PostgreSQLCatalogTarget 结构
<a name="aws-glue-api-visual-job-api-PostgreSQLCatalogTarget"></a>

指定一个使用 Postgres SQL 的目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为数据目标输入的节点。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要向其写入的数据库的名称。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要写入的数据库中的表的名称。

## OracleSQLCatalogTarget 结构
<a name="aws-glue-api-visual-job-api-OracleSQLCatalogTarget"></a>

指定一个使用 Oracle SQL 的目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为数据目标输入的节点。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要向其写入的数据库的名称。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要写入的数据库中的表的名称。

## MicrosoftSQLServerCatalogTarget 结构
<a name="aws-glue-api-visual-job-api-MicrosoftSQLServerCatalogTarget"></a>

指定一个使用 Microsoft SQL 的目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为数据目标输入的节点。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要向其写入的数据库的名称。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要写入的数据库中的表的名称。

## RedshiftTarget 结构
<a name="aws-glue-api-visual-job-api-RedshiftTarget"></a>

指定一个使用 Amazon Redshift 的目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为数据目标输入的节点。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要向其写入的数据库的名称。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要写入的数据库中的表的名称。
+ `RedshiftTmpDir` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  从数据库中复制时，可以用于暂存临时数据的 Amazon S3 路径。
+ `TmpDirIAMRole` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  拥有权限的 IAM 角色。
+ `UpsertRedshiftOptions` – 一个 [UpsertRedshiftTargetOptions](#aws-glue-api-visual-job-api-UpsertRedshiftTargetOptions) 对象。

  写入 Redshift 目标时用于配置 upsert 操作的一组选项。

## AmazonRedshiftTarget 结构
<a name="aws-glue-api-visual-job-api-AmazonRedshiftTarget"></a>

指定一个 Amazon Redshift 目标。

**Fields**
+ `Name` – UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  Amazon Redshift 目标的名称。
+ `Data` – 一个 [AmazonRedshiftNodeData](#aws-glue-api-visual-job-api-AmazonRedshiftNodeData) 对象。

  指定 Amazon Redshift 目标节点的数据。
+ `Inputs` – UTF-8 字符串数组，不少于 1 个字符串，不超过 1 个字符串。

  作为数据目标输入的节点。

## UpsertRedshiftTargetOptions 结构
<a name="aws-glue-api-visual-job-api-UpsertRedshiftTargetOptions"></a>

写入 Redshift 目标时用于配置 upsert 操作的选项。

**Fields**
+ `TableLocation` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  Redshift 表的物理位置。
+ `ConnectionName` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  用于写入 Redshift 的连接的名称。
+ `UpsertKeys` – UTF-8 字符串数组。

  用于确定是执行更新还是插入的键。

## S3CatalogTarget 结构
<a name="aws-glue-api-visual-job-api-S3CatalogTarget"></a>

指定一个使用 AWS Glue 数据目录写入 Amazon S3 的数据目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为数据目标输入的节点。
+ `PartitionKeys` – UTF-8 字符串数组。

  使用一系列键指定本机分区。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要写入的数据库中的表的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要向其写入的数据库的名称。
+ `SchemaChangePolicy` – 一个 [CatalogSchemaChangePolicy](#aws-glue-api-visual-job-api-CatalogSchemaChangePolicy) 对象。

  一项指定爬网程序的更新行为的策略。
+ `AutoDataQuality` – 一个 [AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality) 对象。

  指定是否为 S3 目录目标自动启用数据质量评估。设置为 `true` 时，则在写入操作期间自动执行数据质量检查。

## S3GlueParquetTarget 结构
<a name="aws-glue-api-visual-job-api-S3GlueParquetTarget"></a>

指定一个在 Apache Paric 列式存储中写入 Amazon S3 的数据目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为数据目标输入的节点。
+ `PartitionKeys` – UTF-8 字符串数组。

  使用一系列键指定本机分区。
+ `Path` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要写入的单个 Amazon S3 路径。
+ `Compression` – UTF-8 字符串（有效值：`snappy="SNAPPY"` \$1`lzo="LZO"` \$1`gzip="GZIP"` \$1`brotli="BROTLI"` \$1`lz4="LZ4"` \$1`uncompressed="UNCOMPRESSED"` \$1`none="NONE"` ）。

  指定数据压缩方式。通常，如果数据有标准文件扩展名，则不需要指定。可能的值为 `"gzip"` 和 `"bzip"`。
+ `NumberTargetPartitions` – UTF-8 字符串。

  指定使用 AWS Glue 写入 Amazon S3 时 Parquet 文件的目标分区数。
+ `SchemaChangePolicy` – 一个 [DirectSchemaChangePolicy](#aws-glue-api-visual-job-api-DirectSchemaChangePolicy) 对象。

  一项指定爬网程序的更新行为的策略。
+ `AutoDataQuality` – 一个 [AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality) 对象。

  指定是否为 S3 AWS Glue Parquet 目标自动启用数据质量评估。设置为 `true` 时，则在写入操作期间自动执行数据质量检查。

## CatalogSchemaChangePolicy 结构
<a name="aws-glue-api-visual-job-api-CatalogSchemaChangePolicy"></a>

一项指定爬网程序的更新行为的策略。

**Fields**
+ `EnableUpdateCatalog` – 布尔值。

  当爬网程序发现已更改的架构时，是否使用指定的更新行为。
+ `UpdateBehavior` – UTF-8 字符串（有效值：`UPDATE_IN_DATABASE` \$1`LOG` ）。

  爬网程序发现已更改的架构时的更新行为。

## S3DirectTarget 结构
<a name="aws-glue-api-visual-job-api-S3DirectTarget"></a>

指定一个写入 Amazon S3 的数据目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为数据目标输入的节点。
+ `PartitionKeys` – UTF-8 字符串数组。

  使用一系列键指定本机分区。
+ `Path` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要写入的单个 Amazon S3 路径。
+ `Compression` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定数据压缩方式。通常，如果数据有标准文件扩展名，则不需要指定。可能的值为 `"gzip"` 和 `"bzip"`。
+ `NumberTargetPartitions` – UTF-8 字符串。

  指定将数据直接写入 Amazon S3 时的目标分区数。
+ `Format` – *必填：*UTF-8 字符串（有效值：`json="JSON"` \$1 `csv="CSV"` \$1 `avro="AVRO"` \$1 `orc="ORC"` \$1 `parquet="PARQUET"` \$1 `hudi="HUDI"` \$1 `delta="DELTA"` \$1 `iceberg="ICEBERG"` \$1 `hyper="HYPER"` \$1 `xml="XML"`）。

  指定目标的数据输出格式。
+ `SchemaChangePolicy` – 一个 [DirectSchemaChangePolicy](#aws-glue-api-visual-job-api-DirectSchemaChangePolicy) 对象。

  一项指定爬网程序的更新行为的策略。
+ `AutoDataQuality` – 一个 [AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality) 对象。

  指定是否为 S3 直接目标自动启用数据质量评估。设置为 `true` 时，则在写入操作期间自动执行数据质量检查。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 S3 直接目标的数据架构。

## S3HudiCatalogTarget 结构
<a name="aws-glue-api-visual-job-api-S3HudiCatalogTarget"></a>

在 AWS Glue Data Catalog 中指定写入 Hudi 数据来源的目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为数据目标输入的节点。
+ `PartitionKeys` – UTF-8 字符串数组。

  使用一系列键指定本机分区。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要写入的数据库中的表的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要向其写入的数据库的名称。
+ `AdditionalOptions` – *必填*：键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定用于连接器的其他连接选项。
+ `SchemaChangePolicy` – 一个 [CatalogSchemaChangePolicy](#aws-glue-api-visual-job-api-CatalogSchemaChangePolicy) 对象。

  一项指定爬网程序的更新行为的策略。
+ `AutoDataQuality` – 一个 [AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality) 对象。

  指定是否为 S3 Hudi 目录目标自动启用数据质量评估。设置为 `true` 时，则在写入操作期间自动执行数据质量检查。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 S3 Hudi 目录目标的数据架构。

## S3HudiDirectTarget 结构
<a name="aws-glue-api-visual-job-api-S3HudiDirectTarget"></a>

指定在 Amazon S3 中写入 Hudi 数据来源的目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为数据目标输入的节点。
+ `Path` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要写入的 Hudi 数据来源的Amazon S3 路径。
+ `Compression` – *必填*：UTF-8 字符串（有效值：`gzip="GZIP"` \$1 `lzo="LZO"` \$1 `uncompressed="UNCOMPRESSED"` \$1 `snappy="SNAPPY"`）。

  指定数据压缩方式。通常，如果数据有标准文件扩展名，则不需要指定。可能的值为 `"gzip"` 和 `"bzip"`。
+ `NumberTargetPartitions` – UTF-8 字符串。

  指定在 Amazon S3 上分发 Hudi 数据集文件的目标分区数。
+ `PartitionKeys` – UTF-8 字符串数组。

  使用一系列键指定本机分区。
+ `Format` – *必填：*UTF-8 字符串（有效值：`json="JSON"` \$1 `csv="CSV"` \$1 `avro="AVRO"` \$1 `orc="ORC"` \$1 `parquet="PARQUET"` \$1 `hudi="HUDI"` \$1 `delta="DELTA"` \$1 `iceberg="ICEBERG"` \$1 `hyper="HYPER"` \$1 `xml="XML"`）。

  指定目标的数据输出格式。
+ `AdditionalOptions` – *必填*：键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定用于连接器的其他连接选项。
+ `SchemaChangePolicy` – 一个 [DirectSchemaChangePolicy](#aws-glue-api-visual-job-api-DirectSchemaChangePolicy) 对象。

  一项指定爬网程序的更新行为的策略。
+ `AutoDataQuality` – 一个 [AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality) 对象。

  指定是否为 S3 Hudi 直接目标自动启用数据质量评估。设置为 `true` 时，则在写入操作期间自动执行数据质量检查。

## S3DeltaCatalogTarget 结构
<a name="aws-glue-api-visual-job-api-S3DeltaCatalogTarget"></a>

在 AWS Glue Data Catalog 中指定写入 Delta Lake 数据来源的目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为数据目标输入的节点。
+ `PartitionKeys` – UTF-8 字符串数组。

  使用一系列键指定本机分区。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要写入的数据库中的表的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要向其写入的数据库的名称。
+ `AdditionalOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定用于连接器的其他连接选项。
+ `SchemaChangePolicy` – 一个 [CatalogSchemaChangePolicy](#aws-glue-api-visual-job-api-CatalogSchemaChangePolicy) 对象。

  一项指定爬网程序的更新行为的策略。
+ `AutoDataQuality` – 一个 [AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality) 对象。

  指定是否为 S3 Delta 目录目标自动启用数据质量评估。设置为 `true` 时，则在写入操作期间自动执行数据质量检查。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 S3 Delta 目录目标的数据架构。

## S3DeltaDirectTarget 结构
<a name="aws-glue-api-visual-job-api-S3DeltaDirectTarget"></a>

在 Amazon S3 中指定写入 Delta Lake 数据来源的目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为数据目标输入的节点。
+ `PartitionKeys` – UTF-8 字符串数组。

  使用一系列键指定本机分区。
+ `Path` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要写入的 Delta Lake 数据来源的 Amazon S3 路径。
+ `Compression` – *必填：*UTF-8 字符串（有效值：`uncompressed="UNCOMPRESSED"` \$1 `snappy="SNAPPY"`）。

  指定数据压缩方式。通常，如果数据有标准文件扩展名，则不需要指定。可能的值为 `"gzip"` 和 `"bzip"`。
+ `NumberTargetPartitions` – UTF-8 字符串。

  指定在 Amazon S3 上分发 Delta Lake 数据集文件的目标分区数。
+ `Format` – *必填：*UTF-8 字符串（有效值：`json="JSON"` \$1 `csv="CSV"` \$1 `avro="AVRO"` \$1 `orc="ORC"` \$1 `parquet="PARQUET"` \$1 `hudi="HUDI"` \$1 `delta="DELTA"` \$1 `iceberg="ICEBERG"` \$1 `hyper="HYPER"` \$1 `xml="XML"`）。

  指定目标的数据输出格式。
+ `AdditionalOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定用于连接器的其他连接选项。
+ `SchemaChangePolicy` – 一个 [DirectSchemaChangePolicy](#aws-glue-api-visual-job-api-DirectSchemaChangePolicy) 对象。

  一项指定爬网程序的更新行为的策略。
+ `AutoDataQuality` – 一个 [AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality) 对象。

  指定是否为 S3 Delta 直接目标自动启用数据质量评估。设置为 `true` 时，则在写入操作期间自动执行数据质量检查。

## S3HyperDirectTarget 结构
<a name="aws-glue-api-visual-job-api-S3HyperDirectTarget"></a>

指定写入 Amazon S3 的 HyperDirect 数据目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  HyperDirect 目标节点的唯一标识符。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  指定 HyperDirect 目标的输入源。
+ `Format` - UTF-8 字符串（有效值：`json="JSON"` \$1`csv="CSV"` \$1`avro="AVRO"` \$1`orc="ORC"` \$1`parquet="PARQUET"` \$1`hudi="HUDI"` \$1`delta="DELTA"` \$1`iceberg="ICEBERG"` \$1`hyper="HYPER"` \$1`xml="XML"` ）。

  指定 HyperDirect 目标的数据输出格式。
+ `PartitionKeys` – UTF-8 字符串数组。

  定义输出数据的分区策略。
+ `Path` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  将写入输出数据的 S3 位置。
+ `Compression` – UTF-8 字符串（有效值：`uncompressed="UNCOMPRESSED"`）。

  应用于输出数据的压缩类型。
+ `SchemaChangePolicy` – 一个 [DirectSchemaChangePolicy](#aws-glue-api-visual-job-api-DirectSchemaChangePolicy) 对象。

  定义在写入操作期间如何处理架构更改。
+ `AutoDataQuality` – 一个 [AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality) 对象。

  指定是否为 S3 Hyper 直接目标自动启用数据质量评估。设置为 `true` 时，则在写入操作期间自动执行数据质量检查。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 S3 Hyper 直接目标的数据架构。

## S3IcebergDirectTarget 结构
<a name="aws-glue-api-visual-job-api-S3IcebergDirectTarget"></a>

指定写入 Amazon S3 中的 Iceberg 数据来源的目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  指定数据管道中的 Iceberg 目标节点的唯一标识符。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  定义为此 Iceberg 目标提供数据的单一输入源。
+ `PartitionKeys` – UTF-8 字符串数组。

  指定用于对 S3 中的 Iceberg 表数据进行分区的列。
+ `Path` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  定义将存储 Iceberg 表数据的 S3 位置。
+ `Format` – *必填：*UTF-8 字符串（有效值：`json="JSON"` \$1 `csv="CSV"` \$1 `avro="AVRO"` \$1 `orc="ORC"` \$1 `parquet="PARQUET"` \$1 `hudi="HUDI"` \$1 `delta="DELTA"` \$1 `iceberg="ICEBERG"` \$1 `hyper="HYPER"` \$1 `xml="XML"`）。

  指定用于存储 Iceberg 表数据的文件格式（例如，Parquet、ORC）。
+ `AdditionalOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  提供用于自定义 Iceberg 表行为的附加配置选项。
+ `SchemaChangePolicy` – 一个 [DirectSchemaChangePolicy](#aws-glue-api-visual-job-api-DirectSchemaChangePolicy) 对象。

  定义将数据写入 Iceberg 表时如何处理架构更改。
+ `Compression` – *必填*：UTF-8 字符串（有效值：`gzip="GZIP"` \$1 `lzo="LZO"` \$1 `uncompressed="UNCOMPRESSED"` \$1 `snappy="SNAPPY"`）。

  指定 S3 中 Iceberg 表文件使用的压缩编解码器。
+ `NumberTargetPartitions` – UTF-8 字符串。

  设置在 S3 上分发 Iceberg 表文件的目标分区数。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 S3 Iceberg 直接目标的数据架构。

## DirectSchemaChangePolicy 结构
<a name="aws-glue-api-visual-job-api-DirectSchemaChangePolicy"></a>

一项指定爬网程序的更新行为的策略。

**Fields**
+ `EnableUpdateCatalog` – 布尔值。

  当爬网程序发现已更改的架构时，是否使用指定的更新行为。
+ `UpdateBehavior` – UTF-8 字符串（有效值：`UPDATE_IN_DATABASE` \$1`LOG` ）。

  爬网程序发现已更改的架构时的更新行为。
+ `Table` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定应用架构更改策略的数据库中的表。
+ `Database` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定应用架构更改策略的数据库。

## ApplyMapping 结构
<a name="aws-glue-api-visual-job-api-ApplyMapping"></a>

指定一个将数据源中的数据属性键映射到数据目标中的数据属性键的转换。您可以重命名键、修改键的数据类型以及选择要从数据集中删除的键。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  转换节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  通过其节点名称标识的数据输入。
+ `Mapping` – *必填：*[Mapping](#aws-glue-api-visual-job-api-Mapping) 对象的数组。

  指定数据源中的数据属性键与数据目标中的数据属性键的映射。

## Mapping 结构
<a name="aws-glue-api-visual-job-api-Mapping"></a>

指定数据属性键的映射。

**Fields**
+ `ToKey` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  应用映射之后，列的名称应该是什么。可与 `FromPath` 相同。
+ `FromPath` – UTF-8 字符串数组。

  要修改的表或列。
+ `FromType` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要修改的数据的类型。
+ `ToType` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要修改的数据的数据类型。
+ `Dropped` – 布尔值。

  如果为 true（真），则删除列。
+ `Children` – [Mapping](#aws-glue-api-visual-job-api-Mapping) 对象的数组。

  仅适用于嵌套数据结构。如果要更改父结构，但也要更改其子结构之一，则可填写此数据结构。它也是 `Mapping`，但其 `FromPath` 将是父结构的 `FromPath` 再加上来自此结构的 `FromPath`。

  对于子部分，假设您拥有结构：

  `{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }`

  您可以指定一个类似如下的 `Mapping`：

  `{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }`

## SelectFields 结构
<a name="aws-glue-api-visual-job-api-SelectFields"></a>

指定一个选择要保留的数据属性键的转换。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  转换节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  通过其节点名称标识的数据输入。
+ `Paths` – *必填*：UTF-8 字符串数组。

  指向数据结构中变量的 JSON 路径。

## DropFields 结构
<a name="aws-glue-api-visual-job-api-DropFields"></a>

指定一个选择要删除的数据属性键的转换。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  转换节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  通过其节点名称标识的数据输入。
+ `Paths` – *必填*：UTF-8 字符串数组。

  指向数据结构中变量的 JSON 路径。

## RenameField 结构
<a name="aws-glue-api-visual-job-api-RenameField"></a>

指定一个重命名单个数据属性键的转换。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  转换节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  通过其节点名称标识的数据输入。
+ `SourcePath` – *必填*：UTF-8 字符串数组。

  指向源数据的数据结构中变量的 JSON 路径。
+ `TargetPath` – *必填*：UTF-8 字符串数组。

  指向目标数据的数据结构中变量的 JSON 路径。

## Spigot 结构
<a name="aws-glue-api-visual-job-api-Spigot"></a>

指定一个将数据样本写入 Amazon S3 存储桶的转换。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  转换节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  通过其节点名称标识的数据输入。
+ `Path` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  Amazon S3 中的一个路径，在该路径中，转换会将数据集中的记录子集写入 Amazon S3 存储桶中的 JSON 文件。
+ `Topk` – 数字（整型），不超过 100。

  指定从数据集开头开始写入的一些记录。
+ `Prob` – 数字（双精度），不超过 1。

  选择任何给定记录的概率（最大值为 1 的十进制值）。值 1 表示从数据集中读取的每一行都应包括在示例输出中。

## Join 结构
<a name="aws-glue-api-visual-job-api-Join"></a>

指定一个转换，它将使用指定数据属性键上的比较短语将两个数据集联接到一个数据集。您可以使用内部、外部、左、右、左半和左反联接。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  转换节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 2 个或不超过 2 个字符串。

  通过其节点名称标识的数据输入。
+ `JoinType` – *必填：*UTF-8 字符串（有效值：`equijoin="EQUIJOIN"` \$1 `left="LEFT"` \$1 `right="RIGHT"` \$1 `outer="OUTER"` \$1 `leftsemi="LEFT_SEMI"` \$1 `leftanti="LEFT_ANTI"`）。

  指定要针对数据集执行的联接的类型。
+ `Columns` – *必填*：[JoinColumn](#aws-glue-api-visual-job-api-JoinColumn) 对象的数组，不少于 2 个或不超过 2 个结构。

  要联接的两列的列表。

## JoinColumn 结构
<a name="aws-glue-api-visual-job-api-JoinColumn"></a>

指定一个要联接的列。

**Fields**
+ `From` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要联接的列。
+ `Keys` – *必填*：UTF-8 字符串数组。

  要联接的列的键。

## SplitFields 结构
<a name="aws-glue-api-visual-job-api-SplitFields"></a>

指定一个将数据属性键拆分为两个 `DynamicFrames` 的转换。输出是 `DynamicFrames` 的集合：一个包含选定的数据属性键，另一个包含剩余的数据属性键。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  转换节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  通过其节点名称标识的数据输入。
+ `Paths` – *必填*：UTF-8 字符串数组。

  指向数据结构中变量的 JSON 路径。

## SelectFromCollection 结构
<a name="aws-glue-api-visual-job-api-SelectFromCollection"></a>

指定一个从 `DynamicFrames` 的集合中选择一个 `DynamicFrame` 的转换。输出是选定的 `DynamicFrame`

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  转换节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  通过其节点名称标识的数据输入。
+ `Index` – *必填：*数字（整数），至多为“无”。

  要选择的 DynamicFrame 的索引。

## FillMissingValues 结构
<a name="aws-glue-api-visual-job-api-FillMissingValues"></a>

指定一个转换，它将查找数据集中缺少值的记录，并添加包含通过推算确定的值的新字段。输入数据集用于训练机器学习模型，该模型确定缺失值应该是什么。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  转换节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  通过其节点名称标识的数据输入。
+ `ImputedPath` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指向推算的数据集的数据结构中变量的 JSON 路径。
+ `FilledPath` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指向被填充的数据集的数据结构中变量的 JSON 路径。

## Filter 结构
<a name="aws-glue-api-visual-job-api-Filter"></a>

指定一个转换，它将基于筛选条件将一个数据集拆分为两个。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  转换节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  通过其节点名称标识的数据输入。
+ `LogicalOperator` – *必填：*UTF-8 字符串（有效值：`AND` \$1 `OR`）。

  用于通过将键值与指定值进行比较来筛选行的运算符。
+ `Filters` – *必填：*[FilterExpression](#aws-glue-api-visual-job-api-FilterExpression) 对象的数组。

  指定一个筛选条件表达式。

## FilterExpression 结构
<a name="aws-glue-api-visual-job-api-FilterExpression"></a>

指定一个筛选条件表达式。

**Fields**
+ `Operation` – *必填*：UTF-8 字符串（有效值：`EQ` \$1 `LT` \$1 `GT` \$1 `LTE` \$1 `GTE` \$1 `REGEX` \$1 `ISNULL`）。

  要在该表达式中执行的操作的类型。
+ `Negated` – 布尔值。

  是否要否定该表达式。
+ `Values` – *必填：*[FilterValue](#aws-glue-api-visual-job-api-FilterValue) 对象的数组。

  筛选条件值的列表。

## FilterValue 结构
<a name="aws-glue-api-visual-job-api-FilterValue"></a>

表示 `FilterExpression` 的值的列表中的单个条目。

**Fields**
+ `Type` – *必填：*UTF-8 字符串（有效值：`COLUMNEXTRACTED` \$1 `CONSTANT`）。

  筛选条件值的类型。
+ `Value` – *必填*：UTF-8 字符串数组。

  要关联的值。

## CustomCode 结构
<a name="aws-glue-api-visual-job-api-CustomCode"></a>

指定一个转换，它将使用您提供的自定义代码执行数据转换。输出是 DynamicFrames 的集合。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  转换节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，至少 1 个字符串。

  通过其节点名称标识的数据输入。
+ `Code` – *必填：* UTF-8 字符串，与 [Custom string pattern #54](aws-glue-api-common.md#regex_54) 匹配。

  用于执行数据转换的自定义代码。
+ `ClassName` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  为自定义代码节点类定义的名称。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定自定义代码转换的数据架构。

## SparkSQL 结构
<a name="aws-glue-api-visual-job-api-SparkSQL"></a>

指定一个转换，您可以在其中使用 Spark SQL 语法输入 SQL 查询以转换数据。输出为单个 `DynamicFrame`。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  转换节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，至少 1 个字符串。

  通过其节点名称标识的数据输入。您可以将表名称与要在 SQL 查询中使用的每个输入节点关联起来。您选择的名称必须满足 Spark SQL 命名限制。
+ `SqlQuery` – *必填：* UTF-8 字符串，与 [Custom string pattern #62](aws-glue-api-common.md#regex_62) 匹配。

  必须使用 Spark SQL 语法并返回单个数据集的 SQL 查询。
+ `SqlAliases` – *必填：*[SQLAlias](#aws-glue-api-visual-job-api-SqlAlias) 对象的数组。

  别名列表。别名允许您指定在 SQL 中为给定输入使用什么名称。例如，您拥有一个名为“MyDataSource”的数据源。如果您指定 `From` 作为 MyDataSource，以及 `Alias` 作为 SqlName，则您在 SQL 中可以执行以下操作：

  `select * from SqlName`

  而这将从 MyDataSource 获取数据。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 SparkSQL 转换的数据架构。

## SqlAlias 结构
<a name="aws-glue-api-visual-job-api-SqlAlias"></a>

表示 `SqlAliases` 的值的列表中的单个条目。

**Fields**
+ `From` – *必填：* UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  表，或表中的列。
+ `Alias` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  为表或表中的列提供的临时名称。

## DropNullFields 结构
<a name="aws-glue-api-visual-job-api-DropNullFields"></a>

指定一个转换，如果列中的所有值均为“null”，则该转换将从数据集中删除这些列。预设情况下，AWS Glue Studio 将识别 null 对象，但是某些值，如空字符串、“null”字符串、-1 整数或其他占位符（如零），不会被自动识别为 null。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  转换节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  通过其节点名称标识的数据输入。
+ `NullCheckBoxList` – 一个 [NullCheckBoxList](#aws-glue-api-visual-job-api-NullCheckBoxList) 对象。

  一种结构，它表示是否将某些值识别为要删除的 null 值。
+ `NullTextList` – [NullValueField](#aws-glue-api-visual-job-api-NullValueField) 对象的数组，不超过 50 个结构。

  一种结构，它指定 NullValueField 结构的列表，这些结构表示自定义 null 值，如零值或其他值，用作数据集唯一的 null 占位符。

  仅当 null 占位符的值和数据类型与数据匹配时，`DropNullFields` 转换才会删除自定义 null 值。

## NullCheckBoxList 结构
<a name="aws-glue-api-visual-job-api-NullCheckBoxList"></a>

表示某些值是否被识别为要删除的 null 值。

**Fields**
+ `IsEmpty` – 布尔值。

  指定将一个空字符串视为 null 值。
+ `IsNullString` – 布尔值。

  指定将一个拼写“null”一词的值视为 null 值。
+ `IsNegOne` – 布尔值。

  指定将一个为 -1 的整数值视为 null 值。

## NullValueField 结构
<a name="aws-glue-api-visual-job-api-NullValueField"></a>

表示自定义 null 值，如零值或其他值，用作数据集唯一的 null 占位符。

**Fields**
+ `Value` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  null 占位符的值。
+ `Datatype` – *必填：*一个 [DataType](#aws-glue-api-visual-job-api-Datatype) 对象。

  值的数据类型。

## Datatype 结构
<a name="aws-glue-api-visual-job-api-Datatype"></a>

表示值的数据类型的结构。

**Fields**
+ `Id` – *必填：* UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  值的数据类型。
+ `Label` – *必填：* UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  分配给 datatype（数据类型）的标签。

## Merge 结构
<a name="aws-glue-api-visual-job-api-Merge"></a>

指定一个转换，它将基于指定的主键将 `DynamicFrame` 与暂存 `DynamicFrame` 合并以标识记录。不会对重复记录（具有相同主键的记录）去除重复。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  转换节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 2 个或不超过 2 个字符串。

  通过其节点名称标识的数据输入。
+ `Source` – *必填：* UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  将与暂存 `DynamicFrame` 合并的源 `DynamicFrame`。
+ `PrimaryKeys` – *必填*：UTF-8 字符串数组。

  要匹配源和暂存动态帧中的记录的主键字段列表。

## Union 结构
<a name="aws-glue-api-visual-job-api-Union"></a>

指定一个转换，它将两个或更多数据集中的行合并到单个结果中。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  转换节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 2 个或不超过 2 个字符串。

  节点 ID 输入到转换。
+ `UnionType` – *必填：*UTF-8 字符串（有效值：`ALL` \$1 `DISTINCT`）。

  指示 Union 转换的类型。

  指定 `ALL` 将数据源中的所有行联接到生成的 DynamicFrame。生成的并集不会删除重复行。

  指定 `DISTINCT` 删除生成的 DynamicFrame 中的重复行。

## PIIDetection 结构
<a name="aws-glue-api-visual-job-api-PIIDetection"></a>

指定用于识别、删除或掩盖 PII 数据的转换。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  转换节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  节点 ID 输入到转换。
+ `PiiType` – *必填*：UTF-8 字符串（有效值：`RowAudit` \$1 `RowHashing` \$1 `RowMasking` \$1 `RowPartialMasking` \$1 `ColumnAudit` \$1 `ColumnHashing` \$1 `ColumnMasking`）。

  指示 PIIDetection 转换的类型。
+ `EntityTypesToDetect` – *必填*：UTF-8 字符串数组。

  指示 PIIDetection 转换将标识为 PII 数据的实体类型。

   PII 类型的实体包括：PERSON\$1NAME、DATE、USA\$1SNN、EMAIL、USA\$1ITIN、USA\$1PASSPORT\$1NUMBER、PHONE\$1NUMBER、BANK\$1ACCOUNT、IP\$1ADDRESS、MAC\$1ADDRESS、USA\$1CPT\$1CODE、USA\$1HCPCS\$1CODE、USA\$1NATIONAL\$1DRUG\$1CODE、USA\$1MEDICARE\$1BENEFICIARY\$1IDENTIFIER、USA\$1HEALTH\$1INSURANCE\$1CLAIM\$1NUMBER、CREDIT\$1CARD、USA\$1NATIONAL\$1PROVIDER\$1IDENTIFIER、USA\$1DEA\$1NUMBER、USA\$1DRIVING\$1LICENSE 
+ `OutputColumnName` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指示包含该行中检测到的任何实体类型的输出列名称。
+ `SampleFraction` – 数字（双精度），不超过 1。

  指示要在扫描 PII 实体时采样的数据的部分。
+ `ThresholdFraction` – 数字（双精度），不超过 1。

  指示要将列标识为 PII 数据所必须满足的数据部分。
+ `MaskValue` – UTF-8 字符串，长度不超过 256 个字节，与 [Custom string pattern #58](aws-glue-api-common.md#regex_58) 匹配。

  指示将替代检测到的实体的值。
+ `RedactText` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定是否对检测到的 PII 文本进行脱敏处理。设置为 `true` 时，PII 内容将替换为脱敏字符。
+ `RedactChar` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  启用脱敏时用于替换检测到的 PII 内容的字符。默认的脱敏字符为 `*`。
+ `MatchPattern` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  用于识别标准检测算法之外其他 PII 内容的正则表达式模式。
+ `NumLeftCharsToExclude` – 数字（整数），至多为“无”。

  在检测到的 PII 内容左侧保留不被脱敏的字符数。设置允许保留敏感数据周围的上下文信息。
+ `NumRightCharsToExclude` – 数字（整数），至多为“无”。

  在检测到的 PII 内容右侧保留不被脱敏的字符数。设置允许保留敏感数据周围的上下文信息。
+ `DetectionParameters` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  用于配置 PII 检测行为及敏感度设置的附加参数。
+ `DetectionSensitivity` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  PII 检测行为的敏感度级别。敏感度级别越高，可检测到的潜在 PII 内容就越多，但导致的误报可能也更多。

## Aggregate 结构
<a name="aws-glue-api-visual-job-api-Aggregate"></a>

指定一个转换，用于按选定字段对行进行分组并通过指定函数计算聚合值。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  转换节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  指定要用作聚合转换输入的字段和行。
+ `Groups` – *必填*：UTF-8 字符串数组。

  指定要对其进行分组的字段。
+ `Aggs`：*必填：*[聚合操作](#aws-glue-api-visual-job-api-AggregateOperation) 对象的数组，不少于 1 个或不超过 30 个结构。

  指定要对指定字段执行的聚合函数。

## DropDuplicates 结构
<a name="aws-glue-api-visual-job-api-DropDuplicates"></a>

指定一个用于从数据集中删除重复数据行的转换。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  转换节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  通过其节点名称标识的数据输入。
+ `Columns` – UTF-8 字符串数组。

  重复时需要合并或删除的列的名称。

## GovernedCatalogTarget 结构
<a name="aws-glue-api-visual-job-api-GovernedCatalogTarget"></a>

指定一个使用 AWS Glue 数据目录写入 Amazon S3 的数据目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为数据目标输入的节点。
+ `PartitionKeys` – UTF-8 字符串数组。

  使用一系列键指定本机分区。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要写入的数据库中的表的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要向其写入的数据库的名称。
+ `SchemaChangePolicy` – 一个 [CatalogSchemaChangePolicy](#aws-glue-api-visual-job-api-CatalogSchemaChangePolicy) 对象。

  用于指定监管目录的更新行为的策略。

## GovernedCatalogSource 结构
<a name="aws-glue-api-visual-job-api-GovernedCatalogSource"></a>

指定监管 AWS Glue 数据目录中的一个数据存储。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据存储的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库表。
+ `PartitionPredicate` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  满足此谓词的分区将被删除。这些分区中保留期内的文件不会被删除。设置为 `""` – 默认情况下为空。
+ `AdditionalOptions` – 一个 [S3SourceAdditionalOptions](#aws-glue-api-visual-job-api-S3SourceAdditionalOptions) 对象。

  指定其他连接选项。

## 聚合操作结构
<a name="aws-glue-api-visual-job-api-AggregateOperation"></a>

指定在聚合转换中执行聚合所需的一组参数。

**Fields**
+ `Column` – *必填*：UTF-8 字符串数组。

  指定数据集上将应用聚合函数的列。
+ `AggFunc`：*必填：*UTF-8 字符串（有效值：`avg` \$1 `countDistinct` \$1 `count` \$1 `first` \$1 `last` \$1 `kurtosis` \$1 `max` \$1 `min` \$1 `skewness` \$1 `stddev_samp` \$1 `stddev_pop` \$1 `sum` \$1 `sumDistinct` \$1 `var_samp` \$1 `var_pop`）。

  指定要应用的聚合函数。

  可能的聚合函数包括：avg countDinstinct、count、first、last、kurtosis、max、min、skewness、stddev\$1samp、stddev\$1pop、sum、sumDistinct、var\$1samp、var\$1pop

## GlueSchema 结构
<a name="aws-glue-api-visual-job-api-GlueSchema"></a>

在无法确定架构时，指定一个用户定义的架构 AWS Glue。

**Fields**
+ `Columns` – [GlueStudioSchemaColumn](#aws-glue-api-visual-job-api-GlueStudioSchemaColumn) 对象的数组。

  指定组成 AWS Glue 架构的列定义。

## GlueStudioSchemaColumn 结构
<a name="aws-glue-api-visual-job-api-GlueStudioSchemaColumn"></a>

指定 AWS Glue 架构定义中的单个列。

**Fields**
+ `Name` – *必填：*UTF-8 字符串，长度不超过 1024 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  AWS Glue Studio 架构中的列名称。
+ `Type` – UTF-8 字符串，不超过 131072 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  AWS Glue Studio 架构中此列的 Hive 类型。
+ `GlueStudioType` – UTF-8 字符串，不超过 131072 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  AWS Glue Studio 中定义的列的数据类型。

## GlueStudioColumn 结构
<a name="aws-glue-api-visual-job-api-GlueStudioColumn"></a>

指定 AWS Glue Studio 中的单个列。

**Fields**
+ `Key` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  AWS Glue Studio 中的列的键。
+ `FullPath` – *必填*：UTF-8 字符串数组。

  AWS Glue Studio 中的列的完整 URL。
+ `Type` – *必填：* UTF-8 字符串（有效值：`array="ARRAY"` \$1 `bigint="BIGINT"` \$1 `bigint array="BIGINT_ARRAY"` \$1 `binary="BINARY"` \$1 `binary array="BINARY_ARRAY"` \$1 `boolean="BOOLEAN"` \$1 `boolean array="BOOLEAN_ARRAY"` \$1 `byte="BYTE"` \$1 `byte array="BYTE_ARRAY"` \$1 `char="CHAR"` \$1 `char array="CHAR_ARRAY"` \$1 `choice="CHOICE"` \$1 `choice array="CHOICE_ARRAY"` \$1 `date="DATE"` \$1 `date array="DATE_ARRAY"` \$1 `decimal="DECIMAL"` \$1 `decimal array="DECIMAL_ARRAY"` \$1 `double="DOUBLE"` \$1 `double array="DOUBLE_ARRAY"` \$1 `enum="ENUM"` \$1 `enum array="ENUM_ARRAY"` \$1 `float="FLOAT"` \$1 `float array="FLOAT_ARRAY"` \$1 `int="INT"` \$1 `int array="INT_ARRAY"` \$1 `interval="INTERVAL"` \$1 `interval array="INTERVAL_ARRAY"` \$1 `long="LONG"` \$1 `long array="LONG_ARRAY"` \$1 `object="OBJECT"` \$1 `short="SHORT"` \$1 `short array="SHORT_ARRAY"` \$1 `smallint="SMALLINT"` \$1 `smallint array="SMALLINT_ARRAY"` \$1 `string="STRING"` \$1 `string array="STRING_ARRAY"` \$1 `timestamp="TIMESTAMP"` \$1 `timestamp array="TIMESTAMP_ARRAY"` \$1 `tinyint="TINYINT"` \$1 `tinyint array="TINYINT_ARRAY"` \$1 `varchar="VARCHAR"` \$1 `varchar array="VARCHAR_ARRAY"` \$1 `null="NULL"` \$1 `unknown="UNKNOWN"` \$1 `unknown array="UNKNOWN_ARRAY"`）。

  AWS Glue Studio 中的列的类型。
+ `Children` – 结构数组。

  AWS Glue Studio 中的父列的子项。
+ `GlueStudioType` – UTF-8 字符串（有效值：`array="ARRAY"` \$1 `bigint="BIGINT"` \$1 `bigint array="BIGINT_ARRAY"` \$1 `binary="BINARY"` \$1 `binary array="BINARY_ARRAY"` \$1 `boolean="BOOLEAN"` \$1 `boolean array="BOOLEAN_ARRAY"` \$1 `byte="BYTE"` \$1 `byte array="BYTE_ARRAY"` \$1 `char="CHAR"` \$1 `char array="CHAR_ARRAY"` \$1 `choice="CHOICE"` \$1 `choice array="CHOICE_ARRAY"` \$1 `date="DATE"` \$1 `date array="DATE_ARRAY"` \$1 `decimal="DECIMAL"` \$1 `decimal array="DECIMAL_ARRAY"` \$1 `double="DOUBLE"` \$1 `double array="DOUBLE_ARRAY"` \$1 `enum="ENUM"` \$1 `enum array="ENUM_ARRAY"` \$1 `float="FLOAT"` \$1 `float array="FLOAT_ARRAY"` \$1 `int="INT"` \$1 `int array="INT_ARRAY"` \$1 `interval="INTERVAL"` \$1 `interval array="INTERVAL_ARRAY"` \$1 `long="LONG"` \$1 `long array="LONG_ARRAY"` \$1 `object="OBJECT"` \$1 `short="SHORT"` \$1 `short array="SHORT_ARRAY"` \$1 `smallint="SMALLINT"` \$1 `smallint array="SMALLINT_ARRAY"` \$1 `string="STRING"` \$1 `string array="STRING_ARRAY"` \$1 `timestamp="TIMESTAMP"` \$1 `timestamp array="TIMESTAMP_ARRAY"` \$1 `tinyint="TINYINT"` \$1 `tinyint array="TINYINT_ARRAY"` \$1 `varchar="VARCHAR"` \$1 `varchar array="VARCHAR_ARRAY"` \$1 `null="NULL"` \$1 `unknown="UNKNOWN"` \$1 `unknown array="UNKNOWN_ARRAY"`）。

  AWS Glue Studio 中定义的列的数据类型。

## DynamicTransform 结构
<a name="aws-glue-api-visual-job-api-DynamicTransform"></a>

指定执行动态转换所需的一组参数。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定动态转换的名称。
+ `TransformName` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定动态转换在 AWS Glue Studio 可视化编辑器中显示的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  指定所需的动态转换输入。
+ `Parameters` – [TransformConfigParameter](#aws-glue-api-visual-job-api-TransformConfigParameter) 对象的数组。

  指定动态转换的参数。
+ `FunctionName` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定动态转换的函数名称。
+ `Path` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定动态转换源和配置文件的路径。
+ `Version` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  此字段未使用，将在未来版本中弃用。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定动态转换的数据架构。

## TransformConfigParameter 结构
<a name="aws-glue-api-visual-job-api-TransformConfigParameter"></a>

指定动态转换的配置文件的参数。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定动态转换的配置文件的参数名称。
+ `Type` – *必填*：UTF-8 字符串（有效值：`str="STR"` \$1 `int="INT"` \$1 `float="FLOAT"` \$1 `complex="COMPLEX"` \$1 `bool="BOOL"` \$1 `list="LIST"` \$1 `null="NULL"`）。

  指定动态转换的配置文件中的参数类型。
+ `ValidationRule` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定动态转换的配置文件的验证规则。
+ `ValidationMessage` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定动态转换的配置文件的验证消息。
+ `Value` – UTF-8 字符串数组。

  指定动态转换的配置文件的参数值。
+ `ListType` – UTF-8 字符串（有效值：`str="STR"` \$1`int="INT"` \$1`float="FLOAT"` \$1`complex="COMPLEX"` \$1`bool="BOOL"` \$1`list="LIST"` \$1`null="NULL"` ）。

  指定动态转换的配置文件的参数列表类型。
+ `IsOptional` – 布尔值。

  指定该参数在动态转换的配置文件中是否可选。

## EvaluateDataQuality 结构
<a name="aws-glue-api-visual-job-api-EvaluateDataQuality"></a>

指定您的数据质量评估标准。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据质量评估的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  您的数据质量评估的输入。
+ `Ruleset` – *必填*：UTF-8 字符串，长度不少于 1 个字节，不超过 65536 个字节，与 [Custom string pattern #59](aws-glue-api-common.md#regex_59) 匹配。

  数据质量评估的规则集。
+ `Output` – UTF-8 字符串（有效值：`PrimaryInput` \$1`EvaluationResults` ）。

  您的数据质量评估的输出。
+ `PublishingOptions` – 一个 [DQResultsPublishingOptions](#aws-glue-api-visual-job-api-DQResultsPublishingOptions) 对象。

  用于配置结果发布方式的选项。
+ `StopJobOnFailureOptions` – 一个 [DQStopJobOnFailureOptions](#aws-glue-api-visual-job-api-DQStopJobOnFailureOptions) 对象。

  用于配置在数据质量评估失败时如何停止作业的选项。

## DQResultsPublishingOptions 结构
<a name="aws-glue-api-visual-job-api-DQResultsPublishingOptions"></a>

用于配置数据质量评估结果发布方式的选项。

**Fields**
+ `EvaluationContext` – UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  评估的背景。
+ `ResultsS3Prefix` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  Amazon S3 前缀位于结果之前。
+ `CloudWatchMetricsEnabled` – 布尔值。

  为您的数据质量结果启用指标。
+ `ResultsPublishingEnabled` – 布尔值。

  为您的数据质量结果启用发布。

## DQStopJobOnFailureOptions 结构
<a name="aws-glue-api-visual-job-api-DQStopJobOnFailureOptions"></a>

用于配置在数据质量评估失败时如何停止作业的选项。

**Fields**
+ `StopJobOnFailureTiming` – UTF-8 字符串（有效值：`Immediate` \$1`AfterDataLoad` ）。

  如果您的数据质量评估失败，何时停止作业。选项包括 Immediate（立即）或 AfterDataLoad（数据加载后）。

## EvaluateDataQualityMultiFrame 结构
<a name="aws-glue-api-visual-job-api-EvaluateDataQualityMultiFrame"></a>

指定您的数据质量评估标准。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  数据质量评估的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，至少 1 个字符串。

  您的数据质量评估的输入。此列表中的第一个输入是主数据来源。
+ `AdditionalDataSources` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  除主数据来源之外的所有数据来源的别名。
+ `Ruleset` – *必填*：UTF-8 字符串，长度不少于 1 个字节，不超过 65536 个字节，与 [Custom string pattern #59](aws-glue-api-common.md#regex_59) 匹配。

  数据质量评估的规则集。
+ `PublishingOptions` – 一个 [DQResultsPublishingOptions](#aws-glue-api-visual-job-api-DQResultsPublishingOptions) 对象。

  用于配置结果发布方式的选项。
+ `AdditionalOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串（有效值：`performanceTuning.caching="CacheOption"` \$1 `observations.scope="ObservationsOption"` \$1 `compositeRuleEvaluation.method="CompositeOption"`）。

  每个值是一个 UTF-8 字符串。

  用于配置转换运行时行为的选项。
+ `StopJobOnFailureOptions` – 一个 [DQStopJobOnFailureOptions](#aws-glue-api-visual-job-api-DQStopJobOnFailureOptions) 对象。

  用于配置在数据质量评估失败时如何停止作业的选项。

## 脚本结构
<a name="aws-glue-api-visual-job-api-Recipe"></a>

在 AWS Glue 作业中使用 AWS Glue DataBrew 脚本的 AWS Glue Studio 节点。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  AWS Glue Studio 节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  作为脚本节点的输入的节点，由 id 标识。
+ `RecipeReference` – 一个 [RecipeReference](#aws-glue-api-visual-job-api-RecipeReference) 对象。

  对节点使用的 DataBrew 脚本的引用。
+ `RecipeSteps` – [RecipeStep](#aws-glue-api-visual-job-api-RecipeStep) 对象的数组。

  配方节点中使用的转换步骤。

## RecipeReference 结构
<a name="aws-glue-api-visual-job-api-RecipeReference"></a>

对 AWS Glue DataBrew 脚本的引用。

**Fields**
+ `RecipeArn` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  DataBrew 脚本的 ARN。
+ `RecipeVersion` – *必填：* UTF-8 字符串，长度不少于 1 个字节，不超过 16 个字节。

  DataBrew 脚本的脚本版本。

## SnowflakeNodeData 结构
<a name="aws-glue-api-visual-job-api-SnowflakeNodeData"></a>

指定 AWS Glue Studio 中 Snowflake 节点的配置。

**Fields**
+ `SourceType` – UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  指定检索数据的指定方式。有效值：`"table"`、` "query"`。
+ `Connection` – 一个 [选项](#aws-glue-api-visual-job-api-Option) 对象。

  指定与 Snowflake 端点的 AWS Glue Data Catalog 连接。
+ `Schema` – UTF-8 字符串。

  为您的节点指定要使用的 Snowflake 数据库架构。
+ `Table` – UTF-8 字符串。

  为您的节点指定要使用的 Snowflake 表。
+ `Database` – UTF-8 字符串。

  为您的节点指定要使用的 Snowflake 数据库。
+ `TempDir` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  当前未使用。
+ `IamRole` – 一个 [选项](#aws-glue-api-visual-job-api-Option) 对象。

  当前未使用。
+ `AdditionalOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定传递给 Snowflake 连接器的其他选项。如果在此节点中以其他地方指定了选项，则优先使用该选项。
+ `SampleQuery` – UTF-8 字符串。

  用于检索 `query` 源类型数据的 SQL 字符串。
+ `PreAction` – UTF-8 字符串。

  在 Snowflake 连接器执行其标准操作之前运行的 SQL 字符串。
+ `PostAction` – UTF-8 字符串。

  在 Snowflake 连接器执行其标准操作之后运行的 SQL 字符串。
+ `Action` – UTF-8 字符串。

  指定在写入包含先前存在数据的表时要执行的操作。有效值：` append`、`merge`、`truncate`、`drop`。
+ `Upsert` – 布尔值。

  在“操作”为 `append` 时使用。指定行已存在时的解析行为。如果为 true，则先前存在的行将被更新。如果为 false，则将插入这些行。
+ `MergeAction` – UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  指定合并操作。有效值：`simple`、`custom`。如果是简单，则合并行为由 `MergeWhenMatched` 和 ` MergeWhenNotMatched` 定义。如果是自定义，则 `MergeClause` 由定义。
+ `MergeWhenMatched` – UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  指定在合并时如何解析与先前存在的数据相匹配的记录。有效值：` update`、`delete`。
+ `MergeWhenNotMatched` – UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  指定在合并时如何处理与先前存在的数据不匹配的记录。有效值：`insert`、`none`。
+ `MergeClause` – UTF-8 字符串。

  指定自定义合并行为的 SQL 语句。
+ `StagingTable` – UTF-8 字符串。

  执行 `merge` 或更新插入 `append` 操作时使用的暂存表的名称。数据被写入此表，然后通过生成的后期操作将其移动到 `table`。
+ `SelectedColumns` – [选项](#aws-glue-api-visual-job-api-Option) 对象的数组。

  指定在检测到合并和更新插入的匹配项时用于标识记录的组合列。带有 `value`、`label` 和 ` description` 键的结构列表。每个结构都描述了一列。
+ `AutoPushdown` – 布尔值。

  指定是否启用自动查询下推。如果启用了下推，那么当在 Spark 上运行查询时，如果可以将部分查询“下推”到 Snowflake 服务器，则会将其下推。这提高了某些查询的性能。
+ `TableSchema` – [选项](#aws-glue-api-visual-job-api-Option) 对象的数组。

  手动定义节点的目标架构。带有 `value`、`label` 和 `description` 键的结构列表。每个结构都定义了一列。

## SnowflakeSource 结构
<a name="aws-glue-api-visual-job-api-SnowflakeSource"></a>

指定 Snowflake 数据来源。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  Snowflake 数据来源的名称。
+ `Data` – *必填：*一个 [SnowflakeNodeData](#aws-glue-api-visual-job-api-SnowflakeNodeData) 对象。

  Snowflake 数据来源的配置。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  为输出数据指定用户定义的架构。

## SnowflakeTarget 结构
<a name="aws-glue-api-visual-job-api-SnowflakeTarget"></a>

指定 Snowflake 目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  Snowflake 目标的名称。
+ `Data` – *必填：*一个 [SnowflakeNodeData](#aws-glue-api-visual-job-api-SnowflakeNodeData) 对象。

  指定 Snowflake 目标节点的数据。
+ `Inputs` – UTF-8 字符串数组，不少于 1 个字符串，不超过 1 个字符串。

  作为数据目标输入的节点。

## ConnectorDataSource 的结构
<a name="aws-glue-api-visual-job-api-ConnectorDataSource"></a>

指定使用标准连接选项生成的源。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  此源节点的名称。
+ `ConnectionType` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  提供给底层 AWS Glue 库的 `connectionType`。此节点类型支持以下连接类型：
  + `opensearch`
  + `azuresql`
  + `azurecosmos`
  + `bigquery`
  + `saphana`
  + `teradata`
  + `vertica`
+ `Data` – *必填*：键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  指定节点连接选项的映射。有关相应连接类型的标准连接选项，请参阅 AWS Glue 文档的 [连接参数](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-connect.html)部分。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定该源的数据 Schema。

## ConnectorDataTarget 的结构
<a name="aws-glue-api-visual-job-api-ConnectorDataTarget"></a>

指定使用标准连接选项生成的目标。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  此目标节点的名称。
+ `ConnectionType` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  提供给底层 AWS Glue 库的 `connectionType`。此节点类型支持以下连接类型：
  + `opensearch`
  + `azuresql`
  + `azurecosmos`
  + `bigquery`
  + `saphana`
  + `teradata`
  + `vertica`
+ `Data` – *必填*：键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  指定节点连接选项的映射。有关相应连接类型的标准连接选项，请参阅 AWS Glue 文档的 [连接参数](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-connect.html)部分。
+ `Inputs` – UTF-8 字符串数组，不少于 1 个字符串，不超过 1 个字符串。

  作为数据目标输入的节点。

## RecipeStep 结构
<a name="aws-glue-api-visual-job-api-RecipeStep"></a>

AWS Glue Studio 数据准备配方节点中使用的配方步骤。

**Fields**
+ `Action` – *必填：*一个 [RecipeAction](#aws-glue-api-visual-job-api-RecipeAction) 对象。

  配方步骤的转换操作。
+ `ConditionExpressions` – [ConditionExpression](#aws-glue-api-visual-job-api-ConditionExpression) 对象的数组。

  配方步骤的条件表达式。

## RecipeAction 结构
<a name="aws-glue-api-visual-job-api-RecipeAction"></a>

在 AWS Glue Studio 数据准备配方节点中定义的操作。

**Fields**
+ `Operation` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #56](aws-glue-api-common.md#regex_56) 匹配。

  配方操作的操作。
+ `Parameters` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #57](aws-glue-api-common.md#regex_57) 匹配。

  每个值都是一个 UTF-8 字符串，长度不少于 1 个字节，不超过 32768 个字节。

  配方操作的参数。

## ConditionExpression 结构
<a name="aws-glue-api-visual-job-api-ConditionExpression"></a>

在 AWS Glue Studio 数据准备配方节点中定义的条件表达式。

**Fields**
+ `Condition` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #56](aws-glue-api-common.md#regex_56) 匹配。

  条件表达式的条件。
+ `Value` – UTF-8 字符串，长度不超过 1024 个字节。

  条件表达式的条件。
+ `TargetColumn` – *必填项：*UTF-8 字符串，长度不少于 1 个字节，不超过 1024 个字节。

  条件表达式的目标列。

## S3CatalogIcebergSource 结构
<a name="aws-glue-api-visual-job-api-S3CatalogIcebergSource"></a>

指定在 AWS Glue Data Catalog 中注册的 Apache Iceberg 数据来源。Iceberg 数据来源必须存储在 Amazon S3 中。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  Iceberg 数据来源的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库的名称。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库中的表的名称。
+ `AdditionalIcebergOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定 Iceberg 数据来源的其他连接选项。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 Iceberg 源的数据架构。

## CatalogIcebergSource 结构
<a name="aws-glue-api-visual-job-api-CatalogIcebergSource"></a>

指定在 AWS Glue Data Catalog 中注册的 Apache Iceberg 数据来源。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  Iceberg 数据来源的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库的名称。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中进行读取的数据库中的表的名称。
+ `AdditionalIcebergOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定 Iceberg 数据来源的其他连接选项。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 Iceberg 源的数据架构。

## S3IcebergCatalogTarget 结构
<a name="aws-glue-api-visual-job-api-S3IcebergCatalogTarget"></a>

指定一个 Apache Iceberg 目录目标，该目标将数据写入 Amazon S3 并在 AWS Glue Data Catalog 中注册该表。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  Iceberg 目录目标的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  Iceberg 目录目标的输入连接。
+ `PartitionKeys` – UTF-8 字符串数组。

  Iceberg 表的分区键列表。
+ `Table` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要写入目录的表的名称。
+ `Database` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要向其写入的数据库的名称。
+ `AdditionalOptions` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  每个值都是一个 UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定 Iceberg 目录目标的其他连接选项。
+ `SchemaChangePolicy` – 一个 [CatalogSchemaChangePolicy](#aws-glue-api-visual-job-api-CatalogSchemaChangePolicy) 对象。

  用于处理目录目标中架构更改的策略。
+ `AutoDataQuality` – 一个 [AutoDataQuality](#aws-glue-api-visual-job-api-AutoDataQuality) 对象。

  指定是否为 S3 Iceberg 目录目标自动启用数据质量评估。设置为 `true` 时，则在写入操作期间自动执行数据质量检查。

## DynamoDBELTConnectorSource 结构
<a name="aws-glue-api-visual-job-api-DynamoDBELTConnectorSource"></a>

指定用于从 DynamoDB 表中提取数据的 DynamoDB ELT 连接器源。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  DynamoDB ELT 连接器源的名称。
+ `ConnectionOptions` – 一个 [DDBELTConnectionOptions](#aws-glue-api-visual-job-api-DDBELTConnectionOptions) 对象。

  DynamoDB ELT 连接器源的连接选项。
+ `OutputSchemas` – [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 对象的数组。

  指定 DynamoDB ELT 连接器源的数据架构。

## DDBELTConnectionOptions 结构
<a name="aws-glue-api-visual-job-api-DDBELTConnectionOptions"></a>

指定 DynamoDB ELT（提取、加载、转换）操作的连接选项。该结构包含通过 ELT 连接器连接 DynamoDB 表并从中提取数据的配置参数。

**Fields**
+ `DynamodbExport` – UTF-8 字符串（有效值：`ddb` \$1`s3` ）。

  指定 DynamoDB 数据提取的导出类型。该参数决定 ELT 过程中从 DynamoDB 表导出数据的方式。
+ `DynamodbUnnestDDBJson` – 布尔值。

  一个布尔值，指定数据提取期间是否取消嵌套 DynamoDB JSON 格式。设置为 `true` 时，连接器将展平从 DynamoDB 条目中提取的嵌套 JSON 结构。设置为 `false` 时，则保留原始 DynamoDB JSON 结构。
+ `DynamodbTableArn` – *必填：* UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要从中提取数据的 DynamoDB 表的 Amazon 资源名称（ARN）。该参数指定 ELT 操作的源表。
+ `DynamodbS3Bucket` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  在 DynamoDB ELT 过程中用于中间存储的 Amazon S3 存储桶的名称。在 ELT 作业处理导出的 DynamoDB 数据之前，该存储桶用于临时存储这些数据。
+ `DynamodbS3Prefix` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  在 DynamoDB ELT 过程中存储在中间 S3 存储桶中的文件的 S3 对象键前缀。该前缀用于整理和识别数据提取期间创建的临时文件。
+ `DynamodbS3BucketOwner` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  `DynamodbS3Bucket` 中指定的 S3 存储桶所有者的 AWS 账户 ID。当 S3 存储桶的所有者是与运行 ELT 作业的 AWS 账户不同的账户时，该参数为必填项，用于启用对中间存储桶的跨账户访问权限。
+ `DynamodbStsRoleArn` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  要代入的 AWS Security Token Service（STS）角色的 Amazon 资源名称（ARN），用于在 ELT 操作期间访问 DynamoDB 和 S3 资源。此角色必须具有所需权限，才能从 DynamoDB 表中读取数据并写入中间 S3 存储桶。

## DDBELTCatalogAdditionalOptions 结构
<a name="aws-glue-api-visual-job-api-DDBELTCatalogAdditionalOptions"></a>

指定 DynamoDB ELT 目录操作的其他选项。

**Fields**
+ `DynamodbExport` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  指定 ELT 操作的 DynamoDB 导出配置。
+ `DynamodbUnnestDDBJson` – 布尔值。

  指定是否取消嵌套 DynamoDB JSON 格式。设置为 `true` 时，则会展平 DynamoDB 条目中的嵌套 JSON 结构。

## 路由结构
<a name="aws-glue-api-visual-job-api-Route"></a>

指定一个路由节点，该节点根据定义的筛选条件，将数据定向到不同的输出路径。

**Fields**
+ `Name` – *必填：* UTF-8 字符串，与 [Custom string pattern #63](aws-glue-api-common.md#regex_63) 匹配。

  路由节点的名称。
+ `Inputs` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 1 个字符串。

  路由节点的输入连接。
+ `GroupFiltersList` – *必填：*[GroupFilters](#aws-glue-api-visual-job-api-GroupFilters) 对象的数组。

  定义路由条件的组筛选器列表，用于将数据导向不同的输出路径。

## GroupFilters 结构
<a name="aws-glue-api-visual-job-api-GroupFilters"></a>

指定一组带有逻辑运算符的过滤器，用于确定如何组合这些过滤器来评估路由条件。

**Fields**
+ `GroupName` – *必填：* UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  筛选器组的名称。
+ `Filters` – *必填：*[FilterExpression](#aws-glue-api-visual-job-api-FilterExpression) 对象的数组。

  筛选表达式列表，定义该组的条件。
+ `LogicalOperator` – *必填：*UTF-8 字符串（有效值：`AND` \$1 `OR`）。

  用于组合该组中筛选器的逻辑运算符。确定是所有筛选器都必须匹配（AND）还是任何筛选器可以匹配（OR）。

## AutoDataQuality 结构
<a name="aws-glue-api-visual-job-api-AutoDataQuality"></a>

指定 AWS Glue 作业中自动执行数据质量评估的配置选项。这种结构支持在 ETL 操作期间自动检查和监控数据质量，有助于确保数据完整性和可靠性，无需手动干预。

**Fields**
+ `IsEnabled` – 布尔值。

  指定是否启用自动数据质量评估。设置为 `true` 时，则会自动执行数据质量检查。
+ `EvaluationContext` – UTF-8 字符串，与 [Custom string pattern #61](aws-glue-api-common.md#regex_61) 匹配。

  自动数据质量检查的评估上下文。这定义了数据质量评估的范围和参数。

# 作业 API
<a name="aws-glue-api-jobs"></a>

任务 API 介绍任务数据类型，并包含用于在 AWS Glue 中处理任务、任务运行和触发器的 API。

**Topics**
+ [作业](aws-glue-api-jobs-job.md)
+ [任务运行](aws-glue-api-jobs-runs.md)
+ [触发](aws-glue-api-jobs-trigger.md)

# 作业
<a name="aws-glue-api-jobs-job"></a>

任务 API 介绍与在 AWS Glue 中创建、更新、删除或查看任务相关的数据类型和 API。

## 数据类型
<a name="aws-glue-api-jobs-job-objects"></a>
+ [作业结构](#aws-glue-api-jobs-job-Job)
+ [ExecutionProperty 结构](#aws-glue-api-jobs-job-ExecutionProperty)
+ [NotificationProperty 结构](#aws-glue-api-jobs-job-NotificationProperty)
+ [JobCommand 结构](#aws-glue-api-jobs-job-JobCommand)
+ [ConnectionsList 结构](#aws-glue-api-jobs-job-ConnectionsList)
+ [JobUpdate 结构](#aws-glue-api-jobs-job-JobUpdate)
+ [SourceControlDetails 结构](#aws-glue-api-jobs-job-SourceControlDetails)

## 作业结构
<a name="aws-glue-api-jobs-job-Job"></a>

指定作业定义。

**字段**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  您分配给该作业定义的名称。
+ `JobMode` – UTF-8 字符串（有效值：`SCRIPT=""` \$1 `VISUAL=""` \$1 `NOTEBOOK=""`）。

  描述任务是如何创建的模式。有效值为：
  + `SCRIPT` – 该任务使用 AWS Glue Studio 脚本编辑器创建。
  + `VISUAL` – 该任务使用 AWS Glue Studio 可视化编辑器创建。
  + `NOTEBOOK` – 该任务使用交互式会话笔记本创建。

  当 `JobMode` 字段缺失或为空时，`SCRIPT` 将指定为默认值。
+ `JobRunQueuingEnabled`：布尔值。

  指定是否为此作业的作业运行启用作业运行排队。

  值为 true 表示已为作业运行启用作业运行排队。如果为 false 或未填充任何选项，则不会启用作业运行排队。

  如果此字段与作业运行中设置的值不匹配，则将使用作业运行字段中的值。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  作业的描述。
+ `LogUri` – UTF-8 字符串。

  该字段保留，以供将来使用。
+ `Role` – UTF-8 字符串。

  与此作业关联的 IAM 角色的名称或 Amazon 资源名称（ARN）。
+ `CreatedOn` – 时间戳。

  创建此作业定义的时间和日期。
+ `LastModifiedOn` – 时间戳。

  修改此作业定义时的最后一个时间点。
+ `ExecutionProperty` – 一个 [ExecutionProperty](#aws-glue-api-jobs-job-ExecutionProperty) 对象。

  一个 `ExecutionProperty`，指定该作业允许的最大并发运行数。
+ `Command` – 一个 [JobCommand](#aws-glue-api-jobs-job-JobCommand) 对象。

  运行此任务的 `JobCommand`。
+ `DefaultArguments` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  此作业每个运行的默认参数，指定为名称-值对。

  可以在此处指定您自己的任务执行脚本使用的参数以及 AWS Glue 本身使用的参数。

  可能会记录任务参数。不要将明文密钥作为参数传递。如果您想要将密钥保留在任务内，则请通过 AWS Glue 连接、AWS Secrets Manager 或其他密钥管理机制检索密钥。

  有关如何指定和使用您自己的任务参数的信息，请参阅开发人员指南中的[在 Python 中调用 AWS Glue API ](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html)主题。

  有关在配置 Spark 作业时可以为该字段提供的参数的信息，请参阅《开发人员指南》中的 [Special Parameters Used by AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) 主题。

  有关在配置 Ray 作业时可以为该字段提供的参数的信息，请参阅《开发人员指南》中的 [Using job parameters in Ray jobs](https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html)。
+ `NonOverridableArguments` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  在作业运行中提供作业参数时，此作业的参数不会被覆盖，而是指定为名称-值对。
+ `Connections` – 一个 [ConnectionsList](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-ConnectionsList) 对象。

  用于此作业的连接。
+ `MaxRetries` – 数字（整数）。

  在作业运行失败后重试此作业的最大次数。
+ `AllocatedCapacity` – 数字（整数）。

  此字段已弃用。请改用 `MaxCapacity`。

  分配给此任务运行的 AWS Glue 数据处理单元（DPU）的数量。您可以分配至少 2 个 DPU；默认值为 10。DPU 是对处理能力的相对度量，它由 4 个 vCPU 的计算容量和 16GB 内存组成。有关更多信息，请参阅 [AWS Glue 价格页面](https://aws.amazon.com/glue/pricing/)。

  
+ `Timeout` - 数字（整数），至少为 1。

  作业超时（以分钟为单位）。这是任务运行在终止并进入 `TIMEOUT` 状态前可以使用资源的最长时间。

  作业的超时值必须小于 7 天或 10080 分钟。否则，作业会引发异常。

  该值留空时，超时值默认为 2880 分钟。

  任何超时值大于 7 天的现有 AWS Glue 作业，该值默认为 7 天。例如，若为批处理作业指定了 20 天的超时值，则该作业将在第 7 天停止。

  对于流式传输作业，如果设置了维护时段，则将于 7 天后在维护时段内重新启动。
+ `MaxCapacity` – 数字（double）。

  对于 Glue 版本 1.0 或更早版本的任务，使用标准工件类型，表示此任务运行时可分配的 AWS Glue 数据处理单元（DPU）的数量。DPU 是对处理能力的相对度量，它由 4 个 vCPU 的计算容量和 16GB 内存组成。有关更多信息，请参阅 [AWS Glue 价格页面](https://aws.amazon.com/glue/pricing/)。

  对于 Glue 版本 2.0 或更高版本的作业，则不能指定 `Maximum capacity`。而应指定 `Worker type` 和 `Number of workers`。

  如果使用 `WorkerType` 和 `NumberOfWorkers`，请勿设置 `MaxCapacity`。

  可为 `MaxCapacity` 分配的值取决于您运行的是 Python shell 作业、Apache Spark ETL 作业，还是 Apache Spark 流 ETL 作业：
  + 当您指定 Python shell 作业 (`JobCommand.Name`="pythonshell")，您可以分配 0.0625 或 1 DPU。默认值为 0.0625 DPU。
  + 当您指定 Apache Spark ETL 作业 (`JobCommand.Name`="glueetl") 或 Apache Spark 流 ETL 作业 (`JobCommand.Name`="gluestreaming") 时，您可以分配 2 到 100 个 DPU。默认为 10 个 DPU。此任务类型不能具有小数 DPU 分配。
+ `WorkerType`：UTF-8 字符串（有效值：`Standard=""` \$1 `G.025X=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `G.12X=""` \$1 `G.16X=""` \$1 `R.1X=""` \$1 `R.2X=""` \$1 `R.4X=""` \$1 `R.8X=""` \$1 `Z.2X=""`）。

  任务运行时分配的预定义工作线程的类型。

  AWS Glue 提供多种 Worker 类型以适应不同的工作负载要求：

  G Worker 类型（通用计算 Worker）：
  + G.025X：0.25 个 DPU（2 个 vCPU，4 GB 内存，84 GB 磁盘）
  + G.1X：1 个 DPU（4 个 vCPU，16 GB 内存，94 GB 磁盘）
  + G.2X：2 个 DPU（8 个 vCPU，32 GB 内存，138 GB 磁盘）
  + G.4X：4 个 DPU（16 个 vCPU，64 GB 内存，256 GB 磁盘）
  + G.8X：8 个 DPU（32 个 vCPU，128 GB 内存，512 GB 磁盘）
  + G.12X：12 个 DPU（48 个 vCPU、192 GB 内存、768 GB 磁盘）
  + G.16X：16 个 DPU（64 个 vCPU、256 GB 内存、1024 GB 磁盘）

  R Worker 类型（内存优化型 Worker）：
  + R.1X：1 个 DPU（4 个 vCPU，32 GB 内存，94 GB 磁盘）
  + R.2X：2 个 DPU（8 个 vCPU，64 GB 内存，128 GB 磁盘）
  + R.4X：4 个 DPU（16 个 vCPU，128 GB 内存，256 GB 磁盘）
  + R.8X：8 个 DPU（32 个 vCPU，256 GB 内存，512 GB 磁盘）
+ `NumberOfWorkers` – 数字（整数）。

  任务运行时分配的定义 `workerType` 的工作线程数。
+ `SecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  该作业将使用的 `SecurityConfiguration` 结构的名称。
+ `NotificationProperty` – 一个 [NotificationProperty](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-NotificationProperty) 对象。

  指定作业通知的配置属性。
+ `Running`：布尔值。

  该字段保留，以供将来使用。
+ `GlueVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #48](aws-glue-api-common.md#regex_48) 匹配。

  在 Spark 作业中，`GlueVersion` 确定作业中 AWS Glue 可用的 Apache Spark 和 Python 版本。Python 版本指示了 Spark 类型的任务支持的版本。

  Ray 作业应将 `GlueVersion` 设置为 `4.0` 或更高。但是，Ray 作业中可用的 Ray、Python 和其他库的版本由 Job 命令的 `Runtime` 参数决定。

  有关可用的 AWS Glue 版本以及相应的 Spark 和 Python 版本的更多信息，请参阅开发人员指南中的 [Glue 版本](https://docs.aws.amazon.com/glue/latest/dg/add-job.html)。

  在未指定 Glue 版本的情况下创建的任务默认为 Glue 0.9。
+ `CodeGenConfigurationNodes` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  每个值都是一个 [CodeGenConfigurationNode](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CodeGenConfigurationNode) 对象。

  定向非循环图表的表示形式，Glue Studio 可视化组件和 Glue Studio 代码生成都是基于该图表的。
+ `ExecutionClass` – UTF-8 字符串，长度不超过 16 个字节（有效值：`FLEX=""` \$1 `STANDARD=""`）。

  指示任务是使用标准执行类还是灵活执行类运行的。标准执行类非常适合需要快速任务启动和专用资源的时间敏感型工作负载。

  灵活执行类适用于启动和完成时间可能不同的时间不敏感型作业。

  只有具有 AWS Glue 版本 3.0 和以上版本以及命令类型 `glueetl` 的任务才允许将 `ExecutionClass` 设置为 `FLEX`。灵活的执行类可用于 Spark 任务。
+ `SourceControlDetails` – 一个 [SourceControlDetails](#aws-glue-api-jobs-job-SourceControlDetails) 对象。

  作业源代码控制配置的详细信息，允许将作业构件同步到远程存储库或从远程存储库同步。
+ `MaintenanceWindow` – UTF-8 字符串，与 [Custom string pattern #34](aws-glue-api-common.md#regex_34) 匹配。

  此字段指定一周中的某一天和一小时，作为流式传输任务的维护时段。AWS Glue 会定期执行维护活动。在这些维护时段内，AWS Glue 需要重新启动您的流式传输任务。

  AWS Glue 将在指定维护时段后的 3 小时内重新启动任务。例如，如果您将维护时段设置为 GMT 时间星期一上午 10:00，则您的任务将在 GMT 时间上午 10:00 至下午 1:00 之间重新启动。
+ `ProfileName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与作业关联的 AWS Glue 使用情况配置文件名称。

## ExecutionProperty 结构
<a name="aws-glue-api-jobs-job-ExecutionProperty"></a>

作业的执行属性。

**字段**
+ `MaxConcurrentRuns` – 数字（整数）。

  作业允许的最大并发运行数。默认 为 1。达到此阈值时，将返回一个错误。可以指定的最大值由服务限制控制。

## NotificationProperty 结构
<a name="aws-glue-api-jobs-job-NotificationProperty"></a>

指定通知的配置属性。

**字段**
+ `NotifyDelayAfter` - 数字（整数），至少为 1。

  在作业运行开始后，发送作业运行延迟通知之前等待的分钟数。

## JobCommand 结构
<a name="aws-glue-api-jobs-job-JobCommand"></a>

指定任务运行时运行的代码。

**字段**
+ `Name` – UTF-8 字符串。

  作业命令的名称。对于 Apache Spark ETL 作业，这必须是 `glueetl`。对于 Python shell 作业，它必须为 `pythonshell`。对于 Apache Spark 流 ETL 作业，这必须是 `gluestreaming`。对于 Ray 作业，必须是 `glueray`。
+ `ScriptLocation` – UTF-8 字符串，长度不超过 400000 个字节。

  指定运行任务的脚本的 Amazon Simple Storage Service（Amazon S3）路径。
+ `PythonVersion` – UTF-8 字符串，与 [Custom string pattern #49](aws-glue-api-common.md#regex_49) 匹配。

  运行 Python shell 任务所用的 Python 版本。允许的值为 2 或 3。
+ `Runtime` - UTF-8 字符串，长度不超过 64 个字节，与 [Custom string pattern #33](aws-glue-api-common.md#regex_33) 匹配。

  在 Ray 作业中，运行时用于指定环境中可用的 Ray、Python 和其他库的版本。此字段不用于其他作业类型。有关支持的运行时环境值，请参阅《AWS Glue 开发人员指南》中的[支持的 Ray 运行时环境](https://docs.aws.amazon.com/glue/latest/dg/ray-jobs-section.html)。

## ConnectionsList 结构
<a name="aws-glue-api-jobs-job-ConnectionsList"></a>

指定作业所使用的连接。

**字段**
+ `Connections` – UTF-8 字符串数组，不超过 1000 个字符串。

  作业所使用的连接的列表。

## JobUpdate 结构
<a name="aws-glue-api-jobs-job-JobUpdate"></a>

指定用于更新现有作业定义的信息。此信息会完全覆盖先前的作业定义。

**字段**
+ `JobMode` – UTF-8 字符串（有效值：`SCRIPT=""` \$1 `VISUAL=""` \$1 `NOTEBOOK=""`）。

  描述任务是如何创建的模式。有效值为：
  + `SCRIPT` – 该任务使用 AWS Glue Studio 脚本编辑器创建。
  + `VISUAL` – 该任务使用 AWS Glue Studio 可视化编辑器创建。
  + `NOTEBOOK` – 该任务使用交互式会话笔记本创建。

  当 `JobMode` 字段缺失或为空时，`SCRIPT` 将指定为默认值。
+ `JobRunQueuingEnabled`：布尔值。

  指定是否为此作业的作业运行启用作业运行排队。

  值为 true 表示已为作业运行启用作业运行排队。如果为 false 或未填充任何选项，则不会启用作业运行排队。

  如果此字段与作业运行中设置的值不匹配，则将使用作业运行字段中的值。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  要定义的作业的描述。
+ `LogUri` – UTF-8 字符串。

  该字段保留，以供将来使用。
+ `Role` – UTF-8 字符串。

  与此作业关联的 IAM 角色的名称或 Amazon Resource Name (ARN)（必填）。
+ `ExecutionProperty` – 一个 [ExecutionProperty](#aws-glue-api-jobs-job-ExecutionProperty) 对象。

  一个 `ExecutionProperty`，指定该作业允许的最大并发运行数。
+ `Command` – 一个 [JobCommand](#aws-glue-api-jobs-job-JobCommand) 对象。

  运行此任务的 `JobCommand`（必填）。
+ `DefaultArguments` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  此作业每个运行的默认参数，指定为名称-值对。

  可以在此处指定您自己的任务执行脚本使用的参数以及 AWS Glue 本身使用的参数。

  可能会记录任务参数。不要将明文密钥作为参数传递。如果您想要将密钥保留在任务内，则请通过 AWS Glue 连接、AWS Secrets Manager 或其他密钥管理机制检索密钥。

  有关如何指定和使用您自己的任务参数的信息，请参阅开发人员指南中的[在 Python 中调用 AWS Glue API ](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html)主题。

  有关在配置 Spark 作业时可以为该字段提供的参数的信息，请参阅《开发人员指南》中的 [Special Parameters Used by AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) 主题。

  有关在配置 Ray 作业时可以为该字段提供的参数的信息，请参阅《开发人员指南》中的 [Using job parameters in Ray jobs](https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html)。
+ `NonOverridableArguments` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  在作业运行中提供作业参数时，此作业的参数不会被覆盖，而是指定为名称-值对。
+ `Connections` – 一个 [ConnectionsList](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-ConnectionsList) 对象。

  用于此作业的连接。
+ `MaxRetries` – 数字（整数）。

  在该作业失败时重试的最大次数。
+ `AllocatedCapacity` – 数字（整数）。

  此字段已弃用。请改用 `MaxCapacity`。

  要分配给该任务的 AWS Glue 数据处理单元（DPU）的数量。您可以分配至少 2 个 DPU；默认值为 10。DPU 是对处理能力的相对度量，它由 4 个 vCPU 的计算容量和 16GB 内存组成。有关更多信息，请参阅 [AWS Glue 价格页面](https://aws.amazon.com/glue/pricing/)。
+ `Timeout` - 数字（整数），至少为 1。

  作业超时（以分钟为单位）。这是任务运行在终止并进入 `TIMEOUT` 状态前可以使用资源的最长时间。

  作业的超时值必须小于 7 天或 10080 分钟。否则，作业会引发异常。

  该值留空时，超时值默认为 2880 分钟。

  任何超时值大于 7 天的现有 AWS Glue 作业，该值默认为 7 天。例如，若为批处理作业指定了 20 天的超时值，则该作业将在第 7 天停止。

  对于流式传输作业，如果设置了维护时段，则将于 7 天后在维护时段内重新启动。
+ `MaxCapacity` – 数字（double）。

  对于 Glue 版本 1.0 或更早版本的任务，使用标准工件类型，表示此任务运行时可分配的 AWS Glue 数据处理单元（DPU）的数量。DPU 是对处理能力的相对度量，它由 4 个 vCPU 的计算容量和 16GB 内存组成。有关更多信息，请参阅 [AWS Glue 价格页面](https://aws.amazon.com/glue/pricing/)。

  对于 Glue 版本 2.0\$1 作业，不能指定 `Maximum capacity`。而应指定 `Worker type` 和 `Number of workers`。

  如果使用 `WorkerType` 和 `NumberOfWorkers`，请勿设置 `MaxCapacity`。

  可为 `MaxCapacity` 分配的值取决于您运行的是 Python shell 作业、Apache Spark ETL 作业，还是 Apache Spark 流 ETL 作业：
  + 当您指定 Python shell 作业 (`JobCommand.Name`="pythonshell")，您可以分配 0.0625 或 1 DPU。默认值为 0.0625 DPU。
  + 当您指定 Apache Spark ETL 作业 (`JobCommand.Name`="glueetl") 或 Apache Spark 流 ETL 作业 (`JobCommand.Name`="gluestreaming") 时，您可以分配 2 到 100 个 DPU。默认为 10 个 DPU。此任务类型不能具有小数 DPU 分配。
+ `WorkerType`：UTF-8 字符串（有效值：`Standard=""` \$1 `G.025X=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `G.12X=""` \$1 `G.16X=""` \$1 `R.1X=""` \$1 `R.2X=""` \$1 `R.4X=""` \$1 `R.8X=""` \$1 `Z.2X=""`）。

  任务运行时分配的预定义工作线程的类型。接受 G.025X、G.1X、G.2X、G.4X、G.8X、G.12X、G.16X、R.1X、R.2X、R.4X 或 R.8X 的值，用于 Spark 任务。接受 Ray 作业的值 Z.2X。有关更多信息，请参阅[定义 Spark 作业的作业属性](https://docs.aws.amazon.com/glue/latest/dg/add-job.html#create-job)。
+ `NumberOfWorkers` – 数字（整数）。

  任务运行时分配的定义 `workerType` 的工作线程数。
+ `SecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  该作业将使用的 `SecurityConfiguration` 结构的名称。
+ `NotificationProperty` – 一个 [NotificationProperty](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-NotificationProperty) 对象。

  指定作业通知的配置属性。
+ `GlueVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #48](aws-glue-api-common.md#regex_48) 匹配。

  在 Spark 作业中，`GlueVersion` 确定作业中 AWS Glue 可用的 Apache Spark 和 Python 版本。Python 版本指示了 Spark 类型的任务支持的版本。

  Ray 作业应将 `GlueVersion` 设置为 `4.0` 或更高。但是，Ray 作业中可用的 Ray、Python 和其他库的版本由 Job 命令的 `Runtime` 参数决定。

  有关可用的 AWS Glue 版本以及相应的 Spark 和 Python 版本的更多信息，请参阅开发人员指南中的 [Glue 版本](https://docs.aws.amazon.com/glue/latest/dg/add-job.html)。

  在未指定 Glue 版本的情况下创建的任务默认为 Glue 0.9。
+ `CodeGenConfigurationNodes` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  每个值都是一个 [CodeGenConfigurationNode](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CodeGenConfigurationNode) 对象。

  定向非循环图表的表示形式，Glue Studio 可视化组件和 Glue Studio 代码生成都是基于该图表的。
+ `ExecutionClass` – UTF-8 字符串，长度不超过 16 个字节（有效值：`FLEX=""` \$1 `STANDARD=""`）。

  指示任务是使用标准执行类还是灵活执行类运行的。标准执行类非常适合需要快速任务启动和专用资源的时间敏感型工作负载。

  灵活执行类适用于启动和完成时间可能不同的时间不敏感型作业。

  只有具有 AWS Glue 版本 3.0 和以上版本以及命令类型 `glueetl` 的任务才允许将 `ExecutionClass` 设置为 `FLEX`。灵活的执行类可用于 Spark 任务。
+ `SourceControlDetails` – 一个 [SourceControlDetails](#aws-glue-api-jobs-job-SourceControlDetails) 对象。

  作业源代码控制配置的详细信息，允许将作业构件同步到远程存储库或从远程存储库同步。
+ `MaintenanceWindow` – UTF-8 字符串，与 [Custom string pattern #34](aws-glue-api-common.md#regex_34) 匹配。

  此字段指定一周中的某一天和一小时，作为流式传输任务的维护时段。AWS Glue 会定期执行维护活动。在这些维护时段内，AWS Glue 需要重新启动您的流式传输任务。

  AWS Glue 将在指定维护时段后的 3 小时内重新启动任务。例如，如果您将维护时段设置为 GMT 时间星期一上午 10:00，则您的任务将在 GMT 时间上午 10:00 至下午 1:00 之间重新启动。
+ `ProfileName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与作业关联的 AWS Glue 使用情况配置文件名称。

## SourceControlDetails 结构
<a name="aws-glue-api-jobs-job-SourceControlDetails"></a>

作业源代码控制配置的详细信息，允许将作业构件同步到远程存储库或从远程存储库同步。

**字段**
+ `Provider` – UTF-8 字符串（有效值：`GITHUB` \$1 `AWS_CODE_COMMIT`）。

  远程存储库的提供者。
+ `Repository` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节。

  包含作业构件的远程存储库的名称。
+ `Owner` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节。

  包含作业构件的远程存储库的所有者。
+ `Branch` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节。

  远程存储库中的可选分支。
+ `Folder` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节。

  远程存储库中的可选文件夹。
+ `LastCommitId` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节。

  远程存储库中提交的最后一次提交 ID。
+ `LastSyncTimestamp` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节。

  上次执行作业同步的日期和时间。
+ `AuthStrategy` – UTF-8 字符串（有效值：`PERSONAL_ACCESS_TOKEN` \$1 `AWS_SECRETS_MANAGER`）。

  身份验证类型，可以是存储在 AWS Secrets Manager 中的身份验证令牌，也可以是个人访问令牌。
+ `AuthToken` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节。

  授权令牌的值。

## 操作
<a name="aws-glue-api-jobs-job-actions"></a>
+ [CreateJob 操作（Python：create\$1job）](#aws-glue-api-jobs-job-CreateJob)
+ [UpdateJob 操作（Python：update\$1job）](#aws-glue-api-jobs-job-UpdateJob)
+ [GetJob 操作（Python：get\$1job）](#aws-glue-api-jobs-job-GetJob)
+ [GetJobs 操作（Python：get\$1jobs）](#aws-glue-api-jobs-job-GetJobs)
+ [DeleteJob 操作（Python：delete\$1job）](#aws-glue-api-jobs-job-DeleteJob)
+ [ListJobs 操作（Python：list\$1jobs）](#aws-glue-api-jobs-job-ListJobs)
+ [BatchGetJobs 操作（Python：batch\$1get\$1jobs）](#aws-glue-api-jobs-job-BatchGetJobs)

## CreateJob 操作（Python：create\$1job）
<a name="aws-glue-api-jobs-job-CreateJob"></a>

创建新的作业定义。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  您分配给该作业定义的名称。它在您的 账户中必须是唯一的。
+ `JobMode` – UTF-8 字符串（有效值：`SCRIPT=""` \$1 `VISUAL=""` \$1 `NOTEBOOK=""`）。

  描述任务是如何创建的模式。有效值为：
  + `SCRIPT` – 该任务使用 AWS Glue Studio 脚本编辑器创建。
  + `VISUAL` – 该任务使用 AWS Glue Studio 可视化编辑器创建。
  + `NOTEBOOK` – 该任务使用交互式会话笔记本创建。

  当 `JobMode` 字段缺失或为空时，`SCRIPT` 将指定为默认值。
+ `JobRunQueuingEnabled`：布尔值。

  指定是否为此作业的作业运行启用作业运行排队。

  值为 true 表示已为作业运行启用作业运行排队。如果为 false 或未填充任何选项，则不会启用作业运行排队。

  如果此字段与作业运行中设置的值不匹配，则将使用作业运行字段中的值。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  要定义的作业的描述。
+ `LogUri` – UTF-8 字符串。

  该字段保留，以供将来使用。
+ `Role` – *必填：*UTF-8 字符串。

  与此作业关联的 IAM 角色的名称或 Amazon 资源名称（ARN）。
+ `ExecutionProperty` – 一个 [ExecutionProperty](#aws-glue-api-jobs-job-ExecutionProperty) 对象。

  一个 `ExecutionProperty`，指定该作业允许的最大并发运行数。
+ `Command` – *必填：*一个 [JobCommand](#aws-glue-api-jobs-job-JobCommand) 对象。

  运行此任务的 `JobCommand`。
+ `DefaultArguments` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  此作业每个运行的默认参数，指定为名称-值对。

  可以在此处指定您自己的任务执行脚本使用的参数以及 AWS Glue 本身使用的参数。

  可能会记录任务参数。不要将明文密钥作为参数传递。如果您想要将密钥保留在任务内，则请通过 AWS Glue 连接、AWS Secrets Manager 或其他密钥管理机制检索密钥。

  有关如何指定和使用您自己的任务参数的信息，请参阅开发人员指南中的[在 Python 中调用 AWS Glue API ](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html)主题。

  有关在配置 Spark 作业时可以为该字段提供的参数的信息，请参阅《开发人员指南》中的 [Special Parameters Used by AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) 主题。

  有关在配置 Ray 作业时可以为该字段提供的参数的信息，请参阅《开发人员指南》中的 [Using job parameters in Ray jobs](https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html)。
+ `NonOverridableArguments` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  在作业运行中提供作业参数时，此作业的参数不会被覆盖，而是指定为名称-值对。
+ `Connections` – 一个 [ConnectionsList](aws-glue-api-interactive-sessions.md#aws-glue-api-interactive-sessions-ConnectionsList) 对象。

  用于此作业的连接。
+ `MaxRetries` – 数字（整数）。

  在该作业失败时重试的最大次数。
+ `AllocatedCapacity` – 数字（整数）。

  此参数已被弃用。请改用 `MaxCapacity`。

  要分配给该任务的 AWS Glue 数据处理单元（DPU）的数量。您可以分配至少 2 个 DPU；默认值为 10。DPU 是对处理能力的相对度量，它由 4 个 vCPU 的计算容量和 16GB 内存组成。有关更多信息，请参阅 [AWS Glue 价格页面](https://aws.amazon.com/glue/pricing/)。
+ `Timeout` - 数字（整数），至少为 1。

  作业超时（以分钟为单位）。这是任务运行在终止并进入 `TIMEOUT` 状态前可以使用资源的最长时间。

  作业的超时值必须小于 7 天或 10080 分钟。否则，作业会引发异常。

  该值留空时，超时值默认为 2880 分钟。

  任何超时值大于 7 天的现有 AWS Glue 作业，该值默认为 7 天。例如，若为批处理作业指定了 20 天的超时值，则该作业将在第 7 天停止。

  对于流式传输作业，如果设置了维护时段，则将于 7 天后在维护时段内重新启动。
+ `MaxCapacity` – 数字（double）。

  对于 Glue 版本 1.0 或更早版本的任务，使用标准工件类型，表示此任务运行时可分配的 AWS Glue 数据处理单元（DPU）的数量。DPU 是对处理能力的相对度量，它由 4 个 vCPU 的计算容量和 16GB 内存组成。有关更多信息，请参阅 [AWS Glue 价格页面](https://aws.amazon.com/glue/pricing/)。

  对于 Glue 版本 2.0\$1 作业，不能指定 `Maximum capacity`。而应指定 `Worker type` 和 `Number of workers`。

  如果使用 `WorkerType` 和 `NumberOfWorkers`，请勿设置 `MaxCapacity`。

  可为 `MaxCapacity` 分配的值取决于您运行的是 Python shell 作业、Apache Spark ETL 作业，还是 Apache Spark 流 ETL 作业：
  + 当您指定 Python shell 作业 (`JobCommand.Name`="pythonshell")，您可以分配 0.0625 或 1 DPU。默认值为 0.0625 DPU。
  + 当您指定 Apache Spark ETL 作业 (`JobCommand.Name`="glueetl") 或 Apache Spark 流 ETL 作业 (`JobCommand.Name`="gluestreaming") 时，您可以分配 2 到 100 个 DPU。默认为 10 个 DPU。此任务类型不能具有小数 DPU 分配。
+ `SecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  该作业将使用的 `SecurityConfiguration` 结构的名称。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  要用于此作业的标签。您可以使用标签来限制对作业的访问。有关 AWS Glue 中的标签的更多信息，请参阅开发人员指南中的 [AWS Glue 中的 AWS 标签](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html)。
+ `NotificationProperty` – 一个 [NotificationProperty](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-NotificationProperty) 对象。

  指定作业通知的配置属性。
+ `GlueVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #48](aws-glue-api-common.md#regex_48) 匹配。

  在 Spark 作业中，`GlueVersion` 确定作业中 AWS Glue 可用的 Apache Spark 和 Python 版本。Python 版本指示了 Spark 类型的任务支持的版本。

  Ray 作业应将 `GlueVersion` 设置为 `4.0` 或更高。但是，Ray 作业中可用的 Ray、Python 和其他库的版本由 Job 命令的 `Runtime` 参数决定。

  有关可用的 AWS Glue 版本以及相应的 Spark 和 Python 版本的更多信息，请参阅开发人员指南中的 [Glue 版本](https://docs.aws.amazon.com/glue/latest/dg/add-job.html)。

  在未指定 Glue 版本的情况下创建的任务默认为 Glue 0.9。
+ `NumberOfWorkers` – 数字（整数）。

  任务运行时分配的定义 `workerType` 的工作线程数。
+ `WorkerType`：UTF-8 字符串（有效值：`Standard=""` \$1 `G.025X=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `G.12X=""` \$1 `G.16X=""` \$1 `R.1X=""` \$1 `R.2X=""` \$1 `R.4X=""` \$1 `R.8X=""` \$1 `Z.2X=""`）。

  任务运行时分配的预定义工作线程的类型。接受 G.025X、G.1X、G.2X、G.4X、G.8X、G.12X、G.16X、R.1X、R.2X、R.4X 或 R.8X 的值，用于 Spark 任务。接受 Ray 作业的值 Z.2X。
  + 对于 `G.025X` 工作线程类型，每个工作线程映射到 0.25 个 DPU（2 个 vCPU，4GB 内存），84GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议为低容量串流任务使用此 Worker 类型。此工作线程类型仅适用于 AWS Glue 版本 3.0 或更高版本的流式处理作业。
  + 对于 `G.1X` 工作线程类型，每个工作线程映射到 1 个 DPU（4 个 vCPU，16GB 内存），94GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将这种工作线程类型用于数据转换、联接和查询等工作负载，以提供一种可扩展且经济实惠的方式来运行大多数作业。
  + 对于 `G.2X` 工作线程类型，每个工作线程映射到 2 个 DPU（8 个 vCPU，32GB 内存），138GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将这种工作线程类型用于数据转换、联接和查询等工作负载，以提供一种可扩展且经济实惠的方式来运行大多数作业。
  + 对于 `G.4X` 工作线程类型，每个工作线程映射到 4 个 DPU（16 个 vCPU，64GB 内存），256GB 磁盘，并且每个工作线程提供 1 个执行程序。对于工作负载包含要求最高的转换、聚合、联接和查询的作业，我们建议使用这种工作线程类型。此 Worker 类型仅适用于以下 AWS 区域的 AWS Glue 3.0 或更高版本 Spark ETL 作业：美国东部（俄亥俄州）、美国东部（弗吉尼亚州北部）、美国西部（北加利福尼亚）、美国西部（俄勒冈州）、亚太地区（孟买）、亚太地区（首尔）、亚太地区（新加坡）、亚太地区（悉尼）、亚太地区（东京）、加拿大（中部）、欧洲地区（法兰克福）、欧洲地区（爱尔兰）、欧洲地区（伦敦）、欧洲（西班牙）、欧洲地区（斯德哥尔摩）和 
  + 对于 `G.8X` 工作线程类型，每个工作线程映射到 8 个 DPU（32 个 vCPU，128GB 内存），512GB 磁盘，并且每个工作线程提供 1 个执行程序。对于工作负载包含要求最高的转换、聚合、联接和查询的作业，我们建议使用这种工作线程类型。此工作线程类型仅适用于 AWS Glue 3.0 版或更高版本的 Spark ETL 作业，其区域与 `G.4X` 工作线程类型支持的 AWS 区域相同。
  + 对于 `G.12X` 工作线程类型，每个工作线程映射到 12 个 DPU（48 个 vCPU，192GB 内存），768GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将此工作线程类型用于工作负载非常大的任务。此工作线程类型仅适用于 AWS Glue 版本 4.0 或更高版本的 Spark ETL 任务。
  + 对于 `G.16X` 工作线程类型，每个工作线程映射到 16 个 DPU（64 个 vCPU，256GB 内存），1024GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将此工作线程类型用于工作负载非常大的任务。此工作线程类型仅适用于 AWS Glue 版本 4.0 或更高版本的 Spark ETL 任务。
  + 对于 `R.1X` 工作线程类型，每个工作线程映射到 1 个 DPU（4 个 vCPU，32GB 内存），94GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将此工作线程类型用于内存密集型工作负载。此工作线程类型仅适用于 AWS Glue 版本 4.0 或更高版本的 Spark ETL 任务。
  + 对于 `R.2X` 工作线程类型，每个工作线程映射到 2 个 DPU（8 个 vCPU，64GB 内存），128GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将此工作线程类型用于内存密集型工作负载。此工作线程类型仅适用于 AWS Glue 版本 4.0 或更高版本的 Spark ETL 任务。
  + 对于 `R.4X` 工作线程类型，每个工作线程映射到 4 个 DPU（16 个 vCPU，128GB 内存），256GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将此工作线程类型用于内存密集型工作负载。此工作线程类型仅适用于 AWS Glue 版本 4.0 或更高版本的 Spark ETL 任务。
  + 对于 `R.8X` 工作线程类型，每个工作线程映射到 8 个 DPU（32 个 vCPU，256GB 内存），512GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将此工作线程类型用于内存密集型工作负载。此工作线程类型仅适用于 AWS Glue 版本 4.0 或更高版本的 Spark ETL 任务。
  + 对于 `Z.2X` 工作线程类型，每个工作线程映射到 2 个 M-DPU（8 个 vCPU，64GB 内存），128GB 磁盘，基于自动缩放器最多提供 8 个 Ray 工作线程。
+ `CodeGenConfigurationNodes` – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，与 [Custom string pattern #60](aws-glue-api-common.md#regex_60) 匹配。

  每个值都是一个 [CodeGenConfigurationNode](aws-glue-api-visual-job-api.md#aws-glue-api-visual-job-api-CodeGenConfigurationNode) 对象。

  定向非循环图表的表示形式，Glue Studio 可视化组件和 Glue Studio 代码生成都是基于该图表的。
+ `ExecutionClass` – UTF-8 字符串，长度不超过 16 个字节（有效值：`FLEX=""` \$1 `STANDARD=""`）。

  指示任务是使用标准执行类还是灵活执行类运行的。标准执行类非常适合需要快速任务启动和专用资源的时间敏感型工作负载。

  灵活执行类适用于启动和完成时间可能不同的时间不敏感型作业。

  只有具有 AWS Glue 版本 3.0 和以上版本以及命令类型 `glueetl` 的任务才允许将 `ExecutionClass` 设置为 `FLEX`。灵活的执行类可用于 Spark 任务。
+ `SourceControlDetails` – 一个 [SourceControlDetails](#aws-glue-api-jobs-job-SourceControlDetails) 对象。

  作业源代码控制配置的详细信息，允许将作业构件同步到远程存储库或从远程存储库同步。
+ `MaintenanceWindow` – UTF-8 字符串，与 [Custom string pattern #34](aws-glue-api-common.md#regex_34) 匹配。

  此字段指定一周中的某一天和一小时，作为流式传输任务的维护时段。AWS Glue 会定期执行维护活动。在这些维护时段内，AWS Glue 需要重新启动您的流式传输任务。

  AWS Glue 将在指定维护时段后的 3 小时内重新启动任务。例如，如果您将维护时段设置为 GMT 时间星期一上午 10:00，则您的任务将在 GMT 时间上午 10:00 至下午 1:00 之间重新启动。
+ `ProfileName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与作业关联的 AWS Glue 使用情况配置文件名称。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  为此作业定义提供的唯一名称。

**错误**
+ `InvalidInputException`
+ `IdempotentParameterMismatchException`
+ `AlreadyExistsException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentModificationException`

## UpdateJob 操作（Python：update\$1job）
<a name="aws-glue-api-jobs-job-UpdateJob"></a>

更新现有的作业定义。此信息会完全覆盖先前的作业定义。

**请求**
+ `JobName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要更新的作业定义的名称。
+ `JobUpdate` – *必填：*一个 [JobUpdate](#aws-glue-api-jobs-job-JobUpdate) 对象。

  指定用于更新作业定义的值。未指定的配置已移除或重置为默认值。
+ `ProfileName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与作业关联的 AWS Glue 使用情况配置文件名称。

**响应**
+ `JobName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  返回更新的作业定义的名称。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`

## GetJob 操作（Python：get\$1job）
<a name="aws-glue-api-jobs-job-GetJob"></a>

检索现有的作业定义。

**请求**
+ `JobName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索的作业定义的名称。

**响应**
+ `Job` – 一个 [任务](#aws-glue-api-jobs-job-Job) 对象。

  请求的作业定义。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## GetJobs 操作（Python：get\$1jobs）
<a name="aws-glue-api-jobs-job-GetJobs"></a>

检索所有当前作业定义。

**请求**
+ `NextToken` – UTF-8 字符串。

  延续标记 (如果这是延续调用)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  响应的最大大小。

**响应**
+ `Jobs` – [任务](#aws-glue-api-jobs-job-Job) 对象的数组。

  作业定义的列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果尚未返回所有作业定义)。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## DeleteJob 操作（Python：delete\$1job）
<a name="aws-glue-api-jobs-job-DeleteJob"></a>

删除指定的作业定义。如果找不到该作业定义，则不会引发异常。

**请求**
+ `JobName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的作业定义的名称。

**响应**
+ `JobName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  已删除的作业定义的名称。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## ListJobs 操作（Python：list\$1jobs）
<a name="aws-glue-api-jobs-job-ListJobs"></a>

检索此 AWS 账户中所有任务资源的名称或带指定标签的资源。此操作可让您查看您账户中可用的资源及其名称。

此操作采用可选的 `Tags` 字段，您可以将其用作响应的筛选器，以便将标记的资源作为一个组进行检索。如果您选择使用标签筛选，则仅检索带标签的资源。

**请求**
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果这是延续请求)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的列表的最大大小。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  指定仅返回这些已标记的资源。

**响应**
+ `JobNames` – UTF-8 字符串数组。

  账户中所有作业的名称或带指定标签的作业。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果返回的列表不包含上一个可用的指标)。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## BatchGetJobs 操作（Python：batch\$1get\$1jobs）
<a name="aws-glue-api-jobs-job-BatchGetJobs"></a>

返回给定作业名称列表的资源元数据的列表。调用 `ListJobs` 操作后，您可以调用此操作来访问您有权访问的数据。此操作支持所有 IAM 权限，包括使用标签的权限条件。

**请求**
+ `JobNames` – *必填*：UTF-8 字符串数组。

  作业名称列表，这些名称可能是通过 `ListJobs` 操作返回的名称。

**响应**
+ `Jobs` – [任务](#aws-glue-api-jobs-job-Job) 对象的数组。

  作业定义的列表。
+ `JobsNotFound` – UTF-8 字符串数组。

  未找到作业名称的列表。

**错误**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

# 任务运行
<a name="aws-glue-api-jobs-runs"></a>

 任务运行 API 介绍与在 AWS Glue 中开启、停止或查看任务运行以及重置任务书签相关的数据类型和 API。您可以在 90 天内访问工作流和任务运行的任务运行历史记录。

## 数据类型
<a name="aws-glue-api-jobs-runs-objects"></a>
+ [JobRun 结构](#aws-glue-api-jobs-runs-JobRun)
+ [Predecessor 结构](#aws-glue-api-jobs-runs-Predecessor)
+ [JobBookmarkEntry 结构](#aws-glue-api-jobs-runs-JobBookmarkEntry)
+ [BatchStopJobRunSuccessfulSubmission 结构](#aws-glue-api-jobs-runs-BatchStopJobRunSuccessfulSubmission)
+ [BatchStopJobRunError 结构](#aws-glue-api-jobs-runs-BatchStopJobRunError)
+ [NotificationProperty 结构](#aws-glue-api-jobs-runs-NotificationProperty)

## JobRun 结构
<a name="aws-glue-api-jobs-runs-JobRun"></a>

包含有关任务运行的信息。

**字段**
+ `Id` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  此任务运行的 ID。
+ `Attempt` – 数字（整数）。

  尝试运行此任务的次数。
+ `PreviousRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  此任务以前运行时的 ID。例如，`StartJobRun` 操作中指定的 `JobRunId`。
+ `TriggerName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  启动此任务运行的触发器的名称。
+ `JobName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  此运行中使用的任务定义的名称。
+ `JobMode` – UTF-8 字符串（有效值：`SCRIPT=""` \$1 `VISUAL=""` \$1 `NOTEBOOK=""`）。

  描述任务是如何创建的模式。有效值为：
  + `SCRIPT` – 该任务使用 AWS Glue Studio 脚本编辑器创建。
  + `VISUAL` – 该任务使用 AWS Glue Studio 可视化编辑器创建。
  + `NOTEBOOK` – 该任务使用交互式会话笔记本创建。

  当 `JobMode` 字段缺失或为空时，`SCRIPT` 将指定为默认值。
+ `JobRunQueuingEnabled`：布尔值。

  指定是否为作业运行启用作业运行排队。

  值为 true 表示已为作业运行启用作业运行排队。如果为 false 或未填充任何选项，则不会启用作业运行排队。
+ `StartedOn` – 时间戳。

  此任务运行的启动日期和时间。
+ `LastModifiedOn` – 时间戳。

  此作业运行的上次修改时间。
+ `CompletedOn` – 时间戳。

  此任务运行的完成日期和时间。
+ `JobRunState` - UTF-8 字符串（有效值：`STARTING` \$1 `RUNNING` \$1 `STOPPING` \$1 `STOPPED` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `TIMEOUT` \$1 `ERROR` \$1 `WAITING` \$1 `EXPIRED`）。

  任务运行的当前状态。有关异常终止的任务的状态的更多信息，请参阅 [AWS Glue 任务运行状态](https://docs.aws.amazon.com/glue/latest/dg/job-run-statuses.html)。
+ `Arguments` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  与此运行关联的任务参数。对于此任务运行，它们会替换任务定义本身中的默认参数集。

  可以在此处指定您自己的任务执行脚本使用的参数以及 AWS Glue 本身使用的参数。

  可能会记录任务参数。不要将明文密钥作为参数传递。如果您想要将密钥保留在任务内，则请通过 AWS Glue 连接、AWS Secrets Manager 或其他密钥管理机制检索密钥。

  有关如何指定和使用您自己的任务参数的信息，请参阅开发人员指南中的[在 Python 中调用 AWS Glue API ](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html)主题。

  有关在配置 Spark 作业时可以为该字段提供的参数的信息，请参阅《开发人员指南》中的 [Special Parameters Used by AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) 主题。

  有关在配置 Ray 作业时可以为该字段提供的参数的信息，请参阅《开发人员指南》中的 [Using job parameters in Ray jobs](https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html)。
+ `ErrorMessage` – UTF-8 字符串。

  与此任务运行关联的错误消息。
+ `PredecessorRuns` – [Predecessor](#aws-glue-api-jobs-runs-Predecessor) 对象的数组。

  此任务运行的前身列表。
+ `AllocatedCapacity` – 数字（整数）。

  此字段已弃用。请改用 `MaxCapacity`。

  分配给此 JobRun 的 AWS Glue 数据处理单元（DPU）的数量。可以分配 2 到 100 个 DPU；默认值为 10。DPU 是对处理能力的相对度量，它由 4 个 vCPU 的计算容量和 16GB 内存组成。有关更多信息，请参阅 [AWS Glue 价格页面](https://aws.amazon.com/glue/pricing/)。
+ `ExecutionTime` – 数字（整数）。

  作业运行使用资源的时间长度 (以秒为单位)。
+ `Timeout` - 数字（整数），至少为 1。

  `JobRun` 超时（分钟） 这是任务运行在终止并进入 `TIMEOUT` 状态前可以使用资源的最长时间。此值会覆盖父任务中设置的超时值。

  作业的超时值必须小于 7 天或 10080 分钟。否则，作业会引发异常。

  该值留空时，超时值默认为 2880 分钟。

  任何超时值大于 7 天的现有 AWS Glue 作业，该值默认为 7 天。例如，若为批处理作业指定了 20 天的超时值，则该作业将在第 7 天停止。

  对于流式传输作业，如果设置了维护时段，则将于 7 天后在维护时段内重新启动。
+ `MaxCapacity` – 数字（double）。

  对于 Glue 版本 1.0 或更早版本的任务，使用标准工件类型，表示此任务运行时可分配的 AWS Glue 数据处理单元（DPU）的数量。DPU 是对处理能力的相对度量，它由 4 个 vCPU 的计算容量和 16GB 内存组成。有关更多信息，请参阅 [AWS Glue 价格页面](https://aws.amazon.com/glue/pricing/)。

  对于 Glue 版本 2.0\$1 作业，不能指定 `Maximum capacity`。而应指定 `Worker type` 和 `Number of workers`。

  如果使用 `WorkerType` 和 `NumberOfWorkers`，请勿设置 `MaxCapacity`。

  可为 `MaxCapacity` 分配的值取决于您运行的是 Python shell 作业、Apache Spark ETL 作业，还是 Apache Spark 流 ETL 作业：
  + 当您指定 Python shell 作业 (`JobCommand.Name`="pythonshell")，您可以分配 0.0625 或 1 DPU。默认值为 0.0625 DPU。
  + 当您指定 Apache Spark ETL 作业 (`JobCommand.Name`="glueetl") 或 Apache Spark 流 ETL 作业 (`JobCommand.Name`="gluestreaming") 时，您可以分配 2 到 100 个 DPU。默认为 10 个 DPU。此任务类型不能具有小数 DPU 分配。
+ `WorkerType`：UTF-8 字符串（有效值：`Standard=""` \$1 `G.025X=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `G.12X=""` \$1 `G.16X=""` \$1 `R.1X=""` \$1 `R.2X=""` \$1 `R.4X=""` \$1 `R.8X=""` \$1 `Z.2X=""`）。

  任务运行时分配的预定义工作线程的类型。接受 G.025X、G.1X、G.2X、G.4X、G.8X、G.12X、G.16X、R.1X、R.2X、R.4X 或 R.8X 的值，用于 Spark 任务。接受 Ray 作业的值 Z.2X。
  + 对于 `G.1X` 工作线程类型，每个工作线程映射到 1 个 DPU（4 个 vCPU，16GB 内存），94GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将这种工作线程类型用于数据转换、联接和查询等工作负载，以提供一种可扩展且经济实惠的方式来运行大多数作业。
  + 对于 `G.2X` 工作线程类型，每个工作线程映射到 2 个 DPU（8 个 vCPU，32GB 内存），138GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将这种工作线程类型用于数据转换、联接和查询等工作负载，以提供一种可扩展且经济实惠的方式来运行大多数作业。
  + 对于 `G.4X` 工作线程类型，每个工作线程映射到 4 个 DPU（16 个 vCPU，64GB 内存），256GB 磁盘，并且每个工作线程提供 1 个执行程序。对于工作负载包含要求最高的转换、聚合、联接和查询的作业，我们建议使用这种工作线程类型。此工作线程类型仅适用于以下 AWS 区域的 AWS Glue 3.0 版或更高版本的 Spark ETL 作业：美国东部（俄亥俄州）、美国东部（弗吉尼亚州北部）、美国西部（俄勒冈州）、亚太地区（新加坡）、亚太地区（悉尼）、亚太地区（东京）、加拿大（中部）、欧洲地区（法兰克福）、欧洲地区（爱尔兰）和欧洲地区（斯德哥尔摩）。
  + 对于 `G.8X` 工作线程类型，每个工作线程映射到 8 个 DPU（32 个 vCPU，128GB 内存），512GB 磁盘，并且每个工作线程提供 1 个执行程序。对于工作负载包含要求最高的转换、聚合、联接和查询的作业，我们建议使用这种工作线程类型。此工作线程类型仅适用于 AWS Glue 3.0 版或更高版本的 Spark ETL 作业，其区域与 `G.4X` 工作线程类型支持的 AWS 区域相同。
  + 对于 `G.12X` 工作线程类型，每个工作线程映射到 12 个 DPU（48 个 vCPU，192GB 内存），768GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将此工作线程类型用于工作负载非常大的任务。此工作线程类型仅适用于 AWS Glue 版本 4.0 或更高版本的 Spark ETL 任务。
  + 对于 `G.16X` 工作线程类型，每个工作线程映射到 16 个 DPU（64 个 vCPU，256GB 内存），1024GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将此工作线程类型用于工作负载非常大的任务。此工作线程类型仅适用于 AWS Glue 版本 4.0 或更高版本的 Spark ETL 任务。
  + 对于 `G.025X` 工作线程类型，每个工作线程映射到 0.25 个 DPU（2 个 vCPU，4GB 内存），84GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议为低容量串流任务使用此 Worker 类型。此工作线程类型仅适用于 AWS Glue 版本 3.0 或更高版本的流式处理作业。
  + 对于 `R.1X` 工作线程类型，每个工作线程映射到 1 个 DPU（4 个 vCPU，32GB 内存），94GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将此工作线程类型用于内存密集型工作负载。此工作线程类型仅适用于 AWS Glue 版本 4.0 或更高版本的 Spark ETL 任务。
  + 对于 `R.2X` 工作线程类型，每个工作线程映射到 2 个 DPU（8 个 vCPU，64GB 内存），128GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将此工作线程类型用于内存密集型工作负载。此工作线程类型仅适用于 AWS Glue 版本 4.0 或更高版本的 Spark ETL 任务。
  + 对于 `R.4X` 工作线程类型，每个工作线程映射到 4 个 DPU（16 个 vCPU，128GB 内存），256GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将此工作线程类型用于内存密集型工作负载。此工作线程类型仅适用于 AWS Glue 版本 4.0 或更高版本的 Spark ETL 任务。
  + 对于 `R.8X` 工作线程类型，每个工作线程映射到 8 个 DPU（32 个 vCPU，256GB 内存），512GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将此工作线程类型用于内存密集型工作负载。此工作线程类型仅适用于 AWS Glue 版本 4.0 或更高版本的 Spark ETL 任务。
  + 对于 `Z.2X` 工作线程类型，每个工作线程映射到 2 个 M-DPU（8 个 vCPU，64 GB 内存），128 GB 磁盘，基于自动缩放器最多提供 8 个 Ray 工作线程。
+ `NumberOfWorkers` – 数字（整数）。

  任务运行时分配的定义 `workerType` 的工作线程数。
+ `SecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  运行该任务将使用的 `SecurityConfiguration` 结构的名称。
+ `LogGroupName` – UTF-8 字符串。

  用于进行安全日志记录的日志组的名称，可在 Amazon CloudWatch 中使用 AWS KMS 进行服务器端加密。此名称可以是 `/aws-glue/jobs/`，在这种情况下，默认加密为 `NONE`。如果您添加角色名称和 `SecurityConfiguration` 名称（换句话说，`/aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/`），则该安全配置将用于加密该日志组。
+ `NotificationProperty` – 一个 [NotificationProperty](#aws-glue-api-jobs-runs-NotificationProperty) 对象。

  指定任务运行通知的配置属性。
+ `GlueVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #48](aws-glue-api-common.md#regex_48) 匹配。

  在 Spark 作业中，`GlueVersion` 确定作业中 AWS Glue 可用的 Apache Spark 和 Python 版本。Python 版本指示了 Spark 类型的任务支持的版本。

  Ray 作业应将 `GlueVersion` 设置为 `4.0` 或更高。但是，Ray 作业中可用的 Ray、Python 和其他库的版本由 Job 命令的 `Runtime` 参数决定。

  有关可用的 AWS Glue 版本以及相应的 Spark 和 Python 版本的更多信息，请参阅开发人员指南中的 [Glue 版本](https://docs.aws.amazon.com/glue/latest/dg/add-job.html)。

  在未指定 Glue 版本的情况下创建的任务默认为 Glue 0.9。
+ `DPUSeconds` – 数字（double）。

  此字段可针对使用 `FLEX` 执行类运行的任务设置，也可以在启用自动扩缩功能时设置，等于任务运行生命周期内每个执行器运行的总时间（以秒为单位）乘以 DPU 因子（`G.1X` 个工作线程时为 1，`G.2X` 个工作线程时为 2，`G.025X` 个工作线程时为 0.25）。此值可能不同于弹性伸缩任务中的 `executionEngineRuntime` \$1 `MaxCapacity`，因为在给定时间运行的执行程序数量可能少于 `MaxCapacity`。因此，`DPUSeconds` 的值可能小于 `executionEngineRuntime` \$1 `MaxCapacity`。
+ `ExecutionClass` – UTF-8 字符串，长度不超过 16 个字节（有效值：`FLEX=""` \$1 `STANDARD=""`）。

  指示任务是使用标准执行类还是灵活执行类运行的。标准执行类非常适合需要快速任务启动和专用资源的时间敏感型工作负载。

  灵活执行类适用于启动和完成时间可能不同的时间不敏感型作业。

  只有具有 AWS Glue 版本 3.0 和以上版本以及命令类型 `glueetl` 的任务才允许将 `ExecutionClass` 设置为 `FLEX`。灵活的执行类可用于 Spark 任务。
+ `MaintenanceWindow` – UTF-8 字符串，与 [Custom string pattern #34](aws-glue-api-common.md#regex_34) 匹配。

  此字段指定一周中的某一天和一小时，作为流式传输任务的维护时段。AWS Glue 会定期执行维护活动。在这些维护时段内，AWS Glue 需要重新启动您的流式传输任务。

  AWS Glue 将在指定维护时段后的 3 小时内重新启动任务。例如，如果您将维护时段设置为 GMT 时间星期一上午 10:00，则您的任务将在 GMT 时间上午 10:00 至下午 1:00 之间重新启动。
+ `ProfileName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与作业运行关联的 AWS Glue 使用情况配置文件名称。
+ `StateDetail` – UTF-8 字符串，长度不超过 400000 个字节。

  此字段包含与作业运行状态相关的详细信息。此字段可以为空。

  例如，当作业运行由于任务运行排队而处于等待状态时，该字段会包含作业运行处于该状态的原因。
+ `ExecutionRoleSessionPolicy`：UTF-8 字符串，长度不少于 2 个字节，不超过 2048 个字节。

  StartJobRun API 的此内联会话策略可以动态限制指定执行角色对作业范围的权限，而无需创建额外的 IAM 角色。

## Predecessor 结构
<a name="aws-glue-api-jobs-runs-Predecessor"></a>

在触发此任务运行的条件触发器的谓词中使用的任务运行。

**字段**
+ `JobName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  任务运行前身使用的任务定义的名称。
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  任务运行前身的任务运行 ID。

## JobBookmarkEntry 结构
<a name="aws-glue-api-jobs-runs-JobBookmarkEntry"></a>

定义任务可以恢复处理的点。

**字段**
+ `JobName` – UTF-8 字符串。

  相关任务的名称。
+ `Version` – 数字（整数）。

  任务的版本。
+ `Run` – 数字（整数）。

  运行 ID 号。
+ `Attempt` – 数字（整数）。

  尝试 ID 号。
+ `PreviousRunId` – UTF-8 字符串。

  与上次任务运行关联的唯一运行标识符。
+ `RunId` – UTF-8 字符串。

  运行 ID 号。
+ `JobBookmark` – UTF-8 字符串。

  书签本身。

## BatchStopJobRunSuccessfulSubmission 结构
<a name="aws-glue-api-jobs-runs-BatchStopJobRunSuccessfulSubmission"></a>

记录成功的对停止指定 `JobRun` 的请求。

**字段**
+ `JobName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  已停止的任务运行中使用的任务定义的名称。
+ `JobRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  已停止的任务运行的 `JobRunId`。

## BatchStopJobRunError 结构
<a name="aws-glue-api-jobs-runs-BatchStopJobRunError"></a>

记录在尝试停止指定的任务运行时出现的错误。

**字段**
+ `JobName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  相关任务运行中使用的任务业定义的名称。
+ `JobRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  相关任务运行的 `JobRunId`。
+ `ErrorDetail` – 一个 [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail) 对象。

  指定有关遇到的错误的详细信息。

## NotificationProperty 结构
<a name="aws-glue-api-jobs-runs-NotificationProperty"></a>

指定通知的配置属性。

**字段**
+ `NotifyDelayAfter` - 数字（整数），至少为 1。

  在作业运行开始后，发送作业运行延迟通知之前等待的分钟数。

## 操作
<a name="aws-glue-api-jobs-runs-actions"></a>
+ [StartJobRun 操作（Python：start\$1job\$1run）](#aws-glue-api-jobs-runs-StartJobRun)
+ [BatchStopJobRun 操作（Python：batch\$1stop\$1job\$1run）](#aws-glue-api-jobs-runs-BatchStopJobRun)
+ [GetJobRun 操作（Python：get\$1job\$1run）](#aws-glue-api-jobs-runs-GetJobRun)
+ [GetJobRuns 操作（Python：get\$1job\$1runs）](#aws-glue-api-jobs-runs-GetJobRuns)
+ [GetJobBookmark 操作（Python：get\$1job\$1bookmark）](#aws-glue-api-jobs-runs-GetJobBookmark)
+ [GetJobBookmarks 操作（Python：get\$1job\$1bookmarks）](#aws-glue-api-jobs-runs-GetJobBookmarks)
+ [ResetJobBookmark 操作（Python：reset\$1job\$1bookmark）](#aws-glue-api-jobs-runs-ResetJobBookmark)

## StartJobRun 操作（Python：start\$1job\$1run）
<a name="aws-glue-api-jobs-runs-StartJobRun"></a>

使用任务定义启动任务运行。

**请求**
+ `JobName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要使用的任务定义的名称。
+ `JobRunQueuingEnabled`：布尔值。

  指定是否为作业运行启用作业运行排队。

  值为 true 表示已为作业运行启用作业运行排队。如果为 false 或未填充任何选项，则不会启用作业运行排队。
+ `JobRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要重试的以前的 `JobRun` 的 ID。
+ `Arguments` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  与此运行关联的任务参数。对于此任务运行，它们会替换任务定义本身中的默认参数集。

  可以在此处指定您自己的任务执行脚本使用的参数以及 AWS Glue 本身使用的参数。

  可能会记录任务参数。不要将明文密钥作为参数传递。如果您想要将密钥保留在任务内，则请通过 AWS Glue 连接、AWS Secrets Manager 或其他密钥管理机制检索密钥。

  有关如何指定和使用您自己的任务参数的信息，请参阅开发人员指南中的[在 Python 中调用 AWS Glue API ](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html)主题。

  有关在配置 Spark 作业时可以为该字段提供的参数的信息，请参阅《开发人员指南》中的 [Special Parameters Used by AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) 主题。

  有关在配置 Spark 作业时可以为该字段提供的参数的信息，请参阅《开发人员指南》中的 [Using job parameters in Ray jobs](https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html)。
+ `AllocatedCapacity` – 数字（整数）。

  此字段已弃用。请改用 `MaxCapacity`。

  要分配给此 JobRun 的 AWS Glue 数据处理单元（DPU）的数量。您可以分配至少 2 个 DPU；默认值为 10。DPU 是对处理能力的相对度量，它由 4 个 vCPU 的计算容量和 16GB 内存组成。有关更多信息，请参阅 [AWS Glue 价格页面](https://aws.amazon.com/glue/pricing/)。
+ `Timeout` - 数字（整数），至少为 1。

  `JobRun` 超时（分钟） 这是任务运行在终止并进入 `TIMEOUT` 状态前可以使用资源的最长时间。此值会覆盖父任务中设置的超时值。

  作业的超时值必须小于 7 天或 10080 分钟。否则，作业会引发异常。

  该值留空时，超时值默认为 2880 分钟。

  任何超时值大于 7 天的现有 AWS Glue 作业，该值默认为 7 天。例如，若为批处理作业指定了 20 天的超时值，则该作业将在第 7 天停止。

  对于流式传输作业，如果设置了维护时段，则将于 7 天后在维护时段内重新启动。
+ `MaxCapacity` – 数字（double）。

  对于 Glue 版本 1.0 或更早版本的任务，使用标准工件类型，表示此任务运行时可分配的 AWS Glue 数据处理单元（DPU）的数量。DPU 是对处理能力的相对度量，它由 4 个 vCPU 的计算容量和 16GB 内存组成。有关更多信息，请参阅 [AWS Glue 价格页面](https://aws.amazon.com/glue/pricing/)。

  对于 Glue 版本 2.0\$1 作业，不能指定 `Maximum capacity`。而应指定 `Worker type` 和 `Number of workers`。

  如果使用 `WorkerType` 和 `NumberOfWorkers`，请勿设置 `MaxCapacity`。

  可为 `MaxCapacity` 分配的值取决于您运行的是 Python shell 作业、Apache Spark ETL 作业，还是 Apache Spark 流 ETL 作业：
  + 当您指定 Python shell 作业 (`JobCommand.Name`="pythonshell")，您可以分配 0.0625 或 1 DPU。默认值为 0.0625 DPU。
  + 当您指定 Apache Spark ETL 作业 (`JobCommand.Name`="glueetl") 或 Apache Spark 流 ETL 作业 (`JobCommand.Name`="gluestreaming") 时，您可以分配 2 到 100 个 DPU。默认为 10 个 DPU。此任务类型不能具有小数 DPU 分配。
+ `SecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  运行该任务将使用的 `SecurityConfiguration` 结构的名称。
+ `NotificationProperty` – 一个 [NotificationProperty](#aws-glue-api-jobs-runs-NotificationProperty) 对象。

  指定任务运行通知的配置属性。
+ `WorkerType` – UTF-8 字符串（有效值：`Standard=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.025X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `Z.2X=""`）。

  任务运行时分配的预定义工作线程的类型。接受 G.1X、G.2X、G.4X、G.8X 或 G.025X 作为 Spark 作业的值。接受 Ray 作业的值 Z.2X。
  + 对于 `G.1X` 工作线程类型，每个工作线程映射到 1 个 DPU（4 个 vCPU，16GB 内存），94GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将这种工作线程类型用于数据转换、联接和查询等工作负载，以提供一种可扩展且经济实惠的方式来运行大多数作业。
  + 对于 `G.2X` 工作线程类型，每个工作线程映射到 2 个 DPU（8 个 vCPU，32GB 内存），138GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将这种工作线程类型用于数据转换、联接和查询等工作负载，以提供一种可扩展且经济实惠的方式来运行大多数作业。
  + 对于 `G.4X` 工作线程类型，每个工作线程映射到 4 个 DPU（16 个 vCPU，64GB 内存），256GB 磁盘，并且每个工作线程提供 1 个执行程序。对于工作负载包含要求最高的转换、聚合、联接和查询的作业，我们建议使用这种工作线程类型。此工作线程类型仅适用于以下 AWS 区域的 AWS Glue 3.0 版或更高版本的 Spark ETL 作业：美国东部（俄亥俄州）、美国东部（弗吉尼亚州北部）、美国西部（俄勒冈州）、亚太地区（新加坡）、亚太地区（悉尼）、亚太地区（东京）、加拿大（中部）、欧洲地区（法兰克福）、欧洲地区（爱尔兰）和欧洲地区（斯德哥尔摩）。
  + 对于 `G.8X` 工作线程类型，每个工作线程映射到 8 个 DPU（32 个 vCPU，128GB 内存），512GB 磁盘，并且每个工作线程提供 1 个执行程序。对于工作负载包含要求最高的转换、聚合、联接和查询的作业，我们建议使用这种工作线程类型。此工作线程类型仅适用于 AWS Glue 3.0 版或更高版本的 Spark ETL 作业，其区域与 `G.4X` 工作线程类型支持的 AWS 区域相同。
  + 对于 `G.12X` 工作线程类型，每个工作线程映射到 12 个 DPU（48 个 vCPU，192GB 内存），768GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将此工作线程类型用于工作负载非常大的任务。此工作线程类型仅适用于 AWS Glue 版本 4.0 或更高版本的 Spark ETL 任务。
  + 对于 `G.16X` 工作线程类型，每个工作线程映射到 16 个 DPU（64 个 vCPU，256GB 内存），1024GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将此工作线程类型用于工作负载非常大的任务。此工作线程类型仅适用于 AWS Glue 版本 4.0 或更高版本的 Spark ETL 任务。
  + 对于 `G.025X` 工作线程类型，每个工作线程映射到 0.25 个 DPU（2 个 vCPU，4GB 内存），84GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议为低容量串流任务使用此 Worker 类型。此工作线程类型仅适用于 AWS Glue 版本 3.0 或更高版本的流式处理作业。
  + 对于 `R.1X` 工作线程类型，每个工作线程映射到 1 个 DPU（4 个 vCPU，32GB 内存），94GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将此工作线程类型用于内存密集型工作负载。此工作线程类型仅适用于 AWS Glue 版本 4.0 或更高版本的 Spark ETL 任务。
  + 对于 `R.2X` 工作线程类型，每个工作线程映射到 2 个 DPU（8 个 vCPU，64GB 内存），128GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将此工作线程类型用于内存密集型工作负载。此工作线程类型仅适用于 AWS Glue 版本 4.0 或更高版本的 Spark ETL 任务。
  + 对于 `R.4X` 工作线程类型，每个工作线程映射到 4 个 DPU（16 个 vCPU，128GB 内存），256GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将此工作线程类型用于内存密集型工作负载。此工作线程类型仅适用于 AWS Glue 版本 4.0 或更高版本的 Spark ETL 任务。
  + 对于 `R.8X` 工作线程类型，每个工作线程映射到 8 个 DPU（32 个 vCPU，256GB 内存），512GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将此工作线程类型用于内存密集型工作负载。此工作线程类型仅适用于 AWS Glue 版本 4.0 或更高版本的 Spark ETL 任务。
  + 对于 `Z.2X` 工作线程类型，每个工作线程映射到 2 个 M-DPU（8 个 vCPU，64 GB 内存），128 GB 磁盘，基于自动缩放器最多提供 8 个 Ray 工作线程。
+ `NumberOfWorkers` – 数字（整数）。

  任务运行时分配的定义 `workerType` 的工作线程数。
+ `ExecutionClass` – UTF-8 字符串，长度不超过 16 个字节（有效值：`FLEX=""` \$1 `STANDARD=""`）。

  指示任务是使用标准执行类还是灵活执行类运行的。标准执行类非常适合需要快速任务启动和专用资源的时间敏感型工作负载。

  灵活执行类适用于启动和完成时间可能不同的时间不敏感型作业。

  只有具有 AWS Glue 版本 3.0 和以上版本以及命令类型 `glueetl` 的任务才允许将 `ExecutionClass` 设置为 `FLEX`。灵活的执行类可用于 Spark 任务。
+ `ProfileName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与作业运行关联的 AWS Glue 使用情况配置文件名称。
+ `ExecutionRoleSessionPolicy`：UTF-8 字符串，长度不少于 2 个字节，不超过 2048 个字节。

  StartJobRun API 的此内联会话策略可以动态限制指定执行角色对作业范围的权限，而无需创建额外的 IAM 角色。

**响应**
+ `JobRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分配给此任务运行的 ID。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentRunsExceededException`

## BatchStopJobRun 操作（Python：batch\$1stop\$1job\$1run）
<a name="aws-glue-api-jobs-runs-BatchStopJobRun"></a>

停止指定的任务定义的一个或多次任务运行。

**请求**
+ `JobName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要停止其任务运行的任务定义的名称。
+ `JobRunIds` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 25 个字符串。

  应为该任务定义停止的 `JobRunIds` 列表。

**响应**
+ `SuccessfulSubmissions` – [BatchStopJobRunSuccessfulSubmission](#aws-glue-api-jobs-runs-BatchStopJobRunSuccessfulSubmission) 对象的数组。

  已成功提交的要停止的 JobRun 列表。
+ `Errors` – [BatchStopJobRunError](#aws-glue-api-jobs-runs-BatchStopJobRunError) 对象的数组。

  尝试停止 `JobRuns` 时遇到的错误列表，包括遇到每个错误的 `JobRunId` 和有关错误的详细信息。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## GetJobRun 操作（Python：get\$1job\$1run）
<a name="aws-glue-api-jobs-runs-GetJobRun"></a>

检索给定任务运行的元数据。您可以在 365 天内访问工作流和作业运行的作业运行历史记录。

**请求**
+ `JobName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  正在运行的任务定义的名称。
+ `RunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  任务运行的 ID。
+ `PredecessorsIncluded`：布尔值。

  如果应返回运行前身的列表，则为 True。

**响应**
+ `JobRun` – 一个 [JobRun](#aws-glue-api-jobs-runs-JobRun) 对象。

  请求的任务运行元数据。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## GetJobRuns 操作（Python：get\$1job\$1runs）
<a name="aws-glue-api-jobs-runs-GetJobRuns"></a>

检索给定任务定义的所有运行的元数据。

`GetJobRuns` 按时间顺序返回作业运行，首先返回最新作业。

**请求**
+ `JobName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索其所有任务运行的作业定义的名称。
+ `NextToken` – UTF-8 字符串。

  延续标记 (如果这是延续调用)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 200。

  响应的最大大小。

**响应**
+ `JobRuns` – [JobRun](#aws-glue-api-jobs-runs-JobRun) 对象的数组。

  任务运行元数据对象的列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌（如果尚未返回所有请求的任务运行）。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## GetJobBookmark 操作（Python：get\$1job\$1bookmark）
<a name="aws-glue-api-jobs-runs-GetJobBookmark"></a>

返回有关任务书签条目的信息。

更多有关启用和使用作业书签的信息，请参阅：
+ [使用作业书签跟踪已处理的数据](https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html)
+ [AWS Glue 使用的作业参数](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html)
+ [作业结构](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job)

**请求**
+ `JobName` – *必填：*UTF-8 字符串。

  相关任务的名称。
+ `Version` – 数字（整数）。

  任务的版本。
+ `RunId` – UTF-8 字符串。

  与此任务运行关联的唯一运行标识符。

**响应**
+ `JobBookmarkEntry` – 一个 [JobBookmarkEntry](#aws-glue-api-jobs-runs-JobBookmarkEntry) 对象。

  用于定义任务可以恢复处理的点的结构。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ValidationException`

## GetJobBookmarks 操作（Python：get\$1job\$1bookmarks）
<a name="aws-glue-api-jobs-runs-GetJobBookmarks"></a>

返回有关任务书签条目的信息。该列表按版本号递减的顺序排列。

更多有关启用和使用作业书签的信息，请参阅：
+ [使用作业书签跟踪已处理的数据](https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html)
+ [AWS Glue 使用的作业参数](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html)
+ [作业结构](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job)

**请求**
+ `JobName` – *必填：*UTF-8 字符串。

  相关任务的名称。
+ `MaxResults` – 数字（整数）。

  响应的最大大小。
+ `NextToken` – 数字（整数）。

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

**响应**
+ `JobBookmarkEntries` – [JobBookmarkEntry](#aws-glue-api-jobs-runs-JobBookmarkEntry) 对象的数组。

  用于定义任务可以恢复处理的点的任务书签条目列表。
+ `NextToken` – 数字（整数）。

  延续令牌，如果返回所有条目，则其值为 1；如果未返回所有请求的任务运行，则其值 > 1。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## ResetJobBookmark 操作（Python：reset\$1job\$1bookmark）
<a name="aws-glue-api-jobs-runs-ResetJobBookmark"></a>

重置书签条目。

更多有关启用和使用作业书签的信息，请参阅：
+ [使用作业书签跟踪已处理的数据](https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html)
+ [AWS Glue 使用的作业参数](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html)
+ [作业结构](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job)

**请求**
+ `JobName` – *必填：*UTF-8 字符串。

  相关任务的名称。
+ `RunId` – UTF-8 字符串。

  与此任务运行关联的唯一运行标识符。

**响应**
+ `JobBookmarkEntry` – 一个 [JobBookmarkEntry](#aws-glue-api-jobs-runs-JobBookmarkEntry) 对象。

  重置的书签条目。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

# 触发
<a name="aws-glue-api-jobs-trigger"></a>

触发器 API 介绍与在 AWS Glue 中创建、更新或删除以及开启和停止任务触发器相关的数据类型和 API。

## 数据类型
<a name="aws-glue-api-jobs-trigger-objects"></a>
+ [Trigger 结构](#aws-glue-api-jobs-trigger-Trigger)
+ [TriggerUpdate 结构](#aws-glue-api-jobs-trigger-TriggerUpdate)
+ [Predicate 结构](#aws-glue-api-jobs-trigger-Predicate)
+ [Condition 结构](#aws-glue-api-jobs-trigger-Condition)
+ [Action 结构](#aws-glue-api-jobs-trigger-Action)
+ [EventBatchingCondition 结构](#aws-glue-api-jobs-trigger-EventBatchingCondition)

## Trigger 结构
<a name="aws-glue-api-jobs-trigger-Trigger"></a>

有关特定触发器的信息。

**字段**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  触发器的名称。
+ `WorkflowName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与触发器关联的工作流程的名称。
+ `Id` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  留待将来使用。
+ `Type` – UTF-8 字符串（有效值：`SCHEDULED` \$1`CONDITIONAL` \$1 `ON_DEMAND` \$1 `EVENT`）。

  触发器的类型。
+ `State` – UTF-8 字符串（有效值：`CREATING` \$1 `CREATED` \$1 `ACTIVATING` \$1 `ACTIVATED` \$1 `DEACTIVATING` \$1 `DEACTIVATED` \$1 `DELETING` \$1 `UPDATING`）。

  触发器的当前状态。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  此触发器的描述。
+ `Schedule` – UTF-8 字符串。

  用于指定计划的 `cron` 表达式 (请参阅[用于作业和爬网程序的基于时间的计划](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html)）。例如，要每天 12:15 UTC 运行某些任务，您应该指定：`cron(15 12 * * ? *)`。
+ `Actions` – [操作](#aws-glue-api-jobs-trigger-Action) 对象的数组。

  通过此触发器发起的操作。
+ `Predicate` – 一个 [谓词](#aws-glue-api-jobs-trigger-Predicate) 对象。

  此触发器的谓词，用于定义触发器将在何时触发。
+ `EventBatchingCondition` – 一个 [EventBatchingCondition](#aws-glue-api-jobs-trigger-EventBatchingCondition) 对象。

  在 EventBridge 事件触发器触发之前必须满足的批处理条件（接收的事件数量或批处理时间段已过期）。

## TriggerUpdate 结构
<a name="aws-glue-api-jobs-trigger-TriggerUpdate"></a>

提供用于更新触发器的信息的结构。此对象通过完全覆盖以前的触发器定义来更新以前的触发器定义。

**字段**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  留待将来使用。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  此触发器的描述。
+ `Schedule` – UTF-8 字符串。

  用于指定计划的 `cron` 表达式 (请参阅[用于作业和爬网程序的基于时间的计划](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html)）。例如，要每天 12:15 UTC 运行某些任务，您应该指定：`cron(15 12 * * ? *)`。
+ `Actions` – [操作](#aws-glue-api-jobs-trigger-Action) 对象的数组。

  通过此触发器发起的操作。
+ `Predicate` – 一个 [谓词](#aws-glue-api-jobs-trigger-Predicate) 对象。

  此触发器的谓词，用于定义触发器将在何时触发。
+ `EventBatchingCondition` – 一个 [EventBatchingCondition](#aws-glue-api-jobs-trigger-EventBatchingCondition) 对象。

  在 EventBridge 事件触发器触发之前必须满足的批处理条件（接收的事件数量或批处理时间段已过期）。

## Predicate 结构
<a name="aws-glue-api-jobs-trigger-Predicate"></a>

定义触发器的谓词，确定触发器何时触发。

**字段**
+ `Logical` – UTF-8 字符串（有效值：`AND` \$1 `ANY`）。

  如果只列出了一个条件，则为可选字段。如果列出了多个条件，则此字段为必需字段。
+ `Conditions` – [状况](#aws-glue-api-jobs-trigger-Condition) 对象数组，不超过 500 个结构。

  确定触发器将何时触发的条件列表。

## Condition 结构
<a name="aws-glue-api-jobs-trigger-Condition"></a>

定义触发器将触发的条件。

**字段**
+ `LogicalOperator` – UTF-8 字符串（有效值：`EQUALS`）。

  一个逻辑运算符。
+ `JobName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  此条件应用于其 `JobRuns` 并且此触发器在其上等待的作业的名称。
+ `State` - UTF-8 字符串（有效值：`STARTING` \$1 `RUNNING` \$1 `STOPPING` \$1 `STOPPED` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `TIMEOUT` \$1 `ERROR` \$1 `WAITING` \$1 `EXPIRED`）。

  条件状态。目前，触发器可侦听的仅有作业为 `SUCCEEDED`、`STOPPED`、`FAILED` 和 `TIMEOUT`。触发器可侦听的仅有爬网程序状态为 `SUCCEEDED`、`FAILED` 和 `CANCELLED`。
+ `CrawlerName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  此条件应用于的爬网程序的名称。
+ `CrawlState` – UTF-8 字符串（有效值：`RUNNING` \$1 `CANCELLING` \$1 `CANCELLED` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `ERROR`）。

  此条件应用于的爬网程序的状态。

## Action 结构
<a name="aws-glue-api-jobs-trigger-Action"></a>

定义触发器发起的操作。

**字段**
+ `JobName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要运行的任务的名称。
+ `Arguments` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  此触发器触发时使用的作业参数。对于此任务运行，它们会替换任务定义本身中的默认参数集。

  可以在此处指定您自己的任务执行脚本使用的参数以及 AWS Glue 本身使用的参数。

  有关如何指定和使用您自己的任务参数的信息，请参阅开发人员指南中的[在 Python 中调用 AWS Glue API ](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html)主题。

  有关 AWS Glue 用于设置任务的键值对的信息，请参阅开发人员指南中的[由 AWS Glue 使用的特殊参数](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html)主题。
+ `Timeout` - 数字（整数），至少为 1。

  `JobRun` 超时（分钟） 这是任务运行在终止并进入 `TIMEOUT` 状态前可以使用资源的最长时间。此值会覆盖父任务中设置的超时值。

  作业的超时值必须小于 7 天或 10080 分钟。否则，作业会引发异常。

  该值留空时，超时值默认为 2880 分钟。

  任何超时值大于 7 天的现有 AWS Glue 作业，该值默认为 7 天。例如，若为批处理作业指定了 20 天的超时值，则该作业将在第 7 天停止。

  对于流式传输作业，如果设置了维护时段，则将于 7 天后在维护时段内重新启动。
+ `SecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  该操作将使用的 `SecurityConfiguration` 结构的名称。
+ `NotificationProperty` – 一个 [NotificationProperty](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-NotificationProperty) 对象。

  指定任务运行通知的配置属性。
+ `CrawlerName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要用于此操作的爬网程序的名称。

## EventBatchingCondition 结构
<a name="aws-glue-api-jobs-trigger-EventBatchingCondition"></a>

在 EventBridge 事件触发器触发之前必须满足的批处理条件（接收的事件数量或批处理时间段已过期）。

**字段**
+ `BatchSize` – *必填*：数字（整数），不小于 1 或大于 100。

  在 EventBridge 事件触发器触发之前，必须从 Amazon EventBridge 接收的事件数。
+ `BatchWindow` – 数字（整数），不小于 1 或大于 900。

  EventBridge 事件触发器触发的时段（以秒为单位）。时段在收到第一个事件时开始计算。

## 操作
<a name="aws-glue-api-jobs-trigger-actions"></a>
+ [CreateTrigger 操作（Python：create\$1trigger）](#aws-glue-api-jobs-trigger-CreateTrigger)
+ [StartTrigger 操作（Python：start\$1trigger）](#aws-glue-api-jobs-trigger-StartTrigger)
+ [GetTrigger 操作（Python：get\$1trigger）](#aws-glue-api-jobs-trigger-GetTrigger)
+ [GetTriggers 操作（Python：get\$1triggers）](#aws-glue-api-jobs-trigger-GetTriggers)
+ [UpdateTrigger 操作（Python：update\$1trigger）](#aws-glue-api-jobs-trigger-UpdateTrigger)
+ [StopTrigger 操作（Python：stop\$1trigger）](#aws-glue-api-jobs-trigger-StopTrigger)
+ [DeleteTrigger 操作（Python：delete\$1trigger）](#aws-glue-api-jobs-trigger-DeleteTrigger)
+ [ListTriggers 操作（Python：list\$1triggers）](#aws-glue-api-jobs-trigger-ListTriggers)
+ [BatchGetTriggers 操作（Python：batch\$1get\$1triggers）](#aws-glue-api-jobs-trigger-BatchGetTriggers)

## CreateTrigger 操作（Python：create\$1trigger）
<a name="aws-glue-api-jobs-trigger-CreateTrigger"></a>

创建新的触发器。

可能会记录任务参数。不要将明文密钥作为参数传递。如果您想要将密钥保留在作业内，请通过 AWS Glue 连接、AWS Secrets Manager 或其他密钥管理机制检索密钥。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  触发器的名称。
+ `WorkflowName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与触发器关联的工作流程的名称。
+ `Type` – *必填*：UTF-8 字符串（有效值：`SCHEDULED` \$1 `CONDITIONAL` \$1 `ON_DEMAND` \$1 `EVENT`）。

  新触发器的类型。
+ `Schedule` – UTF-8 字符串。

  用于指定计划的 `cron` 表达式 (请参阅[用于作业和爬网程序的基于时间的计划](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html)）。例如，要每天 12:15 UTC 运行某些任务，您应该指定：`cron(15 12 * * ? *)`。

  当触发类型为 SCHEDULED 时，此字段为必需字段。
+ `Predicate` – 一个 [谓词](#aws-glue-api-jobs-trigger-Predicate) 对象。

  指定新的触发器应何时触发的谓词。

  当触发类型为 `CONDITIONAL` 时，此字段为必需字段。
+ `Actions` – *必填：*[操作](#aws-glue-api-jobs-trigger-Action) 对象的数组。

  触发器触发时所发起的操作。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  新触发器的描述。
+ `StartOnCreation` – 布尔值。

  设置 `true` 为，可在创建时开启 `SCHEDULED` 和 `CONDITIONAL` 触发器。`ON_DEMAND` 触发器不支持 True。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  要用于此触发器的标签。您可以使用标签来限制对触发器的访问。有关 AWS Glue 中的标签的更多信息，请参阅开发人员指南中的 [AWS Glue 中的 AWS 标签](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html)。
+ `EventBatchingCondition` – 一个 [EventBatchingCondition](#aws-glue-api-jobs-trigger-EventBatchingCondition) 对象。

  在 EventBridge 事件触发器触发之前必须满足的批处理条件（接收的事件数量或批处理时间段已过期）。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  触发器的名称。

**错误**
+ `AlreadyExistsException`
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `IdempotentParameterMismatchException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentModificationException`

## StartTrigger 操作（Python：start\$1trigger）
<a name="aws-glue-api-jobs-trigger-StartTrigger"></a>

启动现有触发器。请参阅[触发作业](https://docs.aws.amazon.com/glue/latest/dg/trigger-job.html)了解有关如何启动不同类型的触发器的信息。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要启动的触发器名称。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  已启动的触发器名称。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentRunsExceededException`

## GetTrigger 操作（Python：get\$1trigger）
<a name="aws-glue-api-jobs-trigger-GetTrigger"></a>

检索触发器的定义。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索的触发器名称。

**响应**
+ `Trigger` – 一个 [触发器](#aws-glue-api-jobs-trigger-Trigger) 对象。

  请求的触发器定义。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## GetTriggers 操作（Python：get\$1triggers）
<a name="aws-glue-api-jobs-trigger-GetTriggers"></a>

获取与一个作业关联的所有触发器。

**请求**
+ `NextToken` – UTF-8 字符串。

  延续标记 (如果这是延续调用)。
+ `DependentJobName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要为其检索触发器的作业的名称。返回可以启动此作业的触发器，如果没有这样的触发器，则返回所有触发器。
+ `MaxResults` – 数字（整数），不小于 1 或大于 200。

  响应的最大大小。

**响应**
+ `Triggers` – [触发器](#aws-glue-api-jobs-trigger-Trigger) 对象的数组。

  指定作业的触发器列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果尚未返回所有请求的触发器)。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## UpdateTrigger 操作（Python：update\$1trigger）
<a name="aws-glue-api-jobs-trigger-UpdateTrigger"></a>

更新触发器定义。

可能会记录任务参数。不要将明文密钥作为参数传递。如果您想要将密钥保留在作业内，请通过 AWS Glue 连接、AWS Secrets Manager 或其他密钥管理机制检索密钥。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要更新的触发器的名称。
+ `TriggerUpdate` – *必填：*一个 [TriggerUpdate](#aws-glue-api-jobs-trigger-TriggerUpdate) 对象。

  用来更新触发器的新值。

**响应**
+ `Trigger` – 一个 [触发器](#aws-glue-api-jobs-trigger-Trigger) 对象。

  生成的触发器定义。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`

## StopTrigger 操作（Python：stop\$1trigger）
<a name="aws-glue-api-jobs-trigger-StopTrigger"></a>

停止指定的触发器。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要停止的触发器名称。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  已停止的触发器名称。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`

## DeleteTrigger 操作（Python：delete\$1trigger）
<a name="aws-glue-api-jobs-trigger-DeleteTrigger"></a>

删除指定的触发器。未找到该触发器不会引发异常。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的触发器的名称。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  已删除的触发器的名称。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`

## ListTriggers 操作（Python：list\$1triggers）
<a name="aws-glue-api-jobs-trigger-ListTriggers"></a>

检索此 AWS 账户中所有触发器资源的名称或带指定标签的资源。此操作可让您查看您账户中可用的资源及其名称。

此操作采用可选的 `Tags` 字段，您可以将其用作响应的筛选器，以便将标记的资源作为一个组进行检索。如果您选择使用标签筛选，则仅检索带标签的资源。

**请求**
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果这是延续请求)。
+ `DependentJobName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

   要为其检索触发器的作业的名称。返回可启动此作业的触发器。如果没有这样的触发器，则返回所有触发器。
+ `MaxResults` – 数字（整数），不小于 1 或大于 200。

  要返回的列表的最大大小。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  指定仅返回这些已标记的资源。

**响应**
+ `TriggerNames` – UTF-8 字符串数组。

  账户中所有触发器的名称或带指定标签的触发器。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果返回的列表不包含上一个可用的指标)。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## BatchGetTriggers 操作（Python：batch\$1get\$1triggers）
<a name="aws-glue-api-jobs-trigger-BatchGetTriggers"></a>

返回给定触发器名称列表的资源元数据的列表。调用 `ListTriggers` 操作后，您可以调用此操作来访问您有权访问的数据。此操作支持所有 IAM 权限，包括使用标签的权限条件。

**请求**
+ `TriggerNames` – *必填*：UTF-8 字符串数组。

  触发器名称列表，这些名称可能是通过 `ListTriggers` 操作返回的名称。

**响应**
+ `Triggers` – [触发器](#aws-glue-api-jobs-trigger-Trigger) 对象的数组。

  触发器定义的列表。
+ `TriggersNotFound` – UTF-8 字符串数组。

  未找到触发器名称的列表。

**错误**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

# AWS Glue 中的集成 API
<a name="aws-glue-api-integrations"></a>

## 数据类型
<a name="aws-glue-api-integrations-objects"></a>
+ [集成结构](#aws-glue-api-integrations-Integration)
+ [IntegrationConfig 结构](#aws-glue-api-integrations-IntegrationConfig)
+ [IntegrationPartition 结构](#aws-glue-api-integrations-IntegrationPartition)
+ [IntegrationError 结构](#aws-glue-api-integrations-IntegrationError)
+ [IntegrationFilter 结构](#aws-glue-api-integrations-IntegrationFilter)
+ [InboundIntegration 结构](#aws-glue-api-integrations-InboundIntegration)
+ [SourceProcessingProperties 结构](#aws-glue-api-integrations-SourceProcessingProperties)
+ [TargetProcessingProperties 结构](#aws-glue-api-integrations-TargetProcessingProperties)
+ [SourceTableConfig 结构](#aws-glue-api-integrations-SourceTableConfig)
+ [TargetTableConfig 结构](#aws-glue-api-integrations-TargetTableConfig)

## 集成结构
<a name="aws-glue-api-integrations-Integration"></a>

描述零 ETL 集成。

**字段**
+ `SourceArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  集成的源的 ARN。
+ `TargetArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  集成的目标的 ARN。
+ `Description`：UTF-8 字符串，长度不超过 1000 个字节，与 [Custom string pattern #12](aws-glue-api-common.md#regex_12) 匹配。

  集成的描述。
+ `IntegrationName`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  集成的唯一名称。
+ `IntegrationArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  集成的 Amazon 资源名称 (ARN)。
+ `KmsKeyId`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  用于加密通道的 KMS 密钥的 ARN。
+ `AdditionalEncryptionContext` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  一组可选的非密钥键值对，包含用于加密的其他上下文信息。仅当提供 `KMSKeyId` 时才可提供此项。
+ `Tags` – [Tag](aws-glue-api-common.md#aws-glue-api-common-Tag) 对象的数组。

  分配给资源的元数据，由键值对列表组成。
+ `Status` – *必填*：UTF-8 字符串（有效值：`CREATING` \$1 `ACTIVE` \$1 `MODIFYING` \$1 `FAILED` \$1 `DELETING` \$1 `SYNCING` \$1 `NEEDS_ATTENTION`）。

  可能状态包括：
  + CREATING：正在创建集成。
  + ACTIVE：集成创建成功。
  + MODIFYING：正在修改集成。
  + FAILED：集成创建失败。
  + DELETING：正在删除集成。
  + SYNCING：集成正在同步。
  + NEEDS\$1ATTENTION：集成需要注意，例如同步。
+ `CreateTime` – *必填*：时间戳。

  创建集成的时间 (UTC)。
+ `IntegrationConfig` – 一个 [IntegrationConfig](#aws-glue-api-integrations-IntegrationConfig) 对象。

  与集成关联的属性。
+ `Errors` – [IntegrationError](#aws-glue-api-integrations-IntegrationError) 对象的数组。

  与集成关联的错误列表。
+ `DataFilter`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  使用 Maxwell 筛选条件语法选择用于集成的源表。

## IntegrationConfig 结构
<a name="aws-glue-api-integrations-IntegrationConfig"></a>

与集成关联的属性。

**字段**
+ `RefreshInterval` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  指定执行 CDC（更改数据捕获）拉取或增量加载的频率。此参数支持灵活地根据特定数据更新模式、系统负载注意事项和性能优化目标调整刷新率。时间增量可以设置为 15 到 8640 分钟（六天）。
+ `SourceProperties` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

   为集成源指定其他属性的键值对集合。这些属性提供有配置选项，可用于自定义 ODB 源在数据集成操作期间的行为。
+ `ContinuousSync`：布尔值。

  支持从以下位置按需提取数据的连续同步：1) SaaS 应用程序到 AWS 数据服务（如 Amazon Redshift 和 Amazon S3）；2) DynamoDB 到 Amazon S3。

## IntegrationPartition 结构
<a name="aws-glue-api-integrations-IntegrationPartition"></a>

描述如何在目标上对数据进行分区的结构。

**字段**
+ `FieldName` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  用于在目标上对数据进行分区的字段名称。避免使用每行具有唯一值的列（例如“LastModifiedTimestamp”、“SystemModTimeStamp”）作为分区列。这些列不适合分区，因为它们会创建大量小分区，从而导致性能问题。
+ `FunctionSpec` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  指定用于对目标上的数据进行分区的函数。此参数的接受值为：
  + `identity` - 无需转换即可直接使用源值
  + `year` - 从时间戳值中提取年份（例如，2023 年）
  + `month` - 从时间戳值中提取月份（例如，2023 年 1 月）
  + `day` - 从时间戳值中提取日期（例如，2023 年 1 月 15 日）
  + `hour` - 从时间戳值中提取小时数（例如，2023 年 1 月 15 日 14 时）
+ `ConversionSpec` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  指定源数据的时间戳格式。有效值为：
  + `epoch_sec` - Unix epoch 时间戳（以秒为单位）
  + `epoch_milli` - Unix epoch 时间戳（以毫秒为单位）
  + `iso` - ISO 8601 格式的时间戳
**注意**  
 仅在使用基于时间戳的分区函数（年、月、日或小时）时指定 `ConversionSpec`。AWS Glue零 ETL 使用此参数在分区之前将源数据正确转换为时间戳格式。  
 不要将高基数列与 `identity` 分区函数一起使用。高基数列包括：  
主键
时间戳字段（例如 `LastModifiedTimestamp`、`CreatedDate`）
系统生成的时间戳
 使用具有标识分区的高基数列会创建许多小分区，这会显著降低摄取性能。

## IntegrationError 结构
<a name="aws-glue-api-integrations-IntegrationError"></a>

与零 ETL 集成关联的错误。

**字段**
+ `ErrorCode` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  与此错误关联的代码。
+ `ErrorMessage`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  描述错误的消息。

## IntegrationFilter 结构
<a name="aws-glue-api-integrations-IntegrationFilter"></a>

可在调用 `DescribeIntegrations` 请求时使用的筛选条件。

**字段**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  筛选器的名称。
+ `Values` – UTF-8 字符串数组。

  筛选条件值的列表。

## InboundIntegration 结构
<a name="aws-glue-api-integrations-InboundIntegration"></a>

用于将数据写入资源的集成的结构。

**字段**
+ `SourceArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  集成的源资源的 ARN。
+ `TargetArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  集成的目标资源的 ARN。
+ `IntegrationArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  零 ETL 集成的 ARN。
+ `Status` – *必填*：UTF-8 字符串（有效值：`CREATING` \$1 `ACTIVE` \$1 `MODIFYING` \$1 `FAILED` \$1 `DELETING` \$1 `SYNCING` \$1 `NEEDS_ATTENTION`）。

  可能状态包括：
  + CREATING：正在创建集成。
  + ACTIVE：集成创建成功。
  + MODIFYING：正在修改集成。
  + FAILED：集成创建失败。
  + DELETING：正在删除集成。
  + SYNCING：集成正在同步。
  + NEEDS\$1ATTENTION：集成需要注意，例如同步。
+ `CreateTime` – *必填*：时间戳。

  创建集成的时间 (UTC)。
+ `IntegrationConfig` – 一个 [IntegrationConfig](#aws-glue-api-integrations-IntegrationConfig) 对象。

  与集成关联的属性。
+ `Errors` – [IntegrationError](#aws-glue-api-integrations-IntegrationError) 对象的数组。

  与集成关联的错误列表。

## SourceProcessingProperties 结构
<a name="aws-glue-api-integrations-SourceProcessingProperties"></a>

与集成源关联的资源属性。

**字段**
+ `RoleArn` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  用于访问 AWS Glue 连接的 IAM 角色。

## TargetProcessingProperties 结构
<a name="aws-glue-api-integrations-TargetProcessingProperties"></a>

与集成目标关联的资源属性。

**字段**
+ `RoleArn` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  用于访问 AWS Glue 数据库的 IAM 角色。
+ `KmsArn`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  用于加密的 KMS 密钥的 ARN。
+ `ConnectionName` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  用于配置在客户 VPC 中运行的 AWS Glue 作业的 AWS Glue 网络连接。
+ `EventBusArn`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  用于接收集成状态通知的 Eventbridge 事件总线的 ARN。

## SourceTableConfig 结构
<a name="aws-glue-api-integrations-SourceTableConfig"></a>

源分支用于处理源中的数据的属性。

**字段**
+ `Fields` – UTF-8 字符串数组。

  用于列级筛选的字段列表。目前不受支持。
+ `FilterPredicate` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  用于行级筛选的条件子句。目前不受支持。
+ `PrimaryKey` – UTF-8 字符串数组。

  提供此表的主键集。目前可根据请求专门支持 SAP `EntityOf` 实体。请联系 AWS Support 启用此功能。
+ `RecordUpdateField` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  增量拉取基于时间戳的字段。目前不受支持。

## TargetTableConfig 结构
<a name="aws-glue-api-integrations-TargetTableConfig"></a>

目标分支用于对目标上的数据进行分区的属性。

**字段**
+ `UnnestSpec` – UTF-8 字符串（有效值：`TOPLEVEL` \$1 `FULL` \$1 `NOUNNEST`）。

  指定嵌套对象如何扁平化为顶级元素。有效的值为：“TOPLEVEL”、“FULL”或“NOUNNEST”。
+ `PartitionSpec` – [IntegrationPartition](#aws-glue-api-integrations-IntegrationPartition) 对象的数组。

  确定目标上的文件布局。
+ `TargetTableName` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  目标表的可选名称。

## 操作
<a name="aws-glue-api-integrations-actions"></a>
+ [CreateIntegration 操作（Python：create\$1integration）](#aws-glue-api-integrations-CreateIntegration)
+ [ModifyIntegration 操作（Python：modify\$1integration）](#aws-glue-api-integrations-ModifyIntegration)
+ [DescribeIntegrations 操作（Python：describe\$1integrations）](#aws-glue-api-integrations-DescribeIntegrations)
+ [DeleteIntegration 操作（Python：delete\$1integration）](#aws-glue-api-integrations-DeleteIntegration)
+ [DescribeInboundIntegrations 操作（Python：describe\$1inbound\$1integrations）](#aws-glue-api-integrations-DescribeInboundIntegrations)
+ [CreateIntegrationTableProperties 操作（Python：create\$1integration\$1table\$1properties）](#aws-glue-api-integrations-CreateIntegrationTableProperties)
+ [UpdateIntegrationTableProperties 操作（Python：update\$1integration\$1table\$1properties）](#aws-glue-api-integrations-UpdateIntegrationTableProperties)
+ [GetIntegrationTableProperties 操作（Python：get\$1integration\$1table\$1properties）](#aws-glue-api-integrations-GetIntegrationTableProperties)
+ [DeleteIntegrationTableProperties 操作（Python：delete\$1integration\$1table\$1properties）](#aws-glue-api-integrations-DeleteIntegrationTableProperties)
+ [CreateIntegrationResourceProperty 操作（Python：create\$1integration\$1resource\$1property）](#aws-glue-api-integrations-CreateIntegrationResourceProperty)
+ [UpdateIntegrationResourceProperty 操作（Python：update\$1integration\$1resource\$1property）](#aws-glue-api-integrations-UpdateIntegrationResourceProperty)
+ [GetIntegrationResourceProperty 操作（Python：get\$1integration\$1resource\$1property）](#aws-glue-api-integrations-GetIntegrationResourceProperty)
+ [UntagResource 操作（Python：untag\$1resource）](#aws-glue-api-integrations-UntagResource)
+ [ListTagsForResource 操作（Python：list\$1tags\$1for\$1resource）](#aws-glue-api-integrations-ListTagsForResource)

## CreateIntegration 操作（Python：create\$1integration）
<a name="aws-glue-api-integrations-CreateIntegration"></a>

在调用者的账户中使用 Amazon 资源名称 (ARN) 在两个资源之间创建零 ETL 集成：`SourceArn` 和 `TargetArn`。

**请求**
+ `IntegrationName`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  AWS Glue 中集成的唯一名称。
+ `SourceArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  集成的源资源的 ARN。
+ `TargetArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  集成的目标资源的 ARN。
+ `Description`：UTF-8 字符串，长度不超过 1000 个字节，与 [Custom string pattern #12](aws-glue-api-common.md#regex_12) 匹配。

  集成的描述。
+ `DataFilter`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  使用 Maxwell 筛选条件语法选择用于集成的源表。
+ `KmsKeyId`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  用于加密通道的 KMS 密钥的 ARN。
+ `AdditionalEncryptionContext` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  一组可选的非密钥键值对，包含用于加密的其他上下文信息。仅当提供 `KMSKeyId` 时才可提供此项。
+ `Tags` – [Tag](aws-glue-api-common.md#aws-glue-api-common-Tag) 对象的数组。

  分配给资源的元数据，由键值对列表组成。
+ `IntegrationConfig` – 一个 [IntegrationConfig](#aws-glue-api-integrations-IntegrationConfig) 对象。

  配置设置。

**响应**
+ `SourceArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  集成的源资源的 ARN。
+ `TargetArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  集成的目标资源的 ARN。
+ `IntegrationName`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  AWS Glue 中集成的唯一名称。
+ `Description`：UTF-8 字符串，长度不超过 1000 个字节，与 [Custom string pattern #12](aws-glue-api-common.md#regex_12) 匹配。

  集成的描述。
+ `IntegrationArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  创建的集成的 Amazon 资源名称 (ARN)。
+ `KmsKeyId`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  用于加密通道的 KMS 密钥的 ARN。
+ `AdditionalEncryptionContext` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  一组可选的非密钥键值对，包含用于加密的其他上下文信息。
+ `Tags` – [Tag](aws-glue-api-common.md#aws-glue-api-common-Tag) 对象的数组。

  分配给资源的元数据，由键值对列表组成。
+ `Status` – *必填*：UTF-8 字符串（有效值：`CREATING` \$1 `ACTIVE` \$1 `MODIFYING` \$1 `FAILED` \$1 `DELETING` \$1 `SYNCING` \$1 `NEEDS_ATTENTION`）。

  正在创建的集成的状态。

  可能状态包括：
  + CREATING：正在创建集成。
  + ACTIVE：集成创建成功。
  + MODIFYING：正在修改集成。
  + FAILED：集成创建失败。
  + DELETING：正在删除集成。
  + SYNCING：集成正在同步。
  + NEEDS\$1ATTENTION：集成需要注意，例如同步。
+ `CreateTime` – *必填*：时间戳。

  创建集成的时间 (UTC)。
+ `Errors` – [IntegrationError](#aws-glue-api-integrations-IntegrationError) 对象的数组。

  与集成创建关联的错误列表。
+ `DataFilter`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  使用 Maxwell 筛选条件语法选择用于集成的源表。
+ `IntegrationConfig` – 一个 [IntegrationConfig](#aws-glue-api-integrations-IntegrationConfig) 对象。

  配置设置。

**错误**
+ `ValidationException`
+ `AccessDeniedException`
+ `ResourceNotFoundException`
+ `InternalServerException`
+ `IntegrationConflictOperationFault`
+ `IntegrationQuotaExceededFault`
+ `KMSKeyNotAccessibleFault`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `ConflictException`
+ `ResourceNumberLimitExceededException`
+ `InvalidInputException`

## ModifyIntegration 操作（Python：modify\$1integration）
<a name="aws-glue-api-integrations-ModifyIntegration"></a>

修改调用者的账户中的零 ETL 集成。

**请求**
+ `IntegrationIdentifier`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  集成的 Amazon 资源名称 (ARN)。
+ `Description`：UTF-8 字符串，长度不超过 1000 个字节，与 [Custom string pattern #12](aws-glue-api-common.md#regex_12) 匹配。

  集成的描述。
+ `DataFilter`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  使用 Maxwell 筛选条件语法选择用于集成的源表。
+ `IntegrationConfig` – 一个 [IntegrationConfig](#aws-glue-api-integrations-IntegrationConfig) 对象。

  集成的配置设置。目前，只能修改 RefreshInterval。
+ `IntegrationName` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  AWS Glue 中集成的唯一名称。

**响应**
+ `SourceArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  集成的源的 ARN。
+ `TargetArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  集成的目标的 ARN。
+ `IntegrationName`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  AWS Glue 中集成的唯一名称。
+ `Description`：UTF-8 字符串，长度不超过 1000 个字节，与 [Custom string pattern #12](aws-glue-api-common.md#regex_12) 匹配。

  集成的描述。
+ `IntegrationArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  集成的 Amazon 资源名称 (ARN)。
+ `KmsKeyId`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  用于加密通道的 KMS 密钥的 ARN。
+ `AdditionalEncryptionContext` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  一组可选的非密钥键值对，包含用于加密的其他上下文信息。
+ `Tags` – [Tag](aws-glue-api-common.md#aws-glue-api-common-Tag) 对象的数组。

  分配给资源的元数据，由键值对列表组成。
+ `Status` – *必填*：UTF-8 字符串（有效值：`CREATING` \$1 `ACTIVE` \$1 `MODIFYING` \$1 `FAILED` \$1 `DELETING` \$1 `SYNCING` \$1 `NEEDS_ATTENTION`）。

  正在修改的集成的状态。

  可能状态包括：
  + CREATING：正在创建集成。
  + ACTIVE：集成创建成功。
  + MODIFYING：正在修改集成。
  + FAILED：集成创建失败。
  + DELETING：正在删除集成。
  + SYNCING：集成正在同步。
  + NEEDS\$1ATTENTION：集成需要注意，例如同步。
+ `CreateTime` – *必填*：时间戳。

  创建集成的时间 (UTC)。
+ `Errors` – [IntegrationError](#aws-glue-api-integrations-IntegrationError) 对象的数组。

  与集成修改关联的错误列表。
+ `DataFilter`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  使用 Maxwell 筛选条件语法选择用于集成的源表。
+ `IntegrationConfig` – 一个 [IntegrationConfig](#aws-glue-api-integrations-IntegrationConfig) 对象。

  更新后的集成配置设置。

**错误**
+ `ValidationException`
+ `AccessDeniedException`
+ `InternalServerException`
+ `IntegrationNotFoundFault`
+ `IntegrationConflictOperationFault`
+ `InvalidIntegrationStateFault`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `ConflictException`
+ `InvalidStateException`
+ `InvalidInputException`

## DescribeIntegrations 操作（Python：describe\$1integrations）
<a name="aws-glue-api-integrations-DescribeIntegrations"></a>

API 用于检索集成列表。

**请求**
+ `IntegrationIdentifier` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  集成的 Amazon 资源名称 (ARN)。
+ `Marker` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  指示后续请求中下一组响应记录的起点的值。
+ `MaxRecords` – 数字（整数）。

  输出中要返回的项总数。
+ `Filters` – [IntegrationFilter](#aws-glue-api-integrations-IntegrationFilter) 对象的数组。

  用于筛选结果的键和值的列表。支持的键有“Status”、“IntegrationName”和“SourceArn”。IntegrationName 仅限于一个值。

**响应**
+ `Integrations` – [集成](#aws-glue-api-integrations-Integration) 对象的数组。

  零 ETL 集成的列表。
+ `Marker` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  指示后续请求中下一组响应记录的起点的值。

**错误**
+ `ValidationException`
+ `AccessDeniedException`
+ `InternalServerException`
+ `IntegrationNotFoundFault`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `InvalidInputException`

## DeleteIntegration 操作（Python：delete\$1integration）
<a name="aws-glue-api-integrations-DeleteIntegration"></a>

删除指定的零 ETL 集成。

**请求**
+ `IntegrationIdentifier`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  集成的 Amazon 资源名称 (ARN)。

**响应**
+ `SourceArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  集成的源的 ARN。
+ `TargetArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  集成的目标的 ARN。
+ `IntegrationName`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  AWS Glue 中集成的唯一名称。
+ `Description`：UTF-8 字符串，长度不超过 1000 个字节，与 [Custom string pattern #12](aws-glue-api-common.md#regex_12) 匹配。

  集成的描述。
+ `IntegrationArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  集成的 Amazon 资源名称 (ARN)。
+ `KmsKeyId`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  用于加密通道的 KMS 密钥的 ARN。
+ `AdditionalEncryptionContext` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  一组可选的非密钥键值对，包含用于加密的其他上下文信息。
+ `Tags` – [Tag](aws-glue-api-common.md#aws-glue-api-common-Tag) 对象的数组。

  分配给资源的元数据，由键值对列表组成。
+ `Status` – *必填*：UTF-8 字符串（有效值：`CREATING` \$1 `ACTIVE` \$1 `MODIFYING` \$1 `FAILED` \$1 `DELETING` \$1 `SYNCING` \$1 `NEEDS_ATTENTION`）。

  正在删除的集成的状态。

  可能状态包括：
  + CREATING：正在创建集成。
  + ACTIVE：集成创建成功。
  + MODIFYING：正在修改集成。
  + FAILED：集成创建失败。
  + DELETING：正在删除集成。
  + SYNCING：集成正在同步。
  + NEEDS\$1ATTENTION：集成需要注意，例如同步。
+ `CreateTime` – *必填*：时间戳。

  创建集成的时间 (UTC)。
+ `Errors` – [IntegrationError](#aws-glue-api-integrations-IntegrationError) 对象的数组。

  与集成关联的错误列表。
+ `DataFilter`：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

  使用 Maxwell 筛选条件语法选择用于集成的源表。

**错误**
+ `ValidationException`
+ `AccessDeniedException`
+ `InternalServerException`
+ `IntegrationNotFoundFault`
+ `IntegrationConflictOperationFault`
+ `InvalidIntegrationStateFault`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `ConflictException`
+ `InvalidStateException`
+ `InvalidInputException`

## DescribeInboundIntegrations 操作（Python：describe\$1inbound\$1integrations）
<a name="aws-glue-api-integrations-DescribeInboundIntegrations"></a>

返回指定集成的入站集成列表。

**请求**
+ `IntegrationArn` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  集成的 Amazon 资源名称 (ARN)。
+ `Marker` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  指定从何处开始分页的令牌。这是先前截断的响应中的标记。
+ `MaxRecords` – 数字（整数）。

  输出中要返回的项总数。
+ `TargetArn` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  集成中目标资源的 Amazon 资源名称 (ARN)。

**响应**
+ `InboundIntegrations` – [InboundIntegration](#aws-glue-api-integrations-InboundIntegration) 对象的数组。

  入站集成列表。
+ `Marker` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  指示后续请求中下一组响应记录的起点的值。

**错误**
+ `ValidationException`
+ `AccessDeniedException`
+ `InternalServerException`
+ `IntegrationNotFoundFault`
+ `TargetResourceNotFound`
+ `OperationNotSupportedException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `InvalidInputException`

## CreateIntegrationTableProperties 操作（Python：create\$1integration\$1table\$1properties）
<a name="aws-glue-api-integrations-CreateIntegrationTableProperties"></a>

此 API 用于为需要复制的表提供可选覆盖属性。这些属性可包括用于对源表和目标表进行筛选和分区的属性。要设置源属性和目标属性，需要分别使用 AWS Glue 连接 ARN 作为 `ResourceArn` 和 `SourceTableConfig` 来调用相同的 API，并使用 AWS Glue 数据库 ARN 作为 `ResourceArn` 和 `TargetTableConfig` 来调用相同的 API。

**请求**
+ `ResourceArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  要为其创建集成表属性的目标表的 Amazon 资源名称 (ARN)。目前，此 API 仅支持为目标表创建集成表属性，并且提供的 ARN 应为 AWS Glue Data Catalog 中目标表的 ARN。尚未实现对源连接（使用连接 ARN）创建集成表属性的支持，将在未来版本中添加。
+ `TableName`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  要复制的表的名称。
+ `SourceTableConfig` – 一个 [SourceTableConfig](#aws-glue-api-integrations-SourceTableConfig) 对象。

  源表配置的结构。要查看支持的源属性列表，请参阅 `SourceTableConfig` 结构。
+ `TargetTableConfig` – 一个 [TargetTableConfig](#aws-glue-api-integrations-TargetTableConfig) 对象。

  目标表配置的结构。

**响应**
+ *无响应参数。*

**错误**
+ `ValidationException`
+ `AccessDeniedException`
+ `ResourceNotFoundException`
+ `InternalServerException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `InvalidInputException`

## UpdateIntegrationTableProperties 操作（Python：update\$1integration\$1table\$1properties）
<a name="aws-glue-api-integrations-UpdateIntegrationTableProperties"></a>

此 API 用于为需要复制的表提供可选覆盖属性。这些属性可包括用于对源表和目标表进行筛选和分区的属性。要设置源属性和目标属性，需要分别使用 AWS Glue 连接 ARN 作为 `ResourceArn` 和 `SourceTableConfig` 来调用相同的 API，并使用 AWS Glue 数据库 ARN 作为 `ResourceArn` 和 `TargetTableConfig` 来调用相同的 API。

覆盖将反映在所有使用相同 `ResourceArn` 和源表的集成中。

**请求**
+ `ResourceArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  源的连接 ARN 或目标的数据库 ARN。
+ `TableName`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  要复制的表的名称。
+ `SourceTableConfig` – 一个 [SourceTableConfig](#aws-glue-api-integrations-SourceTableConfig) 对象。

  源表配置的结构。
+ `TargetTableConfig` – 一个 [TargetTableConfig](#aws-glue-api-integrations-TargetTableConfig) 对象。

  目标表配置的结构。

**响应**
+ *无响应参数。*

**错误**
+ `ValidationException`
+ `AccessDeniedException`
+ `ResourceNotFoundException`
+ `InternalServerException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `InvalidInputException`

## GetIntegrationTableProperties 操作（Python：get\$1integration\$1table\$1properties）
<a name="aws-glue-api-integrations-GetIntegrationTableProperties"></a>

此 API 用于为需要复制的表检索可选覆盖属性。这些属性可包括用于对源表和目标表进行筛选和分区的属性。

**请求**
+ `ResourceArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  要为其检索集成表属性的目标表的 Amazon 资源名称 (ARN)。目前，此 API 仅支持为目标表检索属性，并且提供的 ARN 应为 AWS Glue Data Catalog 中目标表的 ARN。尚未实现对源连接（使用连接 ARN）检索集成表属性的支持，将在未来版本中添加。
+ `TableName`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  要复制的表的名称。

**响应**
+ `ResourceArn` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  要为其检索集成表属性的目标表的 Amazon 资源名称 (ARN)。目前，此 API 仅支持为目标表检索属性，并且提供的 ARN 应为 AWS Glue Data Catalog 中目标表的 ARN。尚未实现对源连接（使用连接 ARN）检索集成表属性的支持，将在未来版本中添加。
+ `TableName` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  要复制的表的名称。
+ `SourceTableConfig` – 一个 [SourceTableConfig](#aws-glue-api-integrations-SourceTableConfig) 对象。

  源表配置的结构。
+ `TargetTableConfig` – 一个 [TargetTableConfig](#aws-glue-api-integrations-TargetTableConfig) 对象。

  目标表配置的结构。

**错误**
+ `ValidationException`
+ `AccessDeniedException`
+ `ResourceNotFoundException`
+ `InternalServerException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `InvalidInputException`

## DeleteIntegrationTableProperties 操作（Python：delete\$1integration\$1table\$1properties）
<a name="aws-glue-api-integrations-DeleteIntegrationTableProperties"></a>

删除为需要复制的表创建的表属性。

**请求**
+ `ResourceArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  源的连接 ARN 或目标的数据库 ARN。
+ `TableName`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  要复制的表的名称。

**响应**
+ *无响应参数。*

**错误**
+ `ValidationException`
+ `AccessDeniedException`
+ `ResourceNotFoundException`
+ `InternalServerException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `InvalidInputException`

## CreateIntegrationResourceProperty 操作（Python：create\$1integration\$1resource\$1property）
<a name="aws-glue-api-integrations-CreateIntegrationResourceProperty"></a>

此 API 可用于设置 AWS Glue 连接（对于源）或 AWS Glue 数据库 ARN（对于目标）的 `ResourceProperty`。这些属性可包括访问连接或数据库的角色。要设置源属性和目标属性，需要分别使用 AWS Glue 连接 ARN 作为 `ResourceArn` 和 `SourceProcessingProperties` 来调用相同的 API，并使用 AWS Glue 数据库 ARN 作为 `ResourceArn` 和 `TargetProcessingProperties` 来调用相同的 API。

**请求**
+ `ResourceArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  源的连接 ARN 或目标的数据库 ARN。
+ `SourceProcessingProperties` – 一个 [SourceProcessingProperties](#aws-glue-api-integrations-SourceProcessingProperties) 对象。

  与集成源关联的资源属性。
+ `TargetProcessingProperties` – 一个 [TargetProcessingProperties](#aws-glue-api-integrations-TargetProcessingProperties) 对象。

  与集成目标关联的资源属性。

**响应**
+ `ResourceArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  源的连接 ARN 或目标的数据库 ARN。
+ `SourceProcessingProperties` – 一个 [SourceProcessingProperties](#aws-glue-api-integrations-SourceProcessingProperties) 对象。

  与集成源关联的资源属性。
+ `TargetProcessingProperties` – 一个 [TargetProcessingProperties](#aws-glue-api-integrations-TargetProcessingProperties) 对象。

  与集成目标关联的资源属性。

**错误**
+ `ValidationException`
+ `AccessDeniedException`
+ `ConflictException`
+ `InternalServerException`
+ `ResourceNotFoundException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `InvalidInputException`

## UpdateIntegrationResourceProperty 操作（Python：update\$1integration\$1resource\$1property）
<a name="aws-glue-api-integrations-UpdateIntegrationResourceProperty"></a>

此 API 可用于更新 AWS Glue 连接（对于源）或 AWS Glue 数据库 ARN（对于目标）的 `ResourceProperty`。这些属性可包括访问连接或数据库的角色。由于相同的资源可以在多个集成中使用，因此更新资源属性将影响所有使用它的集成。

**请求**
+ `ResourceArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  源的连接 ARN 或目标的数据库 ARN。
+ `SourceProcessingProperties` – 一个 [SourceProcessingProperties](#aws-glue-api-integrations-SourceProcessingProperties) 对象。

  与集成源关联的资源属性。
+ `TargetProcessingProperties` – 一个 [TargetProcessingProperties](#aws-glue-api-integrations-TargetProcessingProperties) 对象。

  与集成目标关联的资源属性。

**响应**
+ `ResourceArn` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  源的连接 ARN 或目标的数据库 ARN。
+ `SourceProcessingProperties` – 一个 [SourceProcessingProperties](#aws-glue-api-integrations-SourceProcessingProperties) 对象。

  与集成源关联的资源属性。
+ `TargetProcessingProperties` – 一个 [TargetProcessingProperties](#aws-glue-api-integrations-TargetProcessingProperties) 对象。

  与集成目标关联的资源属性。

**错误**
+ `ValidationException`
+ `AccessDeniedException`
+ `InternalServerException`
+ `ResourceNotFoundException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `InvalidInputException`

## GetIntegrationResourceProperty 操作（Python：get\$1integration\$1resource\$1property）
<a name="aws-glue-api-integrations-GetIntegrationResourceProperty"></a>

此 API 用于提取 AWS Glue 连接（对于源）或 AWS Glue 数据库 ARN（对于目标）的 `ResourceProperty`

**请求**
+ `ResourceArn`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  源的连接 ARN 或目标的数据库 ARN。

**响应**
+ `ResourceArn` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  源的连接 ARN 或目标的数据库 ARN。
+ `SourceProcessingProperties` – 一个 [SourceProcessingProperties](#aws-glue-api-integrations-SourceProcessingProperties) 对象。

  与集成源关联的资源属性。
+ `TargetProcessingProperties` – 一个 [TargetProcessingProperties](#aws-glue-api-integrations-TargetProcessingProperties) 对象。

  与集成目标关联的资源属性。

**错误**
+ `ValidationException`
+ `AccessDeniedException`
+ `InternalServerException`
+ `ResourceNotFoundException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `InvalidInputException`

## UntagResource 操作（Python：untag\$1resource）
<a name="aws-glue-api-integrations-UntagResource"></a>

从集成资源中删除指定的标签。

**请求**
+ `ResourceArn` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  集成资源的 Amazon 资源名称 (ARN)。
+ `TagsToRemove` – *必填*：UTF-8 字符串数组，不超过 50 个字符串。

  要从资源中删除的元数据标签列表。

**响应**
+ *无响应参数。*

**错误**
+ `ResourceNotFoundException`

## ListTagsForResource 操作（Python：list\$1tags\$1for\$1resource）
<a name="aws-glue-api-integrations-ListTagsForResource"></a>

列出分配给指定资源的元数据标签。

**请求**
+ `ResourceARN` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  资源的资源 ARN。

**响应**
+ `Tags` – [Tag](aws-glue-api-common.md#aws-glue-api-common-Tag) 对象的数组，不超过 10 个结构。

  标签列表。

**错误**
+ `ResourceNotFoundException`

## 异常
<a name="aws-glue-api-integrations-exceptions"></a>
+ [ResourceNotFoundException 结构](#aws-glue-api-integrations-ResourceNotFoundException)
+ [InternalServerException 结构](#aws-glue-api-integrations-InternalServerException)
+ [IntegrationAlreadyExistsFault 结构](#aws-glue-api-integrations-IntegrationAlreadyExistsFault)
+ [IntegrationConflictOperationFault 结构](#aws-glue-api-integrations-IntegrationConflictOperationFault)
+ [IntegrationQuotaExceededFault 结构](#aws-glue-api-integrations-IntegrationQuotaExceededFault)
+ [KMSKeyNotAccessibleFault 结构](#aws-glue-api-integrations-KMSKeyNotAccessibleFault)
+ [IntegrationNotFoundFault 结构](#aws-glue-api-integrations-IntegrationNotFoundFault)
+ [TargetResourceNotFound 结构](#aws-glue-api-integrations-TargetResourceNotFound)
+ [InvalidIntegrationStateFault 结构](#aws-glue-api-integrations-InvalidIntegrationStateFault)

## ResourceNotFoundException 结构
<a name="aws-glue-api-integrations-ResourceNotFoundException"></a>

找不到资源。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## InternalServerException 结构
<a name="aws-glue-api-integrations-InternalServerException"></a>

发生内部服务器错误。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## IntegrationAlreadyExistsFault 结构
<a name="aws-glue-api-integrations-IntegrationAlreadyExistsFault"></a>

指定的集成已存在。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## IntegrationConflictOperationFault 结构
<a name="aws-glue-api-integrations-IntegrationConflictOperationFault"></a>

请求的操作与其他操作冲突。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## IntegrationQuotaExceededFault 结构
<a name="aws-glue-api-integrations-IntegrationQuotaExceededFault"></a>

通过您的集成处理的数据超过了您的配额。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## KMSKeyNotAccessibleFault 结构
<a name="aws-glue-api-integrations-KMSKeyNotAccessibleFault"></a>

指定的 KMS 密钥不可访问。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## IntegrationNotFoundFault 结构
<a name="aws-glue-api-integrations-IntegrationNotFoundFault"></a>

找不到指定的集成。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## TargetResourceNotFound 结构
<a name="aws-glue-api-integrations-TargetResourceNotFound"></a>

找不到目标资源。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## InvalidIntegrationStateFault 结构
<a name="aws-glue-api-integrations-InvalidIntegrationStateFault"></a>

集成处于无效状态。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

# 交互式会话 API
<a name="aws-glue-api-interactive-sessions"></a>

交互式会话 API 描述与使用 AWS Glue 交互式会话构建和测试数据集成的提取、转换和加载 (ETL) 脚本相关的 AWS Glue API。

## 数据类型
<a name="aws-glue-api-interactive-sessions-objects"></a>
+ [Session 结构](#aws-glue-api-interactive-sessions-Session)
+ [SessionCommand 结构](#aws-glue-api-interactive-sessions-SessionCommand)
+ [Statement 结构](#aws-glue-api-interactive-sessions-Statement)
+ [StatementOutput 结构](#aws-glue-api-interactive-sessions-StatementOutput)
+ [StatementOutputData 结构](#aws-glue-api-interactive-sessions-StatementOutputData)
+ [ConnectionsList 结构](#aws-glue-api-interactive-sessions-ConnectionsList)

## Session 结构
<a name="aws-glue-api-interactive-sessions-Session"></a>

远程 Spark 运行时环境的运行时段。

**Fields**
+ `Id` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  会话 ID。
+ `CreatedOn` – 时间戳。

  创建会话的日期和时间。
+ `Status` – UTF-8 字符串（有效值：`PROVISIONING` \$1`READY` \$1`FAILED` \$1`TIMEOUT` \$1`STOPPING` \$1`STOPPED` ）。

  会话状态。
+ `ErrorMessage` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  会话期间显示的错误消息。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  会话描述。
+ `Role` – UTF-8 字符串，不少于 20 个字节，不超过 2048 个字节，与 [Custom string pattern #30](aws-glue-api-common.md#regex_30) 匹配。

  与此会话关联的 IAM 角色的名称或 Amazon Resource Name (ARN)。
+ `Command` – 一个 [SessionCommand](#aws-glue-api-interactive-sessions-SessionCommand) 对象。

  命令对象。请参阅 SessionCommand。
+ `DefaultArguments` – 键值对的映射数组，不超过 75 对。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。

  每个值都是一个 UTF-8 字符串，长度不超过 4096 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  键值对的映射数组。最多 75 对。
+ `Connections` – 一个 [ConnectionsList](#aws-glue-api-interactive-sessions-ConnectionsList) 对象。

  用于会话的连接数。
+ `Progress` – 数字（double）。

  会话的代码执行进度。
+ `MaxCapacity` – 数字（double）。

  任务运行时可分配的 AWS Glue 数据处理单元 (DPU) 的数量。DPU 是对处理能力的相对度量，它由 4 个 vCPU 的计算容量和 16GB 内存组成。
+ `SecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  会话要使用的 SecurityConfiguration 结构的名称。
+ `GlueVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #48](aws-glue-api-common.md#regex_48) 匹配。

  AWS Glue 版本决定了 AWS Glue 支持的 Apache Spark 和 Python 版本。GlueVersion 必须大于 2.0。
+ `DataAccessId` – UTF-8 字符串，长度不少于 1 个字节，不超过 36 个字节。

  会话的数据访问 ID。
+ `PartitionId` – UTF-8 字符串，长度不少于 1 个字节，不超过 36 个字节。

  会话的分区 ID。
+ `NumberOfWorkers` – 数字（整数）。

  用于会话的已定义 `WorkerType` 的工件数量。
+ `WorkerType` – UTF-8 字符串（有效值：`Standard=""` \$1`G.1X=""` \$1`G.2X=""` \$1`G.025X=""` \$1`G.4X=""` \$1`G.8X=""` \$1`Z.2X=""` ）。

  会话运行时分配的预定义工作线程的类型。接受 `G.1X`、`G.2X`、`G.4X`、`G.8X` for Spark 会话的值。接受 `Z.2X` for Ray 的值。
+ `CompletedOn` – 时间戳。

  此会话的完成日期和时间。
+ `ExecutionTime` – 数字（double）。

  会话运行的总时间。
+ `DPUSeconds` – 数字（double）。

  会话消耗的 DPU（公式：执行时间 \$1 最大容量）。
+ `IdleTimeout` – 数字（整数）。

  会话超时前的空闲分钟数。
+ `ProfileName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与会话关联的 AWS Glue 使用情况配置文件名称。

## SessionCommand 结构
<a name="aws-glue-api-interactive-sessions-SessionCommand"></a>

运行任务的 `SessionCommand`。

**Fields**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  指定 SessionCommand 的名称。可以是“gluetel”或“gluestreaming”。
+ `PythonVersion` – UTF-8 字符串，与 [Custom string pattern #49](aws-glue-api-common.md#regex_49) 匹配。

  指定 Python 版本。Python 版本指示了 Spark 类型的任务支持的版本。

## Statement 结构
<a name="aws-glue-api-interactive-sessions-Statement"></a>

在会话中实现特定操作的语句或请求。

**Fields**
+ `Id` – 数字（整数）。

  语句的 ID。
+ `Code` – UTF-8 字符串。

  语句的执行代码。
+ `State` – UTF-8 字符串（有效值：`WAITING` \$1`RUNNING` \$1`AVAILABLE` \$1`CANCELLING` \$1`CANCELLED` \$1`ERROR` ）。

  执行请求时的状态。
+ `Output` – 一个 [StatementOutput](#aws-glue-api-interactive-sessions-StatementOutput) 对象。

  JSON 中的输出。
+ `Progress` – 数字（double）。

  代码执行进度。
+ `StartedOn` – 数字（长型）。

  任务定义开始的 Unix 时间和日期。
+ `CompletedOn` – 数字（长型）。

  任务定义完成的 Unix 时间和日期。

## StatementOutput 结构
<a name="aws-glue-api-interactive-sessions-StatementOutput"></a>

JSON 格式的代码执行输出。

**Fields**
+ `Data` – 一个 [StatementOutputData](#aws-glue-api-interactive-sessions-StatementOutputData) 对象。

  代码执行输出。
+ `ExecutionCount` – 数字（整数）。

  输出的执行计数。
+ `Status` – UTF-8 字符串（有效值：`WAITING` \$1`RUNNING` \$1`AVAILABLE` \$1`CANCELLING` \$1`CANCELLED` \$1`ERROR` ）。

  代码执行输出的状态。
+ `ErrorName` – UTF-8 字符串。

  输出中的错误名称。
+ `ErrorValue` – UTF-8 字符串。

  输出的错误值。
+ `Traceback` – UTF-8 字符串数组。

  输出的回溯。

## StatementOutputData 结构
<a name="aws-glue-api-interactive-sessions-StatementOutputData"></a>

JSON 格式的代码执行输出。

**Fields**
+ `TextPlain` – UTF-8 字符串。

  文本格式的代码执行输出。

## ConnectionsList 结构
<a name="aws-glue-api-interactive-sessions-ConnectionsList"></a>

指定作业所使用的连接。

**Fields**
+ `Connections` – UTF-8 字符串数组，不超过 1000 个字符串。

  作业所使用的连接的列表。

## 操作
<a name="aws-glue-api-interactive-sessions-actions"></a>
+ [CreateSession 操作（Python：create\$1session）](#aws-glue-api-interactive-sessions-CreateSession)
+ [StopSession 操作（Python：stop\$1session）](#aws-glue-api-interactive-sessions-StopSession)
+ [DeleteSession 操作（Python：delete\$1session）](#aws-glue-api-interactive-sessions-DeleteSession)
+ [GetSession 操作（Python：get\$1session）](#aws-glue-api-interactive-sessions-GetSession)
+ [ListSession 操作（Python：list\$1ession）](#aws-glue-api-interactive-sessions-ListSessions)
+ [RunStatement 操作（Python：run\$1statement）](#aws-glue-api-interactive-sessions-RunStatement)
+ [CancelStatement 操作（Python：cancel\$1statement）](#aws-glue-api-interactive-sessions-CancelStatement)
+ [GetStatement 操作（Python：get\$1statement）](#aws-glue-api-interactive-sessions-GetStatement)
+ [ListStatements 操作（Python：list\$1statements）](#aws-glue-api-interactive-sessions-ListStatements)
+ [GetGlueIdentityCenterConfiguration 操作（Python：get\$1glue\$1identity\$1center\$1configuration）](#aws-glue-api-interactive-sessions-GetGlueIdentityCenterConfiguration)
+ [UpdateGlueIdentityCenterConfiguration 操作（Python：update\$1glue\$1identity\$1center\$1configuration）](#aws-glue-api-interactive-sessions-UpdateGlueIdentityCenterConfiguration)
+ [CreateGlueIdentityCenterConfiguration 操作（Python：create\$1glue\$1identity\$1center\$1configuration）](#aws-glue-api-interactive-sessions-CreateGlueIdentityCenterConfiguration)
+ [DeleteGlueIdentityCenterConfiguration 操作（Python：delete\$1glue\$1identity\$1center\$1configuration）](#aws-glue-api-interactive-sessions-DeleteGlueIdentityCenterConfiguration)

## CreateSession 操作（Python：create\$1session）
<a name="aws-glue-api-interactive-sessions-CreateSession"></a>

创建新的会话。

**请求**

请求创建新的会话。
+ `Id` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  会话请求 ID。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  会话描述。
+ `Role` – *必需：*UTF-8 字符串，长度不少于 20 个字节，不超过 2048 个字节，与 [Custom string pattern #30](aws-glue-api-common.md#regex_30) 匹配。

  IAM 角色 ARN 
+ `Command` – *必填：*一个 [SessionCommand](#aws-glue-api-interactive-sessions-SessionCommand) 对象。

  运行任务的 `SessionCommand`。
+ `Timeout` - 数字（整数），至少为 1。

   会话超时前的分钟数。Spark ETL 作业的默认值为 48 小时（2880 分钟）。有关其他作业类型，请查阅文档。
+ `IdleTimeout` - 数字（整数），至少为 1。

   会话超时前的空闲分钟数。Spark ETL 作业的默认值为“超时”。有关其他作业类型，请查阅文档。
+ `DefaultArguments` – 键值对的映射数组，不超过 75 对。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。

  每个值都是一个 UTF-8 字符串，长度不超过 4096 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  键值对的映射数组。最多 75 对。
+ `Connections` – 一个 [ConnectionsList](#aws-glue-api-interactive-sessions-ConnectionsList) 对象。

  用于会话的连接数。
+ `MaxCapacity` – 数字（double）。

  任务运行时可分配的 AWS Glue 数据处理单元 (DPU) 的数量。DPU 是对处理能力的相对度量，它由 4 个 vCPU 的计算容量和 16GB 内存组成。
+ `NumberOfWorkers` – 数字（整数）。

  用于会话的已定义 `WorkerType` 的工件数量。
+ `WorkerType` – UTF-8 字符串（有效值：`Standard=""` \$1`G.1X=""` \$1`G.2X=""` \$1`G.025X=""` \$1`G.4X=""` \$1`G.8X=""` \$1`Z.2X=""` ）。

  任务运行时分配的预定义工作线程的类型。接受 G.1X、G.2X、G.4X 或 G.8X for Spark 作业的值。接受 Ray 笔记本的值 Z.2X。
  + 对于 `G.1X` 工作线程类型，每个工作线程映射到 1 个 DPU（4 个 vCPU，16GB 内存），94GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将这种工作线程类型用于数据转换、联接和查询等工作负载，以提供一种可扩展且经济实惠的方式来运行大多数作业。
  + 对于 `G.2X` 工作线程类型，每个工作线程映射到 2 个 DPU（8 个 vCPU，32GB 内存），138GB 磁盘，并且每个工作线程提供 1 个执行程序。我们建议将这种工作线程类型用于数据转换、联接和查询等工作负载，以提供一种可扩展且经济实惠的方式来运行大多数作业。
  + 对于 `G.4X` 工作线程类型，每个工作线程映射到 4 个 DPU（16 个 vCPU，64GB 内存），256GB 磁盘，并且每个工作线程提供 1 个执行程序。对于工作负载包含要求最高的转换、聚合、联接和查询的作业，我们建议使用这种工作线程类型。此工作线程类型仅适用于以下 AWS 区域的 AWS Glue 3.0 版或更高版本的 Spark ETL 作业：美国东部（俄亥俄州）、美国东部（弗吉尼亚州北部）、美国西部（俄勒冈州）、亚太地区（新加坡）、亚太地区（悉尼）、亚太地区（东京）、加拿大（中部）、欧洲地区（法兰克福）、欧洲地区（爱尔兰）和欧洲地区（斯德哥尔摩）。
  + 对于 `G.8X` 工作线程类型，每个工作线程映射到 8 个 DPU（32 个 vCPU，128GB 内存），512GB 磁盘，并且每个工作线程提供 1 个执行程序。对于工作负载包含要求最高的转换、聚合、联接和查询的作业，我们建议使用这种工作线程类型。此工作线程类型仅适用于 AWS Glue 3.0 版或更高版本的 Spark ETL 作业，其区域与 `G.4X` 工作线程类型支持的 AWS 区域相同。
  + 对于 `Z.2X` 工作线程类型，每个工作线程映射到 2 个 M-DPU（8 个 vCPU，64GB 内存），128GB 磁盘，基于自动缩放器最多提供 8 个 Ray 工作线程。
+ `SecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  会话要使用的 SecurityConfiguration 结构的名称。
+ `GlueVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #48](aws-glue-api-common.md#regex_48) 匹配。

  AWS Glue 版本决定了 AWS Glue 支持的 Apache Spark 和 Python 版本。GlueVersion 必须大于 2.0。
+ `DataAccessId` – UTF-8 字符串，长度不少于 1 个字节，不超过 36 个字节。

  会话的数据访问 ID。
+ `PartitionId` – UTF-8 字符串，长度不少于 1 个字节，不超过 36 个字节。

  会话的分区 ID。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  属于会话的键值对（标签）的映射。
+ `RequestOrigin` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。

  请求的源。
+ `ProfileName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与会话关联的 AWS Glue 使用情况配置文件名称。

**响应**
+ `Session` – 一个 [Session](#aws-glue-api-interactive-sessions-Session) 对象。

  返回响应中的会话对象。

**错误**
+ `AccessDeniedException`
+ `IdempotentParameterMismatchException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `ValidationException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`

## StopSession 操作（Python：stop\$1session）
<a name="aws-glue-api-interactive-sessions-StopSession"></a>

停止会话。

**请求**
+ `Id` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要停止的会话 ID。
+ `RequestOrigin` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。

  请求的源。

**响应**
+ `Id` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  返回已停止会话的 ID。

**错误**
+ `AccessDeniedException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `IllegalSessionStateException`
+ `ConcurrentModificationException`

## DeleteSession 操作（Python：delete\$1session）
<a name="aws-glue-api-interactive-sessions-DeleteSession"></a>

删除会话。

**请求**
+ `Id` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的会话 ID。
+ `RequestOrigin` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。

  删除会话请求的源名称。

**响应**
+ `Id` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  返回要删除会话 ID。

**错误**
+ `AccessDeniedException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `IllegalSessionStateException`
+ `ConcurrentModificationException`

## GetSession 操作（Python：get\$1session）
<a name="aws-glue-api-interactive-sessions-GetSession"></a>

检索会话。

**请求**
+ `Id` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  会话 ID。
+ `RequestOrigin` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。

  请求的源。

**响应**
+ `Session` – 一个 [Session](#aws-glue-api-interactive-sessions-Session) 对象。

  响应中会返回会话对象。

**错误**
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## ListSession 操作（Python：list\$1ession）
<a name="aws-glue-api-interactive-sessions-ListSessions"></a>

检索会话列表。

**请求**
+ `NextToken` – UTF-8 字符串，长度不超过 400000 个字节。

  下一组结果的令牌，没有更多结果时为 null。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  最大结果数量。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  属于会话的标签。
+ `RequestOrigin` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。

  请求的源。

**响应**
+ `Ids` – UTF-8 字符串数组。

  返回会话 ID。
+ `Sessions` – [Session](#aws-glue-api-interactive-sessions-Session) 对象的数组。

  返回会话对象。
+ `NextToken` – UTF-8 字符串，长度不超过 400000 个字节。

  下一组结果的令牌，没有更多结果时为 null。

**错误**
+ `AccessDeniedException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## RunStatement 操作（Python：run\$1statement）
<a name="aws-glue-api-interactive-sessions-RunStatement"></a>

执行语句。

**请求**
+ `SessionId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要运行的语句的会话 ID。
+ `Code` – *必需：* UTF-8 字符串，长度不超过 68000 个字节。

  要运行的语句代码。
+ `RequestOrigin` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。

  请求的源。

**响应**
+ `Id` – 数字（整数）。

  返回所运行的语句的 ID。

**错误**
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `ValidationException`
+ `ResourceNumberLimitExceededException`
+ `IllegalSessionStateException`

## CancelStatement 操作（Python：cancel\$1statement）
<a name="aws-glue-api-interactive-sessions-CancelStatement"></a>

取消语句。

**请求**
+ `SessionId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要取消的语句的会话 ID。
+ `Id` – *必填*：数字（整数）。

  要取消的语句的 ID。
+ `RequestOrigin` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。

  用于取消语句的请求的源。

**响应**
+ *无响应参数。*

**错误**
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `IllegalSessionStateException`

## GetStatement 操作（Python：get\$1statement）
<a name="aws-glue-api-interactive-sessions-GetStatement"></a>

检索语句。

**请求**
+ `SessionId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  语句的会话 ID。
+ `Id` – *必填*：数字（整数）。

  语句的 ID。
+ `RequestOrigin` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。

  请求的源。

**响应**
+ `Statement` – 一个 [语句](#aws-glue-api-interactive-sessions-Statement) 对象。

  返回语句。

**错误**
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `IllegalSessionStateException`

## ListStatements 操作（Python：list\$1statements）
<a name="aws-glue-api-interactive-sessions-ListStatements"></a>

列出会话的语句。

**请求**
+ `SessionId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  语句的会话 ID。
+ `RequestOrigin` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。

  用于列出语句的请求的源。
+ `NextToken` – UTF-8 字符串，长度不超过 400000 个字节。

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

**响应**
+ `Statements` – [语句](#aws-glue-api-interactive-sessions-Statement) 对象的数组。

  返回语句列表。
+ `NextToken` – UTF-8 字符串，长度不超过 400000 个字节。

  延续令牌（如果尚未返回所有语句）。

**错误**
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `IllegalSessionStateException`

## GetGlueIdentityCenterConfiguration 操作（Python：get\$1glue\$1identity\$1center\$1configuration）
<a name="aws-glue-api-interactive-sessions-GetGlueIdentityCenterConfiguration"></a>

检索当前 AWS Glue Identity Center 配置详细信息，包括关联的 Identity Center 实例和应用程序信息。

**请求**
+ *无请求参数。*

**响应**

包含 AWS Glue Identity Center 配置详细信息的响应。
+ `ApplicationArn`：UTF-8 字符串，长度不少于 10 个字节，不超过 1224 个字节。

  与 AWS Glue 配置关联的 Identity Center 应用程序的 Amazon 资源名称（ARN）。
+ `InstanceArn`：UTF-8 字符串，长度不少于 10 个字节，不超过 1224 个字节。

  与 AWS Glue 配置关联的 Identity Center 实例的 Amazon 资源名称（ARN）。
+ `Scopes` – UTF-8 字符串数组。

  为 AWS Glue 配置定义权限和访问级别的 Identity Center 作用域列表。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `AccessDeniedException`
+ `ConcurrentModificationException`

## UpdateGlueIdentityCenterConfiguration 操作（Python：update\$1glue\$1identity\$1center\$1configuration）
<a name="aws-glue-api-interactive-sessions-UpdateGlueIdentityCenterConfiguration"></a>

更新现有 AWS Glue Identity Center 配置，从而允许修改集成的作用域和权限。

**请求**

请求更新现有的 AWS Glue Identity Center 配置。
+ `Scopes` – UTF-8 字符串数组，不少于 1 个字符串，不超过 50 个字符串。

  为 AWS Glue 配置定义更新后权限和访问级别的 Identity Center 作用域列表。

**响应**
+ *无响应参数。*

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `AccessDeniedException`
+ `ConcurrentModificationException`

## CreateGlueIdentityCenterConfiguration 操作（Python：create\$1glue\$1identity\$1center\$1configuration）
<a name="aws-glue-api-interactive-sessions-CreateGlueIdentityCenterConfiguration"></a>

创建新的 AWS Glue Identity Center 配置，以在 AWS Glue 与 AWS IAM Identity Center 之间实现集成，从而用于身份验证和授权。

**请求**

请求创建新的 AWS Glue Identity Center 配置。
+ `InstanceArn`：*（必需）*UTF-8 字符串，长度不少于 10 个字节，不超过 1224 个字节。

  将与 AWS Glue 配置关联的 Identity Center 实例的 Amazon 资源名称（ARN）。
+ `Scopes` – UTF-8 字符串数组，不少于 1 个字符串，不超过 50 个字符串。

  为 AWS Glue 配置定义权限和访问级别的 Identity Center 作用域列表。

**响应**

创建新 AWS Glue Identity Center 配置的响应。
+ `ApplicationArn`：UTF-8 字符串，长度不少于 10 个字节，不超过 1224 个字节。

  与 AWS Glue 配置创建的 Identity Center 应用程序的 Amazon 资源名称（ARN）。

**错误**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `AccessDeniedException`
+ `ConcurrentModificationException`

## DeleteGlueIdentityCenterConfiguration 操作（Python：delete\$1glue\$1identity\$1center\$1configuration）
<a name="aws-glue-api-interactive-sessions-DeleteGlueIdentityCenterConfiguration"></a>

删除现有的 AWS Glue Identity Center 配置，并移除 AWS Glue 与 AWS IAM Identity Center 之间的集成。

**请求**
+ *无请求参数。*

**响应**
+ *无响应参数。*

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `AccessDeniedException`
+ `ConcurrentModificationException`

# 开发终端节点 API
<a name="aws-glue-api-dev-endpoint"></a>

开发端点 API 介绍与使用自定义 DevEndpoint 进行测试相关的 AWS Glue API。

## 数据类型
<a name="aws-glue-api-dev-endpoint-objects"></a>
+ [DevEndpoint 结构](#aws-glue-api-dev-endpoint-DevEndpoint)
+ [DevEndpointCustomLibraries 结构](#aws-glue-api-dev-endpoint-DevEndpointCustomLibraries)

## DevEndpoint 结构
<a name="aws-glue-api-dev-endpoint-DevEndpoint"></a>

开发人员可以远程调试提取、转换和加载 (ETL) 脚本的开发终端节点。

**Fields**
+ `EndpointName` – UTF-8 字符串。

  `DevEndpoint` 的名称。
+ `RoleArn` – UTF-8 字符串，与 [AWS IAM ARN string pattern](aws-glue-api-common.md#aws-glue-api-regex-aws-iam-arn-id) 匹配。

  该 `DevEndpoint` 中使用的 IAM 角色的 Amazon 资源名称（ARN）。
+ `SecurityGroupIds` – UTF-8 字符串数组。

  此 `DevEndpoint` 中使用的安全组标识符的列表。
+ `SubnetId` – UTF-8 字符串。

  此 `DevEndpoint` 的子网 ID。
+ `YarnEndpointAddress` – UTF-8 字符串。

  此 `DevEndpoint` 使用的 YARN 终端节点地址。
+ `PrivateAddress` – UTF-8 字符串。

  私有 IP 地址用于访问 VPC 中的 `DevEndpoint`（如果在 VPC 中创建了 `DevEndpoint`）。只有在 VPC 创建 `PrivateAddress` 时才会显示 `DevEndpoint` 字段。
+ `ZeppelinRemoteSparkInterpreterPort` – 数字（整数）。

  远程 Apache Spark 解释器的 Apache Zeppelin 端口。
+ `PublicAddress` – UTF-8 字符串。

  此 `DevEndpoint` 使用的公有 IP 地址。仅当您创建非 virtual private cloud (VPC) `PublicAddress` 时提供 `DevEndpoint` 字段。
+ `Status` – UTF-8 字符串。

  该 `DevEndpoint` 的当前状态。
+ `WorkerType` – UTF-8 字符串（有效值：`Standard=""` \$1`G.1X=""` \$1`G.2X=""` \$1`G.025X=""` \$1`G.4X=""` \$1`G.8X=""` \$1`Z.2X=""` ）。

  分配给开发端点的预定义工作线程的类型。接受的值为 Standard、G.1X 或 G.2X。
  + 对于 `Standard` 工作线程类型，每个工作线程提供 4 个 vCPU、16 GB 内存和 50GB 磁盘，并且每个工作线程提供 2 个执行器。
  + 对于 `G.1X` 工作线程类型，每个工作线程映射到 1 个 DPU（4 个 vCPU，16 GB 内存，64 GB 磁盘），并且每个工作线程提供 1 个执行器。我们建议内存密集型作业使用该工作线程类型。
  + 对于 `G.2X` 工作线程类型，每个工作线程映射到 2 个 DPU（8 个 vCPU，32 GB 内存，128 GB 磁盘），并且每个工作线程提供 1 个执行器。我们建议内存密集型作业使用该工作线程类型。

  已知问题：当使用 `G.2X` `WorkerType` 配置创建开发端点时，开发端点的 Spark 驱动程序将在 4 个 vCPU、16 GB 内存和 64 GB 磁盘上运行。
+ `GlueVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #48](aws-glue-api-common.md#regex_48) 匹配。

  Glue 版本决定了 AWS Glue 支持的 Apache Spark 和 Python 版本。Python 版本表示支持在开发端点上运行 ETL 脚本的版本。

  有关可用的 AWS Glue 版本以及相应的 Spark 和 Python 版本的更多信息，请参阅开发人员指南中的 [Glue 版本](https://docs.aws.amazon.com/glue/latest/dg/add-job.html)。

  在未指定 Glue 版本的情况下创建的开发端点默认为 Glue 0.9。

  可以使用 `CreateDevEndpoint` 或 `UpdateDevEndpoint` API 中的 `Arguments` 参数指定支持开发端点的 Python 版本。如果未提供参数，则版本默认为 Python 2。
+ `NumberOfWorkers` – 数字（整数）。

  分配给开发端点的已定义 `workerType` 的工作线程数。

  您可以定义的最大工作线程数是 299 (`G.1X`)，以及 149 (`G.2X`)。
+ `NumberOfNodes` – 数字（整数）。

  分配给此 `DevEndpoint` 的 AWS Glue 数据处理单元（DPU）的数量。
+ `AvailabilityZone` – UTF-8 字符串。

  此 `DevEndpoint` 所在的 AWS 可用区。
+ `VpcId` – UTF-8 字符串。

  此 `DevEndpoint` 使用的 Virtual Private Cloud (VPC) 的 ID。
+ `ExtraPythonLibsS3Path` – UTF-8 字符串。

  Amazon S3 存储桶中应加载到您的 `DevEndpoint` 中的一个或多个 Python 库的路径。多个值必须是以逗号分隔的完整路径。
**注意**  
您只能与 `DevEndpoint` 一同使用纯 Python 库。目前不支持依赖于 C 扩展的库，如 [pandas](http://pandas.pydata.org/) Python 数据分析库。
+ `ExtraJarsS3Path` – UTF-8 字符串。

  S3 存储桶中应加载到您的 `.jar` 中的一个或多个 Java `DevEndpoint` 文件的路径。
**注意**  
您只能与 `DevEndpoint` 一同使用纯 Java/Scala 库。
+ `FailureReason` – UTF-8 字符串。

  此 `DevEndpoint` 中的当前失败的原因。
+ `LastUpdateStatus` – UTF-8 字符串。

  上次更新的状态。
+ `CreatedTimestamp` – 时间戳。

  创建此 DevEndpoint 的时间点。
+ `LastModifiedTimestamp` – 时间戳。

  上次修改此 `DevEndpoint` 的时间点。
+ `PublicKey` – UTF-8 字符串。

  此 `DevEndpoint` 用于身份验证的公有密钥。提供此属性是为了向后兼容，因为要使用的推荐属性是公有密钥。
+ `PublicKeys` – UTF-8 字符串数组，不超过 5 个字符串。

  `DevEndpoints` 用于身份验证的公有密钥列表。优先于单个公有密钥使用此属性，因为公有密钥允许您为每个客户端使用不同的私有密钥。
**注意**  
如果以前使用公有密钥创建了端点，则必须删除该密钥才能设置公有密钥列表。使用 `UpdateDevEndpoint` 属性中的公有密钥内容和 `deletePublicKeys` 属性中的新密钥列表调用 `addPublicKeys` API 操作。
+ `SecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  该 `SecurityConfiguration` 将使用的 `DevEndpoint` 结构的名称。
+ `Arguments` – 键值对的映射数组，不超过 100 对。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  用于配置 `DevEndpoint` 的参数的映射。

  有效参数为：
  + `"--enable-glue-datacatalog": ""`

  可以使用 `CreateDevEndpoint` 或 `UpdateDevEndpoint` API 中的 `Arguments` 参数指定支持开发端点的 Python 版本。如果未提供参数，则版本默认为 Python 2。

## DevEndpointCustomLibraries 结构
<a name="aws-glue-api-dev-endpoint-DevEndpointCustomLibraries"></a>

要加载到开发终端节点中的自定义库。

**Fields**
+ `ExtraPythonLibsS3Path` – UTF-8 字符串。

  Amazon Simple Storage Service (Amazon S3) 存储桶中应加载到您的 `DevEndpoint` 中的一个或多个 Python 库的路径。多个值必须是以逗号分隔的完整路径。
**注意**  
您只能与 `DevEndpoint` 一同使用纯 Python 库。目前不支持依赖于 C 扩展的库，如 [pandas](http://pandas.pydata.org/) Python 数据分析库。
+ `ExtraJarsS3Path` – UTF-8 字符串。

  S3 存储桶中应加载到您的 `.jar` 中的一个或多个 Java `DevEndpoint` 文件的路径。
**注意**  
您只能与 `DevEndpoint` 一同使用纯 Java/Scala 库。

## 操作
<a name="aws-glue-api-dev-endpoint-actions"></a>
+ [CreateDevEndpoint 操作（Python：create\$1dev\$1endpoint）](#aws-glue-api-dev-endpoint-CreateDevEndpoint)
+ [UpdateDevEndpoint 操作（Python：update\$1dev\$1endpoint）](#aws-glue-api-dev-endpoint-UpdateDevEndpoint)
+ [DeleteDevEndpoint 操作（Python：delete\$1dev\$1endpoint）](#aws-glue-api-dev-endpoint-DeleteDevEndpoint)
+ [GetDevEndpoint 操作（Python：get\$1dev\$1endpoint）](#aws-glue-api-dev-endpoint-GetDevEndpoint)
+ [GetDevEndpoints 操作（Python：get\$1dev\$1endpoints）](#aws-glue-api-dev-endpoint-GetDevEndpoints)
+ [BatchGetDevEndpoints 操作（Python：batch\$1get\$1dev\$1endpoints）](#aws-glue-api-dev-endpoint-BatchGetDevEndpoints)
+ [ListDevEndpoints 操作（Python：list\$1dev\$1endpoints）](#aws-glue-api-dev-endpoint-ListDevEndpoints)

## CreateDevEndpoint 操作（Python：create\$1dev\$1endpoint）
<a name="aws-glue-api-dev-endpoint-CreateDevEndpoint"></a>

创建新的开发终端节点。

**请求**
+ `EndpointName` – *必填：*UTF-8 字符串。

  要为新 `DevEndpoint` 分配的名称。
+ `RoleArn` – *必填：* UTF-8 字符串，与 [AWS IAM ARN string pattern](aws-glue-api-common.md#aws-glue-api-regex-aws-iam-arn-id) 匹配。

  `DevEndpoint` 的 IAM 角色。
+ `SecurityGroupIds` – UTF-8 字符串数组。

  新的 `DevEndpoint` 将使用的安全组的安全组 ID。
+ `SubnetId` – UTF-8 字符串。

  新的 `DevEndpoint` 将使用的子网 ID。
+ `PublicKey` – UTF-8 字符串。

  此 `DevEndpoint` 用于身份验证的公有密钥。提供此属性是为了向后兼容，因为要使用的推荐属性是公有密钥。
+ `PublicKeys` – UTF-8 字符串数组，不超过 5 个字符串。

  开发终端节点用于身份验证的公有密钥列表。优先于单个公有密钥使用此属性，因为公有密钥允许您为每个客户端使用不同的私有密钥。
**注意**  
如果以前使用公有密钥创建了端点，则必须删除该密钥才能设置公有密钥列表。使用 `UpdateDevEndpoint` 属性中的公有密钥内容和 `deletePublicKeys` 属性中的新密钥列表调用 `addPublicKeys` API。
+ `NumberOfNodes` – 数字（整数）。

  要分配给该 `DevEndpoint` 的 AWS Glue 数据处理单元（DPU）的数量。
+ `WorkerType` – UTF-8 字符串（有效值：`Standard=""` \$1`G.1X=""` \$1`G.2X=""` \$1`G.025X=""` \$1`G.4X=""` \$1`G.8X=""` \$1`Z.2X=""` ）。

  分配给开发端点的预定义工作线程的类型。接受的值为 Standard、G.1X 或 G.2X。
  + 对于 `Standard` 工作线程类型，每个工作线程提供 4 个 vCPU、16 GB 内存和 50GB 磁盘，并且每个工作线程提供 2 个执行器。
  + 对于 `G.1X` 工作线程类型，每个工作线程映射到 1 个 DPU（4 个 vCPU，16 GB 内存，64 GB 磁盘），并且每个工作线程提供 1 个执行器。我们建议内存密集型作业使用该工作线程类型。
  + 对于 `G.2X` 工作线程类型，每个工作线程映射到 2 个 DPU（8 个 vCPU，32 GB 内存，128 GB 磁盘），并且每个工作线程提供 1 个执行器。我们建议内存密集型作业使用该工作线程类型。

  已知问题：当使用 `G.2X` `WorkerType` 配置创建开发端点时，开发端点的 Spark 驱动程序将在 4 个 vCPU、16 GB 内存和 64 GB 磁盘上运行。
+ `GlueVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #48](aws-glue-api-common.md#regex_48) 匹配。

  Glue 版本决定了 AWS Glue 支持的 Apache Spark 和 Python 版本。Python 版本表示支持在开发端点上运行 ETL 脚本的版本。

  有关可用的 AWS Glue 版本以及相应的 Spark 和 Python 版本的更多信息，请参阅开发人员指南中的 [Glue 版本](https://docs.aws.amazon.com/glue/latest/dg/add-job.html)。

  在未指定 Glue 版本的情况下创建的开发端点默认为 Glue 0.9。

  可以使用 `CreateDevEndpoint` 或 `UpdateDevEndpoint` API 中的 `Arguments` 参数指定支持开发端点的 Python 版本。如果未提供参数，则版本默认为 Python 2。
+ `NumberOfWorkers` – 数字（整数）。

  分配给开发端点的已定义 `workerType` 的工作线程数。

  您可以定义的最大工作线程数是 299 (`G.1X`)，以及 149 (`G.2X`)。
+ `ExtraPythonLibsS3Path` – UTF-8 字符串。

  Amazon S3 存储桶中应加载到您的 `DevEndpoint` 中的一个或多个 Python 库的路径。多个值必须是以逗号分隔的完整路径。
**注意**  
您只能与 `DevEndpoint` 一同使用纯 Python 库。尚不支持依赖于 C 扩展的库，如 [pandas](http://pandas.pydata.org/) Python 数据分析库。
+ `ExtraJarsS3Path` – UTF-8 字符串。

  S3 存储桶中应加载到您的 `.jar` 中的一个或多个 Java `DevEndpoint` 文件的路径。
+ `SecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  该 `SecurityConfiguration` 将使用的 `DevEndpoint` 结构的名称。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  要用于此 DevEndpoint 的标签。您可以使用标签来限制对 DevEndpoint 的访问。有关 AWS Glue 中的标签的更多信息，请参阅开发人员指南中的 [AWS Glue 中的 AWS 标签](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html)。
+ `Arguments` – 键值对的映射数组，不超过 100 对。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  用于配置 `DevEndpoint` 的参数的映射。

**响应**
+ `EndpointName` – UTF-8 字符串。

  为新的 `DevEndpoint` 指定的名称。
+ `Status` – UTF-8 字符串。

  新的 `DevEndpoint` 的当前状态。
+ `SecurityGroupIds` – UTF-8 字符串数组。

  分配给新 `DevEndpoint` 的安全组。
+ `SubnetId` – UTF-8 字符串。

  分配给新的 `DevEndpoint` 的子网 ID。
+ `RoleArn` – UTF-8 字符串，与 [AWS IAM ARN string pattern](aws-glue-api-common.md#aws-glue-api-regex-aws-iam-arn-id) 匹配。

  分配给新的 `DevEndpoint` 的角色的 Amazon Resource Name（ARN）。
+ `YarnEndpointAddress` – UTF-8 字符串。

  此 `DevEndpoint` 使用的 YARN 终端节点的地址。
+ `ZeppelinRemoteSparkInterpreterPort` – 数字（整数）。

  远程 Apache Spark 解释器的 Apache Zeppelin 端口。
+ `NumberOfNodes` – 数字（整数）。

  分配给此 DevEndpoint 的 AWS Glue 数据处理单元（DPU）的数量。
+ `WorkerType` – UTF-8 字符串（有效值：`Standard=""` \$1`G.1X=""` \$1`G.2X=""` \$1`G.025X=""` \$1`G.4X=""` \$1`G.8X=""` \$1`Z.2X=""` ）。

  分配给开发端点的预定义工作线程的类型。可能的值为 Standard、G.1X 或 G.2X。
+ `GlueVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #48](aws-glue-api-common.md#regex_48) 匹配。

  Glue 版本决定了 AWS Glue 支持的 Apache Spark 和 Python 版本。Python 版本表示支持在开发端点上运行 ETL 脚本的版本。

  有关可用的 AWS Glue 版本以及相应的 Spark 和 Python 版本的更多信息，请参阅开发人员指南中的 [Glue 版本](https://docs.aws.amazon.com/glue/latest/dg/add-job.html)。
+ `NumberOfWorkers` – 数字（整数）。

  分配给开发端点的已定义 `workerType` 的工作线程数。
+ `AvailabilityZone` – UTF-8 字符串。

  此 `DevEndpoint` 所在的 AWS 可用区。
+ `VpcId` – UTF-8 字符串。

  此 `DevEndpoint` 使用的 Virtual Private Cloud (VPC) 的 ID。
+ `ExtraPythonLibsS3Path` – UTF-8 字符串。

  S3 存储桶中将加载到您的 `DevEndpoint` 中的一个或多个 Python 库的路径。
+ `ExtraJarsS3Path` – UTF-8 字符串。

  S3 存储桶中应加载到您的 `.jar` 中的一个或多个 Java `DevEndpoint` 文件的路径。
+ `FailureReason` – UTF-8 字符串。

  此 `DevEndpoint` 中的当前失败的原因。
+ `SecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  该 `SecurityConfiguration` 使用的 `DevEndpoint` 结构的名称。
+ `CreatedTimestamp` – 时间戳。

  创建此 `DevEndpoint` 的时间点。
+ `Arguments` – 键值对的映射数组，不超过 100 对。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  用于配置该 `DevEndpoint` 的参数的映射。

  有效参数为：
  + `"--enable-glue-datacatalog": ""`

  可以使用 `CreateDevEndpoint` 或 `UpdateDevEndpoint` API 中的 `Arguments` 参数指定支持开发端点的 Python 版本。如果未提供参数，则版本默认为 Python 2。

**错误**
+ `AccessDeniedException`
+ `AlreadyExistsException`
+ `IdempotentParameterMismatchException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `ValidationException`
+ `ResourceNumberLimitExceededException`

## UpdateDevEndpoint 操作（Python：update\$1dev\$1endpoint）
<a name="aws-glue-api-dev-endpoint-UpdateDevEndpoint"></a>

更新指定的开发终端节点。

**请求**
+ `EndpointName` – *必填：*UTF-8 字符串。

  要更新的 `DevEndpoint` 名称。
+ `PublicKey` – UTF-8 字符串。

  `DevEndpoint` 要使用的公有密钥。
+ `AddPublicKeys` – UTF-8 字符串数组，不超过 5 个字符串。

  该 `DevEndpoint` 将使用的公有密钥的列表。
+ `DeletePublicKeys` – UTF-8 字符串数组，不超过 5 个字符串。

  要从 `DevEndpoint` 中删除的公有密钥的列表。
+ `CustomLibraries` – 一个 [DevEndpointCustomLibraries](#aws-glue-api-dev-endpoint-DevEndpointCustomLibraries) 对象。

  要加载到 `DevEndpoint` 中的自定义 Python 或 Java 库。
+ `UpdateEtlLibraries` – 布尔值。

  如果需要更新要加载到开发终端节点中的自定义库列表，则为 `True`，否则为 `False`。
+ `DeleteArguments` – UTF-8 字符串数组。

  要从用于配置 `DevEndpoint` 的参数映射中删除的参数键的列表。
+ `AddArguments` – 键值对的映射数组，不超过 100 对。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  用于添加用来配置 `DevEndpoint` 的参数映射的参数的映射。

  有效参数为：
  + `"--enable-glue-datacatalog": ""`

  可以使用 `CreateDevEndpoint` 或 `UpdateDevEndpoint` API 中的 `Arguments` 参数指定支持开发端点的 Python 版本。如果未提供参数，则版本默认为 Python 2。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `ValidationException`

## DeleteDevEndpoint 操作（Python：delete\$1dev\$1endpoint）
<a name="aws-glue-api-dev-endpoint-DeleteDevEndpoint"></a>

删除指定的开发终端节点。

**请求**
+ `EndpointName` – *必填：*UTF-8 字符串。

  `DevEndpoint` 的名称。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## GetDevEndpoint 操作（Python：get\$1dev\$1endpoint）
<a name="aws-glue-api-dev-endpoint-GetDevEndpoint"></a>

检索有关指定开发终端节点的信息。

**注意**  
当您在 Virtual Private Cloud (VPC) 中创建开发终端节点时，AWS Glue 仅返回一个私有 IP 地址，并且不会填充公有 IP 地址字段。在创建非 VPC 开发终端节点时，AWS Glue 仅返回一个公有 IP 地址。

**请求**
+ `EndpointName` – *必填：*UTF-8 字符串。

  要为其检索信息的 `DevEndpoint` 名称。

**响应**
+ `DevEndpoint` – 一个 [DevEndpoint](#aws-glue-api-dev-endpoint-DevEndpoint) 对象。

  `DevEndpoint` 定义。

**错误**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## GetDevEndpoints 操作（Python：get\$1dev\$1endpoints）
<a name="aws-glue-api-dev-endpoint-GetDevEndpoints"></a>

检索此 AWS 账户中的所有开发终端节点。

**注意**  
当您在 Virtual Private Cloud（VPC）中创建开发终端节点时，AWS Glue 仅返回一个私有 IP 地址，并且不会填充公有 IP 地址字段。在创建非 VPC 开发终端节点时，AWS Glue 仅返回一个公有 IP 地址。

**请求**
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的信息的最大大小。
+ `NextToken` – UTF-8 字符串。

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

**响应**
+ `DevEndpoints` – [DevEndpoint](#aws-glue-api-dev-endpoint-DevEndpoint) 对象的数组。

  `DevEndpoint` 定义的列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果尚未返回所有 `DevEndpoint` 定义)。

**错误**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## BatchGetDevEndpoints 操作（Python：batch\$1get\$1dev\$1endpoints）
<a name="aws-glue-api-dev-endpoint-BatchGetDevEndpoints"></a>

返回给定开发终端节点名称列表的资源元数据的列表。调用 `ListDevEndpoints` 操作后，您可以调用此操作来访问您有权访问的数据。此操作支持所有 IAM 权限，包括使用标签的权限条件。

**请求**
+ `customerAccountId` – UTF-8 字符串。

  AWS 账户 ID。
+ `DevEndpointNames` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 25 个字符串。

  `DevEndpoint` 名称列表，这些名称可能是通过 `ListDevEndpoint` 操作返回的名称。

**响应**
+ `DevEndpoints` – [DevEndpoint](#aws-glue-api-dev-endpoint-DevEndpoint) 对象的数组。

  `DevEndpoint` 定义的列表。
+ `DevEndpointsNotFound` – UTF-8 字符串数组，不少于 1 个或不超过 25 个字符串。

  未找到 `DevEndpoints` 列表。

**错误**
+ `AccessDeniedException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## ListDevEndpoints 操作（Python：list\$1dev\$1endpoints）
<a name="aws-glue-api-dev-endpoint-ListDevEndpoints"></a>

检索此 AWS 账户中所有 `DevEndpoint` 资源的名称或带指定标签的资源。此操作可让您查看您账户中可用的资源及其名称。

此操作采用可选的 `Tags` 字段，您可以将其用作响应的筛选器，以便将标记的资源作为一个组进行检索。如果您选择使用标签筛选，则仅检索带标签的资源。

**请求**
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果这是延续请求)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的列表的最大大小。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  指定仅返回这些已标记的资源。

**响应**
+ `DevEndpointNames` – UTF-8 字符串数组。

  账户中所有 `DevEndpoint` 的名称或带指定标签的 `DevEndpoint`。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果返回的列表不包含上一个可用的指标)。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

# 架构注册表
<a name="aws-glue-api-schema-registry-api"></a>

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

## 数据类型
<a name="aws-glue-api-schema-registry-api-objects"></a>
+ [RegistryId 结构](#aws-glue-api-schema-registry-api-RegistryId)
+ [RegistryListItem 结构](#aws-glue-api-schema-registry-api-RegistryListItem)
+ [MetadataInfo 结构](#aws-glue-api-schema-registry-api-MetadataInfo)
+ [OtherMetadataValueListItem 结构](#aws-glue-api-schema-registry-api-OtherMetadataValueListItem)
+ [SchemaListItem 结构](#aws-glue-api-schema-registry-api-SchemaListItem)
+ [SchemaVersionListItem 结构](#aws-glue-api-schema-registry-api-SchemaVersionListItem)
+ [MetadataKeyValuePair 结构](#aws-glue-api-schema-registry-api-MetadataKeyValuePair)
+ [SchemaVersionErrorItem 结构](#aws-glue-api-schema-registry-api-SchemaVersionErrorItem)
+ [ErrorDetails 结构](#aws-glue-api-schema-registry-api-ErrorDetails)
+ [SchemaVersionNumber 结构](#aws-glue-api-schema-registry-api-SchemaVersionNumber)
+ [SchemaId 结构](#aws-glue-api-schema-registry-api-SchemaId)

## RegistryId 结构
<a name="aws-glue-api-schema-registry-api-RegistryId"></a>

包装结构，包含注册表名称和 Amazon Resource Name（ARN）。

**Fields**
+ `RegistryName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  注册表的名称。仅用于查找。必须提供 `RegistryArn` 或 `RegistryName` 中的一个。
+ `RegistryArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  要更新的注册表的 ARN。必须提供 `RegistryArn` 或 `RegistryName` 中的一个。

## RegistryListItem 结构
<a name="aws-glue-api-schema-registry-api-RegistryListItem"></a>

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

**Fields**
+ `RegistryName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  注册表的名称。
+ `RegistryArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  注册表的 Amazon Resource Name（ARN）。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  注册表的描述。
+ `Status` – UTF-8 字符串（有效值：`AVAILABLE` \$1`DELETING` ）。

  注册表的状态。
+ `CreatedTime` – UTF-8 字符串。

  注册表创建的数据。
+ `UpdatedTime` – UTF-8 字符串。

  注册表更新的日期。

## MetadataInfo 结构
<a name="aws-glue-api-schema-registry-api-MetadataInfo"></a>

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

**Fields**
+ `MetadataValue` – UTF-8 字符串，长度不少于 1 个字节或超过 256 个字节，与 [Custom string pattern #14](aws-glue-api-common.md#regex_14) 匹配。

  元数据键的相应值。
+ `CreatedTime` – UTF-8 字符串。

  创建条目的时间。
+ `OtherMetadataValueList` – [OtherMetadataValueListItem](#aws-glue-api-schema-registry-api-OtherMetadataValueListItem) 对象的数组。

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

## OtherMetadataValueListItem 结构
<a name="aws-glue-api-schema-registry-api-OtherMetadataValueListItem"></a>

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

**Fields**
+ `MetadataValue` – UTF-8 字符串，长度不少于 1 个字节或超过 256 个字节，与 [Custom string pattern #14](aws-glue-api-common.md#regex_14) 匹配。

  元数据键的其他元数据的相应值属于同一元数据键。
+ `CreatedTime` – UTF-8 字符串。

  创建条目的时间。

## SchemaListItem 结构
<a name="aws-glue-api-schema-registry-api-SchemaListItem"></a>

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

**Fields**
+ `RegistryName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  架构所在的注册表的名称。
+ `SchemaName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  架构的名称。
+ `SchemaArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  架构的 Amazon Resource Name（ARN）。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  架构描述。
+ `SchemaStatus` – UTF-8 字符串（有效值：`AVAILABLE` \$1`PENDING` \$1`DELETING` ）。

  架构的状态。
+ `CreatedTime` – UTF-8 字符串。

  架构的创建日期和时间。
+ `UpdatedTime` – UTF-8 字符串。

  架构的更新日期和时间。

## SchemaVersionListItem 结构
<a name="aws-glue-api-schema-registry-api-SchemaVersionListItem"></a>

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

**Fields**
+ `SchemaArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  架构的 Amazon Resource Name（ARN）。
+ `SchemaVersionId` – UTF-8 字符串，长度不少于 36 个字节或超过 36 个字节，与 [Custom string pattern #45](aws-glue-api-common.md#regex_45) 匹配。

  架构版本的唯一标识符。
+ `VersionNumber` – 数字（长度），不小于 1 或大于 100000。

  架构的版本号。
+ `Status` – UTF-8 字符串（有效值：`AVAILABLE` \$1`PENDING` \$1`FAILURE` \$1`DELETING` ）。

  架构版本的状态。
+ `CreatedTime` – UTF-8 字符串。

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

## MetadataKeyValuePair 结构
<a name="aws-glue-api-schema-registry-api-MetadataKeyValuePair"></a>

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

**Fields**
+ `MetadataKey` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #14](aws-glue-api-common.md#regex_14) 匹配。

  元数据键
+ `MetadataValue` – UTF-8 字符串，长度不少于 1 个字节或超过 256 个字节，与 [Custom string pattern #14](aws-glue-api-common.md#regex_14) 匹配。

  元数据键的相应值。

## SchemaVersionErrorItem 结构
<a name="aws-glue-api-schema-registry-api-SchemaVersionErrorItem"></a>

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

**Fields**
+ `VersionNumber` – 数字（长度），不小于 1 或大于 100000。

  架构的版本号。
+ `ErrorDetails` – 一个 [ErrorDetails](#aws-glue-api-schema-registry-api-ErrorDetails) 对象。

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

## ErrorDetails 结构
<a name="aws-glue-api-schema-registry-api-ErrorDetails"></a>

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

**Fields**
+ `ErrorCode` – UTF-8 字符串。

  错误的错误代码。
+ `ErrorMessage` – UTF-8 字符串。

  错误的错误消息。

## SchemaVersionNumber 结构
<a name="aws-glue-api-schema-registry-api-SchemaVersionNumber"></a>

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

**Fields**
+ `LatestVersion` – 布尔值。

  可用于架构的最新版本。
+ `VersionNumber` – 数字（长度），不小于 1 或大于 100000。

  架构的版本号。

## SchemaId 结构
<a name="aws-glue-api-schema-registry-api-SchemaId"></a>

AWS Glue 架构注册表中的架构的唯一 ID。

**Fields**
+ `SchemaArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  架构的 Amazon Resource Name（ARN）。必须提供 `SchemaArn` 或 `SchemaName` 中的一个。
+ `SchemaName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  架构的名称。必须提供 `SchemaArn` 或 `SchemaName` 中的一个。
+ `RegistryName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

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

## 操作
<a name="aws-glue-api-schema-registry-api-actions"></a>
+ [CreateRegistry 操作（Python：create\$1registry）](#aws-glue-api-schema-registry-api-CreateRegistry)
+ [CreateSchema 操作（Python：create\$1schema）](#aws-glue-api-schema-registry-api-CreateSchema)
+ [GetSchema 操作（Python：get\$1schema）](#aws-glue-api-schema-registry-api-GetSchema)
+ [ListSchemaVersions 操作（Python：list\$1schema \$1version）](#aws-glue-api-schema-registry-api-ListSchemaVersions)
+ [GetSchemaVersion 操作（Python：get\$1table\$1version）](#aws-glue-api-schema-registry-api-GetSchemaVersion)
+ [GetSchemaVersionsDiff 操作（Python：get\$1schema\$1versions\$1diff）](#aws-glue-api-schema-registry-api-GetSchemaVersionsDiff)
+ [ListRegistries 操作（Python：list\$1registries）](#aws-glue-api-schema-registry-api-ListRegistries)
+ [ListSchemas 操作（Python：list\$1schema）](#aws-glue-api-schema-registry-api-ListSchemas)
+ [RegisterSchemaVersion 操作（Python：register\$1schema\$1version）](#aws-glue-api-schema-registry-api-RegisterSchemaVersion)
+ [UpdateSchema 操作（Python：update\$1schema）](#aws-glue-api-schema-registry-api-UpdateSchema)
+ [CheckSchemaVersionValidity 操作（Python：check\$1schema\$1version\$1validity）](#aws-glue-api-schema-registry-api-CheckSchemaVersionValidity)
+ [UpdateRegistry 操作（Python：update\$1registry）](#aws-glue-api-schema-registry-api-UpdateRegistry)
+ [GetSchemaByDefinition 操作（Python：get\$1schema\$1by\$1definition）](#aws-glue-api-schema-registry-api-GetSchemaByDefinition)
+ [GetRegistry 操作（Python：get\$1registry）](#aws-glue-api-schema-registry-api-GetRegistry)
+ [PutSchemaVersionMetadata 操作（Python：put\$1schema\$1version\$1metadata）](#aws-glue-api-schema-registry-api-PutSchemaVersionMetadata)
+ [QuerySchemaVersionMetadata 操作（Python：query\$1schema\$1version\$1metadata）](#aws-glue-api-schema-registry-api-QuerySchemaVersionMetadata)
+ [RemoveSchemaVersionMetadata 操作（Python：remove\$1schema\$1version\$1metadata）](#aws-glue-api-schema-registry-api-RemoveSchemaVersionMetadata)
+ [DeleteRegistry 操作（Python：delete\$1registry）](#aws-glue-api-schema-registry-api-DeleteRegistry)
+ [DeleteSchema 操作（Python：delete\$1schema）](#aws-glue-api-schema-registry-api-DeleteSchema)
+ [DeleteSchemaVersions 操作（Python：delete\$1table\$1version）](#aws-glue-api-schema-registry-api-DeleteSchemaVersions)

## CreateRegistry 操作（Python：create\$1registry）
<a name="aws-glue-api-schema-registry-api-CreateRegistry"></a>

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

**请求**
+ `RegistryName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  要创建的注册表的名称，其最大长度不得超过 255 个字符，且只能包含字母、数字、连字符、下划线、美元符号或哈希标记。无空格。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  注册表的描述。如果未提供描述，则不会有任何默认值。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

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

**响应**
+ `RegistryArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  服务注册表的 Amazon Resource Name（ARN）。
+ `RegistryName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  注册表的名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  注册表的描述。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  注册表的标签。

**错误**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentModificationException`
+ `ThrottlingException`
+ `InternalServiceException`

## CreateSchema 操作（Python：create\$1schema）
<a name="aws-glue-api-schema-registry-api-CreateSchema"></a>

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

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

当不使用 `RegistryId` 调用此 API 时，这将为注册表数据库表中的“default-registry”创建一个条目（如果它尚未存在）。

**请求**
+ `RegistryId` – 一个 [RegistryId](#aws-glue-api-schema-registry-api-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 #46](aws-glue-api-common.md#regex_46) 匹配。

  要创建的架构的名称，其最大长度不得超过 255 个字符，且只能包含字母、数字、连字符、下划线、美元符号或哈希标记。无空格。
+ `DataFormat` – *必填：* UTF-8 字符串（有效值：`AVRO` \$1 `JSON` \$1 `PROTOBUF`）。

  架构定义的数据格式。目前支持 `AVRO`、`JSON` 和 `PROTOBUF`。
+ `Compatibility` – UTF-8 字符串（有效值：`NONE` \$1`DISABLED` \$1`BACKWARD` \$1`BACKWARD_ALL` \$1`FORWARD` \$1`FORWARD_ALL` \$1`FULL` \$1`FULL_ALL` ）。

  架构的兼容模式。可能的值包括：
  +  *NONE*：不适用兼容模式。您可以在开发场景或者在不知道要应用于架构的兼容性模式时使用此选项。无需进行兼容性检查，接受添加的任何新版本。
  +  *DISABLED*：此兼容性选项可防止对特定架构进行版本控制。您可以使用此选项来防止将来对架构进行版本控制。
  +  *BACKWARD*：建议使用此兼容性选项，因为它允许数据接收器读取架构的最新版本和上一个版本。这意味着，例如，新架构版本不能删除数据字段或更改这些字段的类型，因此使用先前版本的读取器无法读取这些字段。
  +  *BACKWARD\$1ALL*：此兼容性选项允许数据接收器读取架构的最新版本和所有先前版本。当您需要删除字段或添加可选字段以及检查所有先前架构版本的兼容性时，您可以使用此选项。
  +  *FORWARD*：此兼容性选项允许数据接收器读取当前和下一个架构版本，但不一定是更高版本。当您需要添加字段或删除可选字段，但仅检查上一个架构版本的兼容性时，您可以使用此选项。
  +  *FORWARD\$1ALL*：此兼容性选项允许数据接收器读取任何新的注册架构的创建器写入。当您需要添加字段或删除可选字段以及检查所有先前架构版本的兼容性时，您可以使用此选项。
  +  *FULL*：此兼容性选项允许数据接收器读取使用先前版本或下一版本的架构，但不一定是早期版本或更高版本的创建器写入的数据。当您需要添加或删除可选字段，但仅检查上一个架构版本的兼容性时，您可以使用此选项。
  +  *FULL\$1ALL*：此兼容性选项允许数据接收器读取使用所有架构先前版本的创建器写入的数据。当您需要添加或删除可选字段以及检查所有先前架构版本的兼容性时，您可以使用此选项。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  架构的描述（可选）。如果未提供描述，则不会有自动任何默认值。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  AWS 标签，其中包含键值对，并可以通过控制台、命令行或 API 进行搜索。如果指定，请遵循 AWS tags-on-create 模式。
+ `SchemaDefinition` – UTF-8 字符串，长度不少于 1 个字节或超过 170000 个字节，与 [Custom string pattern #13](aws-glue-api-common.md#regex_13) 匹配。

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

**响应**
+ `RegistryName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  注册表的名称。
+ `RegistryArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  注册表的 Amazon Resource Name（ARN）。
+ `SchemaName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  架构的名称。
+ `SchemaArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  架构的 Amazon Resource Name（ARN）。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  对架构（如果在创建时指定）的描述。
+ `DataFormat` – UTF-8 字符串（有效值：`AVRO` \$1`JSON` \$1`PROTOBUF` ）。

  架构定义的数据格式。目前支持 `AVRO`、`JSON` 和 `PROTOBUF`。
+ `Compatibility` – UTF-8 字符串（有效值：`NONE` \$1`DISABLED` \$1`BACKWARD` \$1`BACKWARD_ALL` \$1`FORWARD` \$1`FORWARD_ALL` \$1`FULL` \$1`FULL_ALL` ）。

  架构的兼容模式。
+ `SchemaCheckpoint` – 数字（长度），不小于 1 或大于 100000。

  检查点的版本号（上次更改兼容模式时）。
+ `LatestSchemaVersion` – 数字（长度），不小于 1 或大于 100000。

  与返回的架构定义相关联的架构的最新版本。
+ `NextSchemaVersion` – 数字（长度），不小于 1 或大于 100000。

  与返回的架构定义相关联的架构的下一个版本。
+ `SchemaStatus` – UTF-8 字符串（有效值：`AVAILABLE` \$1`PENDING` \$1`DELETING` ）。

  架构的状态。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  架构的标签。
+ `SchemaVersionId` – UTF-8 字符串，长度不少于 36 个字节或超过 36 个字节，与 [Custom string pattern #45](aws-glue-api-common.md#regex_45) 匹配。

  第一个架构版本的唯一标识符。
+ `SchemaVersionStatus` – UTF-8 字符串（有效值：`AVAILABLE` \$1`PENDING` \$1`FAILURE` \$1`DELETING` ）。

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

**错误**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentModificationException`
+ `ThrottlingException`
+ `InternalServiceException`

## GetSchema 操作（Python：get\$1schema）
<a name="aws-glue-api-schema-registry-api-GetSchema"></a>

详细描述指定的架构。

**请求**
+ `SchemaId` – *必填：*一个 [SchemaId](#aws-glue-api-schema-registry-api-SchemaId) 对象。

  包含架构标识字段的包装结构。结构包含：
  + SchemaId\$1SchemaArn：架构的 Amazon Resource Name（ARN） 必须提供 `SchemaArn`，或者 `SchemaName` 和 `RegistryName`。
  + SchemaId\$1SchemaName：架构的名称。必须提供 `SchemaArn`，或者 `SchemaName` 和 `RegistryName`。

**响应**
+ `RegistryName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  注册表的名称。
+ `RegistryArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  注册表的 Amazon Resource Name（ARN）。
+ `SchemaName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  架构的名称。
+ `SchemaArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  架构的 Amazon Resource Name（ARN）。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  对架构（如果在创建时指定）的描述。
+ `DataFormat` – UTF-8 字符串（有效值：`AVRO` \$1`JSON` \$1`PROTOBUF` ）。

  架构定义的数据格式。目前支持 `AVRO`、`JSON` 和 `PROTOBUF`。
+ `Compatibility` – UTF-8 字符串（有效值：`NONE` \$1`DISABLED` \$1`BACKWARD` \$1`BACKWARD_ALL` \$1`FORWARD` \$1`FORWARD_ALL` \$1`FULL` \$1`FULL_ALL` ）。

  架构的兼容模式。
+ `SchemaCheckpoint` – 数字（长度），不小于 1 或大于 100000。

  检查点的版本号（上次更改兼容模式时）。
+ `LatestSchemaVersion` – 数字（长度），不小于 1 或大于 100000。

  与返回的架构定义相关联的架构的最新版本。
+ `NextSchemaVersion` – 数字（长度），不小于 1 或大于 100000。

  与返回的架构定义相关联的架构的下一个版本。
+ `SchemaStatus` – UTF-8 字符串（有效值：`AVAILABLE` \$1`PENDING` \$1`DELETING` ）。

  架构的状态。
+ `CreatedTime` – UTF-8 字符串。

  架构的创建日期和时间。
+ `UpdatedTime` – UTF-8 字符串。

  架构的更新日期和时间。

**错误**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `InternalServiceException`

## ListSchemaVersions 操作（Python：list\$1schema \$1version）
<a name="aws-glue-api-schema-registry-api-ListSchemaVersions"></a>

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

**请求**
+ `SchemaId` – *必填：*一个 [SchemaId](#aws-glue-api-schema-registry-api-SchemaId) 对象。

  包含架构标识字段的包装结构。结构包含：
  + SchemaId\$1SchemaArn：架构的 Amazon Resource Name（ARN） 必须提供 `SchemaArn`，或者 `SchemaName` 和 `RegistryName`。
  + SchemaId\$1SchemaName：架构的名称。必须提供 `SchemaArn`，或者 `SchemaName` 和 `RegistryName`。
+ `MaxResults` – 数字（整数），不小于 1 或大于 100。

  每页所需的最大结果数量。如果未提供该值，则每页默认最大数量为 25。
+ `NextToken` – UTF-8 字符串。

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

**响应**
+ `Schemas` – [SchemaVersionListItem](#aws-glue-api-schema-registry-api-SchemaVersionListItem) 对象的数组。

  `SchemaVersionList` 对象的数组，包含每个架构版本的详细信息。
+ `NextToken` – UTF-8 字符串。

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

**错误**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `InternalServiceException`

## GetSchemaVersion 操作（Python：get\$1table\$1version）
<a name="aws-glue-api-schema-registry-api-GetSchemaVersion"></a>

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

**请求**
+ `SchemaId` – 一个 [SchemaId](#aws-glue-api-schema-registry-api-SchemaId) 对象。

  包含架构标识字段的包装结构。结构包含：
  + SchemaId\$1SchemaArn：架构的 Amazon Resource Name（ARN） 必须提供 `SchemaArn`，或者 `SchemaName` 和 `RegistryName`。
  + SchemaId\$1SchemaName：架构的名称。必须提供 `SchemaArn`，或者 `SchemaName` 和 `RegistryName`。
+ `SchemaVersionId` – UTF-8 字符串，长度不少于 36 个字节或超过 36 个字节，与 [Custom string pattern #45](aws-glue-api-common.md#regex_45) 匹配。

  架构版本的 `SchemaVersionId`。此字段是按架构 ID 进行读取的必填字段。必须提供此字段或 `SchemaId` 包装。
+ `SchemaVersionNumber` – 一个 [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber) 对象。

  架构的版本号。

**响应**
+ `SchemaVersionId` – UTF-8 字符串，长度不少于 36 个字节或超过 36 个字节，与 [Custom string pattern #45](aws-glue-api-common.md#regex_45) 匹配。

  架构版本的 `SchemaVersionId`。
+ `SchemaDefinition` – UTF-8 字符串，长度不少于 1 个字节或超过 170000 个字节，与 [Custom string pattern #13](aws-glue-api-common.md#regex_13) 匹配。

  架构 ID 的架构定义。
+ `DataFormat` – UTF-8 字符串（有效值：`AVRO` \$1`JSON` \$1`PROTOBUF` ）。

  架构定义的数据格式。目前支持 `AVRO`、`JSON` 和 `PROTOBUF`。
+ `SchemaArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  架构的 Amazon Resource Name（ARN）。
+ `VersionNumber` – 数字（长度），不小于 1 或大于 100000。

  架构的版本号。
+ `Status` – UTF-8 字符串（有效值：`AVAILABLE` \$1`PENDING` \$1`FAILURE` \$1`DELETING` ）。

  架构版本的状态。
+ `CreatedTime` – UTF-8 字符串。

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

**错误**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `InternalServiceException`

## GetSchemaVersionsDiff 操作（Python：get\$1schema\$1versions\$1diff）
<a name="aws-glue-api-schema-registry-api-GetSchemaVersionsDiff"></a>

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

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

**请求**
+ `SchemaId` – *必填：*一个 [SchemaId](#aws-glue-api-schema-registry-api-SchemaId) 对象。

  包含架构标识字段的包装结构。结构包含：
  + SchemaId\$1SchemaArn：架构的 Amazon Resource Name（ARN） 必须提供 `SchemaArn` 或 `SchemaName` 中的一个。
  + SchemaId\$1SchemaName：架构的名称。必须提供 `SchemaArn` 或 `SchemaName` 中的一个。
+ `FirstSchemaVersionNumber` – *必填：*一个 [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber) 对象。

  要比较的两个架构版本中的第一个版本。
+ `SecondSchemaVersionNumber` – *必填：*一个 [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber) 对象。

  要比较的两个架构版本中的第二个版本。
+ `SchemaDiffType` – *必填*：UTF-8 字符串（有效值：`SYNTAX_DIFF`）。

  指的是 `SYNTAX_DIFF`，这是当前支持的差异类型。

**响应**
+ `Diff` – UTF-8 字符串，长度不少于 1 个字节或超过 340000 个字节，与 [Custom string pattern #13](aws-glue-api-common.md#regex_13) 匹配。

  架构之间的差异以字符串的形式在 JSONPatch 格式中输出。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `InternalServiceException`

## ListRegistries 操作（Python：list\$1registries）
<a name="aws-glue-api-schema-registry-api-ListRegistries"></a>

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

**请求**
+ `MaxResults` – 数字（整数），不小于 1 或大于 100。

  每页所需的最大结果数量。如果未提供该值，则每页默认最大数量为 25。
+ `NextToken` – UTF-8 字符串。

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

**响应**
+ `Registries` – [RegistryListItem](#aws-glue-api-schema-registry-api-RegistryListItem) 对象的数组。

  `RegistryDetailedListItem` 对象的数组，其中包含每个注册表的最少详细信息。
+ `NextToken` – UTF-8 字符串。

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

**错误**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `InternalServiceException`

## ListSchemas 操作（Python：list\$1schema）
<a name="aws-glue-api-schema-registry-api-ListSchemas"></a>

返回具有最少详细信息的架构列表。结果中将不会包含处于 Deleting (正在删除) 状态的架构。如果没有可用的架构，则返回空白结果。

未提供 `RegistryId` 时，跨注册表的所有架构都将成为 API 响应的一部分。

**请求**
+ `RegistryId` – 一个 [RegistryId](#aws-glue-api-schema-registry-api-RegistryId) 对象。

  包装结构，包含注册表名称和 Amazon Resource Name（ARN）。
+ `MaxResults` – 数字（整数），不小于 1 或大于 100。

  每页所需的最大结果数量。如果未提供该值，则每页默认最大数量为 25。
+ `NextToken` – UTF-8 字符串。

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

**响应**
+ `Schemas` – [SchemaListItem](#aws-glue-api-schema-registry-api-SchemaListItem) 对象的数组。

  `SchemaListItem` 对象数组，包含每个架构的详细信息。
+ `NextToken` – UTF-8 字符串。

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

**错误**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `InternalServiceException`

## RegisterSchemaVersion 操作（Python：register\$1schema\$1version）
<a name="aws-glue-api-schema-registry-api-RegisterSchemaVersion"></a>

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

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

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

**请求**
+ `SchemaId` – *必填：*一个 [SchemaId](#aws-glue-api-schema-registry-api-SchemaId) 对象。

  包含架构标识字段的包装结构。结构包含：
  + SchemaId\$1SchemaArn：架构的 Amazon Resource Name（ARN） 必须提供 `SchemaArn`，或者 `SchemaName` 和 `RegistryName`。
  + SchemaId\$1SchemaName：架构的名称。必须提供 `SchemaArn`，或者 `SchemaName` 和 `RegistryName`。
+ `SchemaDefinition` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 170000 个字节，与 [Custom string pattern #13](aws-glue-api-common.md#regex_13) 匹配。

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

**响应**
+ `SchemaVersionId` – UTF-8 字符串，长度不少于 36 个字节或超过 36 个字节，与 [Custom string pattern #45](aws-glue-api-common.md#regex_45) 匹配。

  表示此架构版本的唯一 ID。
+ `VersionNumber` – 数字（长度），不小于 1 或大于 100000。

  此架构的版本（仅适用于同步流，以防这是第一个版本）。
+ `Status` – UTF-8 字符串（有效值：`AVAILABLE` \$1`PENDING` \$1`FAILURE` \$1`DELETING` ）。

  架构版本的状态。

**错误**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ResourceNumberLimitExceededException`
+ `ThrottlingException`
+ `ConcurrentModificationException`
+ `InternalServiceException`

## UpdateSchema 操作（Python：update\$1schema）
<a name="aws-glue-api-schema-registry-api-UpdateSchema"></a>

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

为了更新兼容性设置，调用不会验证具有新兼容性设置的整个架构版本集的兼容性。如果提供用于 `Compatibility` 的值，还需要 `VersionNumber`（检查点）。API 将验证检查点版本号的一致性。

如果提供 `VersionNumber`（检查点）的值，则 `Compatibility` 是可选的，这可用于设置/重置架构的检查点。

仅当架构处于 AVAILABLE (可用) 状态时，才会进行此更新。

**请求**
+ `SchemaId` – *必填：*一个 [SchemaId](#aws-glue-api-schema-registry-api-SchemaId) 对象。

  包含架构标识字段的包装结构。结构包含：
  + SchemaId\$1SchemaArn：架构的 Amazon Resource Name（ARN） 必须提供 `SchemaArn` 或 `SchemaName` 中的一个。
  + SchemaId\$1SchemaName：架构的名称。必须提供 `SchemaArn` 或 `SchemaName` 中的一个。
+ `SchemaVersionNumber` – 一个 [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber) 对象。

  通过检查点检验所需的版本号。必须提供 `VersionNumber` 或 `Compatibility` 中的一个。
+ `Compatibility` – UTF-8 字符串（有效值：`NONE` \$1`DISABLED` \$1`BACKWARD` \$1`BACKWARD_ALL` \$1`FORWARD` \$1`FORWARD_ALL` \$1`FULL` \$1`FULL_ALL` ）。

  架构的新兼容性设置。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  架构的新描述。

**响应**
+ `SchemaArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  架构的 Amazon Resource Name（ARN）。
+ `SchemaName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  架构的名称。
+ `RegistryName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

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

**错误**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ConcurrentModificationException`
+ `ThrottlingException`
+ `InternalServiceException`

## CheckSchemaVersionValidity 操作（Python：check\$1schema\$1version\$1validity）
<a name="aws-glue-api-schema-registry-api-CheckSchemaVersionValidity"></a>

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

**请求**
+ `DataFormat` – *必填：* UTF-8 字符串（有效值：`AVRO` \$1 `JSON` \$1 `PROTOBUF`）。

  架构定义的数据格式。目前支持 `AVRO`、`JSON` 和 `PROTOBUF`。
+ `SchemaDefinition` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 170000 个字节，与 [Custom string pattern #13](aws-glue-api-common.md#regex_13) 匹配。

  必须验证的架构的定义。

**响应**
+ `Valid` – 布尔值。

  如果模式有效，则返回“true”，否则返回“false”。
+ `Error` – UTF-8 字符串，长度不少于 1 个字节或超过 5000 个字节。

  验证失败错误消息。

**错误**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `InternalServiceException`

## UpdateRegistry 操作（Python：update\$1registry）
<a name="aws-glue-api-schema-registry-api-UpdateRegistry"></a>

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

**请求**
+ `RegistryId` – *必填：*一个 [RegistryId](#aws-glue-api-schema-registry-api-RegistryId) 对象。

  这是包装结构，包含注册表名称和 Amazon Resource Name（ARN）。
+ `Description` – *必填*：描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

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

**响应**
+ `RegistryName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  更新的注册表的名称。
+ `RegistryArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  更新的注册表的 Amazon Resource name（ARN）。

**错误**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ConcurrentModificationException`
+ `ThrottlingException`
+ `InternalServiceException`

## GetSchemaByDefinition 操作（Python：get\$1schema\$1by\$1definition）
<a name="aws-glue-api-schema-registry-api-GetSchemaByDefinition"></a>

通过 `SchemaDefinition` 来检索架构。架构定义将发送到架构注册表、进行标准化和哈希处理。如果哈希在 `SchemaName` 或 ARN（或默认注册表，如果未提供）的范围内匹配，则返回该架构的元数据。否则，将返回 404 或 NotFound 错误。结果中将不会包含处于 `Deleted` 状态的架构版本。

**请求**
+ `SchemaId` – *必填：*一个 [SchemaId](#aws-glue-api-schema-registry-api-SchemaId) 对象。

  包含架构标识字段的包装结构。结构包含：
  + SchemaId\$1SchemaArn：架构的 Amazon Resource Name（ARN） 必须提供 `SchemaArn` 或 `SchemaName` 中的一个。
  + SchemaId\$1SchemaName：架构的名称。必须提供 `SchemaArn` 或 `SchemaName` 中的一个。
+ `SchemaDefinition` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 170000 个字节，与 [Custom string pattern #13](aws-glue-api-common.md#regex_13) 匹配。

  需要架构详细信息的架构的定义。

**响应**
+ `SchemaVersionId` – UTF-8 字符串，长度不少于 36 个字节或超过 36 个字节，与 [Custom string pattern #45](aws-glue-api-common.md#regex_45) 匹配。

  架构版本的架构 ID。
+ `SchemaArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  架构的 Amazon Resource Name（ARN）。
+ `DataFormat` – UTF-8 字符串（有效值：`AVRO` \$1`JSON` \$1`PROTOBUF` ）。

  架构定义的数据格式。目前支持 `AVRO`、`JSON` 和 `PROTOBUF`。
+ `Status` – UTF-8 字符串（有效值：`AVAILABLE` \$1`PENDING` \$1`FAILURE` \$1`DELETING` ）。

  架构版本的状态。
+ `CreatedTime` – UTF-8 字符串。

  架构的创建日期和时间。

**错误**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `InternalServiceException`

## GetRegistry 操作（Python：get\$1registry）
<a name="aws-glue-api-schema-registry-api-GetRegistry"></a>

详细描述指定的注册表。

**请求**
+ `RegistryId` – *必填：*一个 [RegistryId](#aws-glue-api-schema-registry-api-RegistryId) 对象。

  这是包装结构，包含注册表名称和 Amazon Resource Name（ARN）。

**响应**
+ `RegistryName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  注册表的名称。
+ `RegistryArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  注册表的 Amazon Resource Name（ARN）。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  注册表的描述。
+ `Status` – UTF-8 字符串（有效值：`AVAILABLE` \$1`DELETING` ）。

  注册表的状态。
+ `CreatedTime` – UTF-8 字符串。

  注册表的创建日期和时间。
+ `UpdatedTime` – UTF-8 字符串。

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

**错误**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `InternalServiceException`

## PutSchemaVersionMetadata 操作（Python：put\$1schema\$1version\$1metadata）
<a name="aws-glue-api-schema-registry-api-PutSchemaVersionMetadata"></a>

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

**请求**
+ `SchemaId` – 一个 [SchemaId](#aws-glue-api-schema-registry-api-SchemaId) 对象。

  架构的唯一 ID。
+ `SchemaVersionNumber` – 一个 [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber) 对象。

  架构的版本号。
+ `SchemaVersionId` – UTF-8 字符串，长度不少于 36 个字节或超过 36 个字节，与 [Custom string pattern #45](aws-glue-api-common.md#regex_45) 匹配。

  架构版本的唯一版本 ID。
+ `MetadataKeyValue` – *必填：*一个 [MetadataKeyValuePair](#aws-glue-api-schema-registry-api-MetadataKeyValuePair) 对象。

  元数据键的相应值。

**响应**
+ `SchemaArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  架构的 Amazon Resource Name（ARN）。
+ `SchemaName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  架构的名称。
+ `RegistryName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  注册表的名称。
+ `LatestVersion` – 布尔值。

  架构的最新版本。
+ `VersionNumber` – 数字（长度），不小于 1 或大于 100000。

  架构的版本号。
+ `SchemaVersionId` – UTF-8 字符串，长度不少于 36 个字节或超过 36 个字节，与 [Custom string pattern #45](aws-glue-api-common.md#regex_45) 匹配。

  架构版本的唯一版本 ID。
+ `MetadataKey` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #14](aws-glue-api-common.md#regex_14) 匹配。

  元数据键。
+ `MetadataValue` – UTF-8 字符串，长度不少于 1 个字节或超过 256 个字节，与 [Custom string pattern #14](aws-glue-api-common.md#regex_14) 匹配。

  元数据键的值。

**错误**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `AlreadyExistsException`
+ `EntityNotFoundException`
+ `ThrottlingException`
+ `ResourceNumberLimitExceededException`

## QuerySchemaVersionMetadata 操作（Python：query\$1schema\$1version\$1metadata）
<a name="aws-glue-api-schema-registry-api-QuerySchemaVersionMetadata"></a>

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

**请求**
+ `SchemaId` – 一个 [SchemaId](#aws-glue-api-schema-registry-api-SchemaId) 对象。

  包装结构，包含架构名称和 Amazon Resource Name（ARN）。
+ `SchemaVersionNumber` – 一个 [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber) 对象。

  架构的版本号。
+ `SchemaVersionId` – UTF-8 字符串，长度不少于 36 个字节或超过 36 个字节，与 [Custom string pattern #45](aws-glue-api-common.md#regex_45) 匹配。

  架构版本的唯一版本 ID。
+ `MetadataList` – [MetadataKeyValuePair](#aws-glue-api-schema-registry-api-MetadataKeyValuePair) 对象的数组。

  搜索元数据的键值对，如果未提供键值对，则将获取所有元数据信息。
+ `MaxResults` – 数字（整数），不小于 1 或大于 50。

  每页所需的最大结果数量。如果未提供该值，则每页默认最大数量为 25。
+ `NextToken` – UTF-8 字符串。

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

**响应**
+ `MetadataInfoMap` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #14](aws-glue-api-common.md#regex_14) 匹配。

  每个值都是一个 [MetadataInfo](#aws-glue-api-schema-registry-api-MetadataInfo) 对象。

  元数据键和关联值的映射。
+ `SchemaVersionId` – UTF-8 字符串，长度不少于 36 个字节或超过 36 个字节，与 [Custom string pattern #45](aws-glue-api-common.md#regex_45) 匹配。

  架构版本的唯一版本 ID。
+ `NextToken` – UTF-8 字符串。

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

**错误**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `EntityNotFoundException`

## RemoveSchemaVersionMetadata 操作（Python：remove\$1schema\$1version\$1metadata）
<a name="aws-glue-api-schema-registry-api-RemoveSchemaVersionMetadata"></a>

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

**请求**
+ `SchemaId` – 一个 [SchemaId](#aws-glue-api-schema-registry-api-SchemaId) 对象。

  包装结构，包含架构名称和 Amazon Resource Name（ARN）。
+ `SchemaVersionNumber` – 一个 [SchemaVersionNumber](#aws-glue-api-schema-registry-api-SchemaVersionNumber) 对象。

  架构的版本号。
+ `SchemaVersionId` – UTF-8 字符串，长度不少于 36 个字节或超过 36 个字节，与 [Custom string pattern #45](aws-glue-api-common.md#regex_45) 匹配。

  架构版本的唯一版本 ID。
+ `MetadataKeyValue` – *必填：*一个 [MetadataKeyValuePair](#aws-glue-api-schema-registry-api-MetadataKeyValuePair) 对象。

  元数据键的值。

**响应**
+ `SchemaArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  架构的 Amazon Resource Name（ARN）。
+ `SchemaName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  架构的名称。
+ `RegistryName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  注册表的名称。
+ `LatestVersion` – 布尔值。

  架构的最新版本。
+ `VersionNumber` – 数字（长度），不小于 1 或大于 100000。

  架构的版本号。
+ `SchemaVersionId` – UTF-8 字符串，长度不少于 36 个字节或超过 36 个字节，与 [Custom string pattern #45](aws-glue-api-common.md#regex_45) 匹配。

  架构版本的版本 ID。
+ `MetadataKey` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #14](aws-glue-api-common.md#regex_14) 匹配。

  元数据键。
+ `MetadataValue` – UTF-8 字符串，长度不少于 1 个字节或超过 256 个字节，与 [Custom string pattern #14](aws-glue-api-common.md#regex_14) 匹配。

  元数据键的值。

**错误**
+ `InvalidInputException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `EntityNotFoundException`

## DeleteRegistry 操作（Python：delete\$1registry）
<a name="aws-glue-api-schema-registry-api-DeleteRegistry"></a>

删除包含架构及其所有版本的整个注册表。要获取删除操作的状态，您可以在异步调用后调用 `GetRegistry` API。删除注册表将停用注册表的所有联机操作，如 `UpdateRegistry`、`CreateSchema`、`UpdateSchema` 和 `RegisterSchemaVersion` API。

**请求**
+ `RegistryId` – *必填：*一个 [RegistryId](#aws-glue-api-schema-registry-api-RegistryId) 对象。

  这是包装结构，包含注册表名称和 Amazon Resource Name（ARN）。

**响应**
+ `RegistryName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  正在删除的注册表的名称。
+ `RegistryArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  服务注册表的 Amazon Resource Name（ARN）。
+ `Status` – UTF-8 字符串（有效值：`AVAILABLE` \$1`DELETING` ）。

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

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `ConcurrentModificationException`

## DeleteSchema 操作（Python：delete\$1schema）
<a name="aws-glue-api-schema-registry-api-DeleteSchema"></a>

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

**请求**
+ `SchemaId` – *必填：*一个 [SchemaId](#aws-glue-api-schema-registry-api-SchemaId) 对象。

  这是包装结构，包含架构名称和 Amazon Resource Name（ARN）。

**响应**
+ `SchemaArn` – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  要删除的架构的 Amazon Resource Name（ARN）。
+ `SchemaName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #46](aws-glue-api-common.md#regex_46) 匹配。

  正在删除的架构的名称。
+ `Status` – UTF-8 字符串（有效值：`AVAILABLE` \$1`PENDING` \$1`DELETING` ）。

  架构的状态。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `ConcurrentModificationException`

## DeleteSchemaVersions 操作（Python：delete\$1table\$1version）
<a name="aws-glue-api-schema-registry-api-DeleteSchemaVersions"></a>

从指定架构中删除版本。可以提供版本号或范围。如果兼容模式禁止删除必要的版本（如 BACKWARDS\$1FULL），则返回错误。此调用后调用的 `GetSchemaVersions` API 将列出已删除版本的状态。

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

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

如果兼容模式禁止删除必要的版本（如 BACKWARDS\$1FULL），则返回错误。

**请求**
+ `SchemaId` – *必填：*一个 [SchemaId](#aws-glue-api-schema-registry-api-SchemaId) 对象。

  这是包装结构，包含架构名称和 Amazon Resource Name（ARN）。
+ `Versions` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 100000 个字节，与 [Custom string pattern #15](aws-glue-api-common.md#regex_15) 匹配。

  可以提供一个版本范围，其格式可能为：
  + 单个版本号，5
  + 一个范围，5-8：删除版本 5、6、7、8

**响应**
+ `SchemaVersionErrors` – [SchemaVersionErrorItem](#aws-glue-api-schema-registry-api-SchemaVersionErrorItem) 对象的数组。

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

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `ThrottlingException`
+ `ConcurrentModificationException`

# 工作流程
<a name="aws-glue-api-workflow"></a>

 工作流 API 介绍与在 AWS Glue 中创建、更新或查看工作流相关的数据类型和 API。您可以在 90 天内访问工作流和任务运行的任务运行历史记录。

## 数据类型
<a name="aws-glue-api-workflow-objects"></a>
+ [JobNodeDetails 结构](#aws-glue-api-workflow-JobNodeDetails)
+ [CrawlerNodeDetails 结构](#aws-glue-api-workflow-CrawlerNodeDetails)
+ [TriggerNodeDetails 结构](#aws-glue-api-workflow-TriggerNodeDetails)
+ [Crawl 结构](#aws-glue-api-workflow-Crawl)
+ [Node 结构](#aws-glue-api-workflow-Node)
+ [Edge 结构](#aws-glue-api-workflow-Edge)
+ [Workflow 结构](#aws-glue-api-workflow-Workflow)
+ [WorkflowGraph 结构](#aws-glue-api-workflow-WorkflowGraph)
+ [WorkflowRun 结构](#aws-glue-api-workflow-WorkflowRun)
+ [WorkflowRunStatistics 结构](#aws-glue-api-workflow-WorkflowRunStatistics)
+ [StartingEventBatchCondition 结构](#aws-glue-api-workflow-StartingEventBatchCondition)
+ [Blueprint 结构](#aws-glue-api-workflow-Blueprint)
+ [BlueprintDetails 结构](#aws-glue-api-workflow-BlueprintDetails)
+ [LastActiveDefinition 结构](#aws-glue-api-workflow-LastActiveDefinition)
+ [BlueprintRun 结构](#aws-glue-api-workflow-BlueprintRun)

## JobNodeDetails 结构
<a name="aws-glue-api-workflow-JobNodeDetails"></a>

工作流程中展示的作业节点的详细信息。

**字段**
+ `JobRuns` – [JobRun](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-JobRun) 对象的数组。

  作业节点表示的作业运行的信息。

## CrawlerNodeDetails 结构
<a name="aws-glue-api-workflow-CrawlerNodeDetails"></a>

工作流程中存在的爬网程序节点的详细信息。

**字段**
+ `Crawls` – [爬网](#aws-glue-api-workflow-Crawl) 对象的数组。

  爬网节点表示的爬网的列表。

## TriggerNodeDetails 结构
<a name="aws-glue-api-workflow-TriggerNodeDetails"></a>

工作流程中存在的触发器节点的详细信息。

**字段**
+ `Trigger` – 一个 [触发器](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-Trigger) 对象。

  触发器节点表示的触发器的信息。

## Crawl 结构
<a name="aws-glue-api-workflow-Crawl"></a>

工作流程中的爬网的详细信息。

**字段**
+ `State` – UTF-8 字符串（有效值：`RUNNING` \$1 `CANCELLING` \$1 `CANCELLED` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `ERROR`）。

  爬网程序的状态。
+ `StartedOn` – 时间戳。

  爬网操作的开始日期和时间。
+ `CompletedOn` – 时间戳。

  爬网操作的完成日期和时间。
+ `ErrorMessage` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  与爬网关联的错误消息。
+ `LogGroup` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节，与 [Log group string pattern](aws-glue-api-common.md#aws-glue-api-regex-logGroup-id) 匹配。

  与爬网关联的日志组。
+ `LogStream` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节，与 [Log-stream string pattern](aws-glue-api-common.md#aws-glue-api-regex-logStream-id) 匹配。

  与爬网关联的日志流。

## Node 结构
<a name="aws-glue-api-workflow-Node"></a>

节点在工作流图表中表示 AWS Glue 组件（触发器、爬网程序或任务）。

**字段**
+ `Type` – UTF-8 字符串（有效值：`CRAWLER` \$1 `JOB` \$1 `TRIGGER`）。

  节点表示的 AWS Glue 组件的类型。
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  节点表示的 AWS Glue 组件的名称。
+ `UniqueId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分配给工作流程中的节点的唯一 ID。
+ `TriggerDetails` – 一个 [TriggerNodeDetails](#aws-glue-api-workflow-TriggerNodeDetails) 对象。

  触发器的详细信息（当节点表示触发器时）。
+ `JobDetails` – 一个 [JobNodeDetails](#aws-glue-api-workflow-JobNodeDetails) 对象。

  作业的详细信息（当节点表示作业时）。
+ `CrawlerDetails` – 一个 [CrawlerNodeDetails](#aws-glue-api-workflow-CrawlerNodeDetails) 对象。

  爬网程序的详细信息（当节点表示爬网程序时）。

## Edge 结构
<a name="aws-glue-api-workflow-Edge"></a>

边缘表示两个 AWS Glue 组件之间的定向连接，这两个组件是边缘所属的工作流的一部分。

**字段**
+ `SourceId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  边缘在其中启动的工作流程中节点的唯一 ID。
+ `DestinationId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  边缘在其中终止的工作流程中节点的唯一 ID。

## Workflow 结构
<a name="aws-glue-api-workflow-Workflow"></a>

工作流是为完成复杂 ETL 任务而运行的多个相互依赖的 AWS Glue 任务和爬网程序的集合。工作流管理其所有任务和爬网程序的执行和监控。

**字段**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  工作流的名称。
+ `Description` – UTF-8 字符串。

  工作流程的描述。
+ `DefaultRunProperties` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  每个值是一个 UTF-8 字符串。

  要用作每个工作流程执行的一部分的属性的集合。运行属性可供工作流中的每个任务使用。任务可以修改工作流中后续任务的属性。
+ `CreatedOn` – 时间戳。

  工作流程的创建日期和时间。
+ `LastModifiedOn` – 时间戳。

  工作流程的最后修改日期和时间。
+ `LastRun` – 一个 [WorkflowRun](#aws-glue-api-workflow-WorkflowRun) 对象。

  有关上次工作流程执行的信息。
+ `Graph` – 一个 [WorkflowGraph](#aws-glue-api-workflow-WorkflowGraph) 对象。

  将属于工作流的所有 AWS Glue 组件表示为节点，并将它们之间的定向连接表示为边缘的图表。
+ `CreationStatus` – UTF-8 字符串（有效值：`CREATING` \$1 `CREATED` \$1 `CREATION_FAILED`）。

  工作流程的创建状态。
+ `MaxConcurrentRuns` – 数字（整数）。

  您可以使用此参数防止系统对数据进行多次不必要的更新，来控制成本，或者在某些情况下，防止系统超过任何组件任务的最大并发运行次数。如果您将此参数留空，则系统对并发工作流运行的次数没有限制。
+ `BlueprintDetails` – 一个 [BlueprintDetails](#aws-glue-api-workflow-BlueprintDetails) 对象。

  此结构指示创建此特定工作流的蓝图的详细信息。

## WorkflowGraph 结构
<a name="aws-glue-api-workflow-WorkflowGraph"></a>

工作流图表表示完整的工作流，其中包含工作流中存在的所有 AWS Glue 组件以及它们之间的所有定向连接。

**字段**
+ `Nodes` – [节点](#aws-glue-api-workflow-Node) 对象的数组。

  属于工作流程的表示为节点的 AWS Glue 组件的列表。
+ `Edges` – [Edge](#aws-glue-api-workflow-Edge) 对象的数组。

  属于工作流程的节点之间的所有定向连接的列表。

## WorkflowRun 结构
<a name="aws-glue-api-workflow-WorkflowRun"></a>

工作流程运行是提供所有运行时信息的工作流程的执行。

**字段**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  已运行的工作流的名称。
+ `WorkflowRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  此工作流程运行的 ID。
+ `PreviousRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  先前工作流运行的 ID。
+ `WorkflowRunProperties` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  每个值是一个 UTF-8 字符串。

  运行期间设置的工作流程运行属性。
+ `StartedOn` – 时间戳。

  工作流程运行的开始日期和时间。
+ `CompletedOn` – 时间戳。

  工作流程运行的完成日期和时间。
+ `Status` – UTF-8 字符串（有效值：`RUNNING` \$1 `COMPLETED` \$1 `STOPPING` \$1 `STOPPED` \$1 `ERROR`）。

  工作流程运行的状态。
+ `ErrorMessage` – UTF-8 字符串。

  此错误消息描述了在启动工作流运行时可能发生的任何错误。目前唯一的错误消息是“超过工作流的并发运行：`foo`。”
+ `Statistics` – 一个 [WorkflowRunStatistics](#aws-glue-api-workflow-WorkflowRunStatistics) 对象。

  运行的统计数据。
+ `Graph` – 一个 [WorkflowGraph](#aws-glue-api-workflow-WorkflowGraph) 对象。

  将属于工作流的所有 AWS Glue 组件表示为节点，并将它们之间的定向连接表示为边缘的图表。
+ `StartingEventBatchCondition` – 一个 [StartingEventBatchCondition](#aws-glue-api-workflow-StartingEventBatchCondition) 对象。

  启动工作流运行的批处理条件。

## WorkflowRunStatistics 结构
<a name="aws-glue-api-workflow-WorkflowRunStatistics"></a>

工作流程运行统计数据提供了有关工作流程运行的统计数据。

**字段**
+ `TotalActions` – 数字（整数）。

  工作流程运行中的操作的总数。
+ `TimeoutActions` – 数字（整数）。

  超时操作的总数。
+ `FailedActions` – 数字（整数）。

  失败操作的总数。
+ `StoppedActions` – 数字（整数）。

  已停止操作的总数。
+ `SucceededActions` – 数字（整数）。

  成功操作的总数。
+ `RunningActions` – 数字（整数）。

  处于正在运行状态的操作的总数。
+ `ErroredActions` – 数字（整数）。

  指示工作流运行中处于 ERROR 状态的任务计数。
+ `WaitingActions` – 数字（整数）。

  指示工作流运行中处于 WAITING 状态的任务运行计数。

## StartingEventBatchCondition 结构
<a name="aws-glue-api-workflow-StartingEventBatchCondition"></a>

启动工作流运行的批处理条件。批处理大小中的事件数到达（在这种情况下，BatchSize 成员为非零），或批处理时间已过期（在这种情况下，BatchWindow 成员为非零）。

**字段**
+ `BatchSize` – 数字（整数）。

  批处理中的事件数。
+ `BatchWindow` – 数字（整数）。

  批处理时间的持续时间，以秒为单位。

## Blueprint 结构
<a name="aws-glue-api-workflow-Blueprint"></a>

蓝图的详细信息。

**字段**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。

  蓝图的名称。
+ `Description` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节。

  蓝图的描述。
+ `CreatedOn` – 时间戳。

  蓝图的注册日期和时间。
+ `LastModifiedOn` – 时间戳。

  蓝图的上次修改日期和时间。
+ `ParameterSpec` – UTF-8 字符串，长度不少于 1 个字节或超过 131072 个字节。

  指示蓝图参数规范列表的 JSON 字符串。
+ `BlueprintLocation` – UTF-8 字符串。

  指定 Amazon S3 中发布蓝图的路径。
+ `BlueprintServiceLocation` – UTF-8 字符串。

  当您调用 `CreateBlueprint/UpdateBlueprint` 将蓝图注册到 AWS Glue 时，指定 Amazon S3 中复制蓝图的路径。
+ `Status` – UTF-8 字符串（有效值：`CREATING` \$1 `ACTIVE` \$1 `UPDATING` \$1 `FAILED`）。

  蓝图注册的状态。
  + 正在创建 – 正在进行蓝图注册。
  + 激活 – 蓝图已成功注册。
  + 正在更新 – 正在更新蓝图注册。
  + 失败 – 蓝图注册失败。
+ `ErrorMessage` – UTF-8 字符串。

  错误消息。
+ `LastActiveDefinition` – 一个 [LastActiveDefinition](#aws-glue-api-workflow-LastActiveDefinition) 对象。

  如果蓝图有多个版本，且最新版本出现一些错误，则此属性指示该服务可用的最后一个成功的蓝图定义。

## BlueprintDetails 结构
<a name="aws-glue-api-workflow-BlueprintDetails"></a>

蓝图的详细信息。

**字段**
+ `BlueprintName` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。

  蓝图的名称。
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  此蓝图的运行 ID。

## LastActiveDefinition 结构
<a name="aws-glue-api-workflow-LastActiveDefinition"></a>

如果蓝图有多个版本，且最新版本出现一些错误，则此属性指示该服务可用的最后一个成功的蓝图定义。

**字段**
+ `Description` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节。

  蓝图的描述。
+ `LastModifiedOn` – 时间戳。

  蓝图的上次修改日期和时间。
+ `ParameterSpec` – UTF-8 字符串，长度不少于 1 个字节或超过 131072 个字节。

  指定蓝图参数的 JSON 字符串。
+ `BlueprintLocation` – UTF-8 字符串。

  指定 Amazon S3 中由 AWS Glue 开发人员发布的蓝图的路径。
+ `BlueprintServiceLocation` – UTF-8 字符串。

  当您创建或更新蓝图时，指定 Amazon S3 中复制蓝图的路径。

## BlueprintRun 结构
<a name="aws-glue-api-workflow-BlueprintRun"></a>

蓝图运行的详细信息。

**字段**
+ `BlueprintName` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。

  蓝图的名称。
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  此蓝图运行的运行 ID。
+ `WorkflowName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  因蓝图运行成功而创建的工作流的名称。如果蓝图运行出现错误，则不会创建工作流。
+ `State` – UTF-8 字符串（有效值：`RUNNING` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `ROLLING_BACK`）。

  蓝图运行的状态。可能的值有：
  + 正在运行 – 正在进行蓝图运行。
  + 成功 – 蓝图运行已成功完成。
  + 失败 – 蓝图运行失败，已完成回滚。
  + 回滚 – 蓝图运行失败，正在回滚。
+ `StartedOn` – 时间戳。

  蓝图运行的开始日期和时间。
+ `CompletedOn` – 时间戳。

  蓝图运行的完成日期和时间。
+ `ErrorMessage` – UTF-8 字符串。

  表示运行蓝图时出现的任何错误。
+ `RollbackErrorMessage` – UTF-8 字符串。

  如果在创建工作流实体时出现任何错误，我们会尝试回滚至创建实体的该点，然后将实体删除。此属性指示尝试删除创建的实体时出现的错误。
+ `Parameters` – UTF-8 字符串，长度不少于 1 个字节或超过 131072 个字节。

  以字符串形式显示的蓝图参数。您必须为 `Blueprint$ParameterSpec` 中定义的参数规范所需的每个键提供一个值。
+ `RoleArn` – UTF-8 字符串，不少于 1 个字节或超过 1024 个字节，与 [Custom string pattern #30](aws-glue-api-common.md#regex_30) 匹配。

  角色 ARN。此角色将由 AWS Glue 服务代入，并将用于创建工作流和工作流的其他实体。

## 操作
<a name="aws-glue-api-workflow-actions"></a>
+ [CreateWorkflow 操作（Python：create\$1workflow）](#aws-glue-api-workflow-CreateWorkflow)
+ [UpdateWorkflow 操作（Python：update\$1workflow）](#aws-glue-api-workflow-UpdateWorkflow)
+ [DeleteWorkflow 操作（Python：delete\$1workflow）](#aws-glue-api-workflow-DeleteWorkflow)
+ [GetWorkflow 操作（Python：get\$1workflow）](#aws-glue-api-workflow-GetWorkflow)
+ [ListWorkflows 操作（Python：list\$1workflows）](#aws-glue-api-workflow-ListWorkflows)
+ [BatchGetWorkflows 操作（Python：batch\$1get\$1workflows）](#aws-glue-api-workflow-BatchGetWorkflows)
+ [GetWorkflowRun 操作（Python：get\$1workflow\$1run）](#aws-glue-api-workflow-GetWorkflowRun)
+ [GetWorkflowRuns 操作（Python：get\$1workflow\$1runs）](#aws-glue-api-workflow-GetWorkflowRuns)
+ [GetWorkflowRunProperties 操作（Python：get\$1workflow\$1run\$1properties）](#aws-glue-api-workflow-GetWorkflowRunProperties)
+ [PutWorkflowRunProperties 操作（Python：put\$1workflow\$1run\$1properties）](#aws-glue-api-workflow-PutWorkflowRunProperties)
+ [CreateBlueprint 操作（Python：create\$1blueprint）](#aws-glue-api-workflow-CreateBlueprint)
+ [UpdateBlueprint 操作（Python：update\$1blueprint）](#aws-glue-api-workflow-UpdateBlueprint)
+ [DeleteBlueprint 操作（Python：delete\$1blueprint）](#aws-glue-api-workflow-DeleteBlueprint)
+ [ListBlueprints 操作（Python：list\$1blueprint）](#aws-glue-api-workflow-ListBlueprints)
+ [BatchGetBlueprints 操作（Python：batch\$1get\$1blueprints）](#aws-glue-api-workflow-BatchGetBlueprints)
+ [StartBlueprintRun 操作（Python：start\$1blueprint\$1run）](#aws-glue-api-workflow-StartBlueprintRun)
+ [GetBlueprintRun 操作（Python：get\$1blueprint\$1run）](#aws-glue-api-workflow-GetBlueprintRun)
+ [GetBlueprintRuns 操作（Python：get\$1blueprint\$1runs）](#aws-glue-api-workflow-GetBlueprintRuns)
+ [StartWorkflowRun 操作（Python：start\$1workflow\$1run）](#aws-glue-api-workflow-StartWorkflowRun)
+ [StopWorkflowRun 操作（Python：stop\$1workflow\$1run）](#aws-glue-api-workflow-StopWorkflowRun)
+ [ResumeWorkflowRun 操作（Python：resume\$1workflow\$1run）](#aws-glue-api-workflow-ResumeWorkflowRun)

## CreateWorkflow 操作（Python：create\$1workflow）
<a name="aws-glue-api-workflow-CreateWorkflow"></a>

创建新的工作流程。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要向工作流程分配的名称。它应在您的账户中是唯一的。
+ `Description` – UTF-8 字符串，长度不超过 12 万个字节。

  工作流程的描述。
+ `DefaultRunProperties` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  每个值是一个 UTF-8 字符串。

  要用作每个工作流程执行的一部分的属性的集合。

  可能会记录运行属性。不要将明文密钥作为属性传递。如果要在工作流运行内使用密钥，请通过 AWS Glue 连接、AWS Secrets Manager 或其他密钥管理机制检索密钥。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  要用于此工作流程的标签。
+ `MaxConcurrentRuns` – 数字（整数）。

  您可以使用此参数防止系统对数据进行多次不必要的更新，来控制成本，或者在某些情况下，防止系统超过任何组件任务的最大并发运行次数。如果您将此参数留空，则系统对并发工作流运行的次数没有限制。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  作为请求的一部分提供的工作流程的名称。

**错误**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentModificationException`

## UpdateWorkflow 操作（Python：update\$1workflow）
<a name="aws-glue-api-workflow-UpdateWorkflow"></a>

更新现有工作流程。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要更新的工作流程的名称。
+ `Description` – UTF-8 字符串，长度不超过 12 万个字节。

  工作流程的描述。
+ `DefaultRunProperties` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  每个值是一个 UTF-8 字符串。

  要用作每个工作流程执行的一部分的属性的集合。

  可能会记录运行属性。不要将明文密钥作为属性传递。如果要在工作流运行内使用密钥，请通过 AWS Glue 连接、AWS Secrets Manager 或其他密钥管理机制检索密钥。
+ `MaxConcurrentRuns` – 数字（整数）。

  您可以使用此参数防止系统对数据进行多次不必要的更新，来控制成本，或者在某些情况下，防止系统超过任何组件任务的最大并发运行次数。如果您将此参数留空，则系统对并发工作流运行的次数没有限制。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  输入中指定的工作流程的名称。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`

## DeleteWorkflow 操作（Python：delete\$1workflow）
<a name="aws-glue-api-workflow-DeleteWorkflow"></a>

删除工作流程。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的工作流程的名称。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  输入中指定的工作流程的名称。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`

## GetWorkflow 操作（Python：get\$1workflow）
<a name="aws-glue-api-workflow-GetWorkflow"></a>

检索工作流程的资源元数据。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索的工作流程的名称。
+ `IncludeGraph` – 布尔值。

  指定在返回工作流程资源元数据时是否包含图表。

**响应**
+ `Workflow` – 一个 [工作流](#aws-glue-api-workflow-Workflow) 对象。

  工作流程的资源元数据。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## ListWorkflows 操作（Python：list\$1workflows）
<a name="aws-glue-api-workflow-ListWorkflows"></a>

列出账户中创建的工作流程的名称。

**请求**
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果这是延续请求)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 25。

  要返回的列表的最大大小。

**响应**
+ `Workflows` – UTF-8 字符串数组，不少于 1 个或不超过 25 个字符串。

  账户中工作流程的名称的列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌（如果尚未返回所有工作流程名称）。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## BatchGetWorkflows 操作（Python：batch\$1get\$1workflows）
<a name="aws-glue-api-workflow-BatchGetWorkflows"></a>

返回一系列给定工作流程名称的资源元数据列表。调用 `ListWorkflows` 操作后，您可以调用此操作来访问您有权访问的数据。此操作支持所有 IAM 权限，包括使用标签的权限条件。

**请求**
+ `Names` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 25 个字符串。

  触发器名称的列表，这些名称可能是通过 `ListWorkflows` 操作返回的名称。
+ `IncludeGraph` – 布尔值。

  指定在返回工作流程资源元数据时是否包含图表。

**响应**
+ `Workflows` – [工作流](#aws-glue-api-workflow-Workflow)对象的数组，不少于 1 个或不超过 25 个结构。

  工作流程资源元数据的列表。
+ `MissingWorkflows` – UTF-8 字符串数组，不少于 1 个或不超过 25 个字符串。

  未找到工作流程名称的列表。

**错误**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## GetWorkflowRun 操作（Python：get\$1workflow\$1run）
<a name="aws-glue-api-workflow-GetWorkflowRun"></a>

检索给定工作流程运行的元数据。您可以在 90 天内访问工作流和任务运行的任务运行历史记录。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要运行的工作流程的名称。
+ `RunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  工作流程运行的 ID。
+ `IncludeGraph` – 布尔值。

  指定是否在响应中包含工作流程图表。

**响应**
+ `Run` – 一个 [WorkflowRun](#aws-glue-api-workflow-WorkflowRun) 对象。

  请求的工作流程运行元数据。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## GetWorkflowRuns 操作（Python：get\$1workflow\$1runs）
<a name="aws-glue-api-workflow-GetWorkflowRuns"></a>

检索给定工作流程的所有运行的元数据。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要返回其运行元数据的工作流程的名称。
+ `IncludeGraph` – 布尔值。

  指定是否在响应中包含工作流程图表。
+ `NextToken` – UTF-8 字符串。

  响应的最大大小。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要包含在响应中的工作流程运行的最大数目。

**响应**
+ `Runs` – [WorkflowRun](#aws-glue-api-workflow-WorkflowRun)对象的数组，不少于 1 个或不超过 1000 个结构。

  工作流程运行元数据对象的列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌（如果尚未返回所有请求的工作流程运行）。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## GetWorkflowRunProperties 操作（Python：get\$1workflow\$1run\$1properties）
<a name="aws-glue-api-workflow-GetWorkflowRunProperties"></a>

检索运行期间已测试的工作流程运行属性。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  已运行的工作流程的名称。
+ `RunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  应返回其运行属性的工作流程运行的 ID。

**响应**
+ `RunProperties` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  每个值是一个 UTF-8 字符串。

  指定运行期间已测试的工作流程运行属性。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## PutWorkflowRunProperties 操作（Python：put\$1workflow\$1run\$1properties）
<a name="aws-glue-api-workflow-PutWorkflowRunProperties"></a>

为给定工作流程运行放置指定的工作流程运行属性。如果指定的运行中已存在属性，则重写该值，否则将该属性添加到现有属性。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  已运行的工作流程的名称。
+ `RunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  应更新其运行属性的工作流程运行的 ID。
+ `RunProperties` – *必填*：键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  每个值是一个 UTF-8 字符串。

  为指定的运行放置的属性。

  可能会记录运行属性。不要将明文密钥作为属性传递。如果要在工作流运行内使用密钥，请通过 AWS Glue 连接、AWS Secrets Manager 或其他密钥管理机制检索密钥。

**响应**
+ *无响应参数。*

**错误**
+ `AlreadyExistsException`
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentModificationException`

## CreateBlueprint 操作（Python：create\$1blueprint）
<a name="aws-glue-api-workflow-CreateBlueprint"></a>

在 AWS Glue 中注册蓝图。

**请求**
+ `Name` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。

  蓝图的名称。
+ `Description` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节。

  蓝图的描述。
+ `BlueprintLocation` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 8192 个字节，与 [Custom string pattern #32](aws-glue-api-common.md#regex_32) 匹配。

  指定 Amazon S3 中发布蓝图的路径。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  应用于此蓝图的标签。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  返回已注册的蓝图的名称。

**错误**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ResourceNumberLimitExceededException`

## UpdateBlueprint 操作（Python：update\$1blueprint）
<a name="aws-glue-api-workflow-UpdateBlueprint"></a>

更新已注册的蓝图。

**请求**
+ `Name` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。

  蓝图的名称。
+ `Description` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节。

  蓝图的描述。
+ `BlueprintLocation` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 8192 个字节，与 [Custom string pattern #32](aws-glue-api-common.md#regex_32) 匹配。

  指定 Amazon S3 中发布蓝图的路径。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  返回已更新的蓝图的名称。

**错误**
+ `EntityNotFoundException`
+ `ConcurrentModificationException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `IllegalBlueprintStateException`

## DeleteBlueprint 操作（Python：delete\$1blueprint）
<a name="aws-glue-api-workflow-DeleteBlueprint"></a>

删除现有蓝图。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的蓝图的名称。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  返回已删除的蓝图的名称。

**错误**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## ListBlueprints 操作（Python：list\$1blueprint）
<a name="aws-glue-api-workflow-ListBlueprints"></a>

列出账户中的所有蓝图名称。

**请求**
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果这是延续请求)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 25。

  要返回的列表的最大大小。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  通过 AWS 资源标签筛选列表。

**响应**
+ `Blueprints` – UTF-8 字符串数组。

  账户中蓝图的名称列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌（如果所有蓝图名称尚未返回）。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## BatchGetBlueprints 操作（Python：batch\$1get\$1blueprints）
<a name="aws-glue-api-workflow-BatchGetBlueprints"></a>

检索有关蓝图列表的信息。

**请求**
+ `Names` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 25 个字符串。

  蓝图名称的列表。
+ `IncludeBlueprint` – 布尔值。

  指定是否在响应中包含蓝图。
+ `IncludeParameterSpec` – 布尔值。

  指定是否在响应中包含蓝图的参数（作为 JSON 字符串）。

**响应**
+ `Blueprints` – [Blueprint](#aws-glue-api-workflow-Blueprint) 对象的数组。

  返回作为 `Blueprints` 对象的蓝图列表。
+ `MissingBlueprints` – UTF-8 字符串数组。

  返回未找到的 `BlueprintNames`。

**错误**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## StartBlueprintRun 操作（Python：start\$1blueprint\$1run）
<a name="aws-glue-api-workflow-StartBlueprintRun"></a>

启动指定的蓝图的新运行。

**请求**
+ `BlueprintName` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。

  蓝图的名称。
+ `Parameters` – UTF-8 字符串，长度不少于 1 个字节或超过 131072 个字节。

  指定作为 `BlueprintParameters` 对象的参数。
+ `RoleArn` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 1024 个字节，与 [Custom string pattern #30](aws-glue-api-common.md#regex_30) 匹配。

  指定用于创建工作流的 IAM 角色。

**响应**
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  此蓝图运行的运行 ID。

**错误**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ResourceNumberLimitExceededException`
+ `EntityNotFoundException`
+ `IllegalBlueprintStateException`

## GetBlueprintRun 操作（Python：get\$1blueprint\$1run）
<a name="aws-glue-api-workflow-GetBlueprintRun"></a>

检索蓝图运行的详细信息。

**请求**
+ `BlueprintName` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。

  蓝图的名称。
+ `RunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索的蓝图运行的运行 ID。

**响应**
+ `BlueprintRun` – 一个 [BlueprintRun](#aws-glue-api-workflow-BlueprintRun) 对象。

  返回 `BlueprintRun` 对象。

**错误**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## GetBlueprintRuns 操作（Python：get\$1blueprint\$1runs）
<a name="aws-glue-api-workflow-GetBlueprintRuns"></a>

检索指定蓝图的蓝图运行详细信息。

**请求**
+ `BlueprintName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  蓝图的名称。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果这是延续请求)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的列表的最大大小。

**响应**
+ `BlueprintRuns` – [BlueprintRun](#aws-glue-api-workflow-BlueprintRun) 对象的数组。

  返回 `BlueprintRun` 对象的列表。
+ `NextToken` – UTF-8 字符串。

  延续令牌（如果所有请求的蓝图运行尚未返回）。

**错误**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## StartWorkflowRun 操作（Python：start\$1workflow\$1run）
<a name="aws-glue-api-workflow-StartWorkflowRun"></a>

启动指定的工作流程的新运行。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要启动的工作流程的名称。
+ `RunProperties` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  每个值是一个 UTF-8 字符串。

  新工作流运行的工作流运行属性。

  可能会记录运行属性。不要将明文密钥作为属性传递。如果要在工作流运行内使用密钥，请通过 AWS Glue 连接、AWS Secrets Manager 或其他密钥管理机制检索密钥。

**响应**
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  新运行的 ID。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentRunsExceededException`

## StopWorkflowRun 操作（Python：stop\$1workflow\$1run）
<a name="aws-glue-api-workflow-StopWorkflowRun"></a>

停止执行指定的工作流程运行。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要停止的工作流程的名称。
+ `RunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要停止的工作流程运行的 ID。

**响应**
+ *无响应参数。*

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `IllegalWorkflowStateException`

## ResumeWorkflowRun 操作（Python：resume\$1workflow\$1run）
<a name="aws-glue-api-workflow-ResumeWorkflowRun"></a>

重新启动上一个部分完成的工作流运行的选定节点，并恢复工作流运行。然后，所选节点以及这些节点下游的所有节点就会运行。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索的工作流的名称。
+ `RunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要停止的工作流运行的 ID。
+ `NodeIds` – *必填*：UTF-8 字符串数组。

  要重新启动的节点的节点 ID 的列表。要重新启动的节点必须在原始运行中尝试运行。

**响应**
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  分配给恢复的工作流运行的新 ID。工作流运行的每个恢复都将有一个新的运行 ID。
+ `NodeIds` – UTF-8 字符串数组。

  实际重新启动的节点的节点 ID 列表。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentRunsExceededException`
+ `IllegalWorkflowStateException`

# 使用情况配置文件
<a name="aws-glue-api-usage-profiles"></a>

使用情况配置文件 API 介绍与在 AWS Glue 中创建、更新或查看使用情况配置文件相关的数据类型和 API。

## 数据类型
<a name="aws-glue-api-usage-profiles-objects"></a>
+ [ProfileConfiguration 结构](#aws-glue-api-usage-profiles-ProfileConfiguration)
+ [ConfigurationObject 结构](#aws-glue-api-usage-profiles-ConfigurationObject)
+ [UsageProfileDefinition 结构](#aws-glue-api-usage-profiles-UsageProfileDefinition)

## ProfileConfiguration 结构
<a name="aws-glue-api-usage-profiles-ProfileConfiguration"></a>

指定管理员在 AWS Glue 使用情况配置文件中配置的任务和会话值。

**字段**
+ `SessionConfiguration` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  每个值都是一个 [ConfigurationObject](#aws-glue-api-usage-profiles-ConfigurationObject) 对象。

  配置 AWS Glue 会话参数的键值映射。
+ `JobConfiguration` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  每个值都是一个 [ConfigurationObject](#aws-glue-api-usage-profiles-ConfigurationObject) 对象。

  配置 AWS Glue 任务参数的键值映射。

## ConfigurationObject 结构
<a name="aws-glue-api-usage-profiles-ConfigurationObject"></a>

指定管理员为 AWS Glue 使用情况配置文件中配置的每个任务或会话参数设置的值。

**字段**
+ `DefaultValue` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #35](aws-glue-api-common.md#regex_35) 匹配。

  参数的默认值。
+ `AllowedValues` – UTF-8 字符串数组。

  参数允许的值的列表。
+ `MinValue` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #35](aws-glue-api-common.md#regex_35) 匹配。

  参数允许的最小值。
+ `MaxValue` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #35](aws-glue-api-common.md#regex_35) 匹配。

  参数允许的最大值。

## UsageProfileDefinition 结构
<a name="aws-glue-api-usage-profiles-UsageProfileDefinition"></a>

描述 AWS Glue 使用情况配置文件。

**字段**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  使用情况配置文件的名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  使用情况配置文件的描述。
+ `CreatedOn` – 时间戳。

  使用情况配置文件创建的日期和时间。
+ `LastModifiedOn` – 时间戳。

  使用情况配置文件上次修改的日期和时间。

## 操作
<a name="aws-glue-api-usage-profiles-actions"></a>
+ [CreateUsageProfile 操作（Python：create\$1usage\$1profile）](#aws-glue-api-usage-profiles-CreateUsageProfile)
+ [GetUsageProfile 操作（Python：get\$1usage\$1profile）](#aws-glue-api-usage-profiles-GetUsageProfile)
+ [UpdateUsageProfile 操作（Python：update\$1usage\$1profile）](#aws-glue-api-usage-profiles-UpdateUsageProfile)
+ [DeleteUsageProfile 操作（Python：delete\$1usage\$1profile）](#aws-glue-api-usage-profiles-DeleteUsageProfile)
+ [ListUsageProfiles 操作（Python：list\$1usage\$1profile）](#aws-glue-api-usage-profiles-ListUsageProfiles)

## CreateUsageProfile 操作（Python：create\$1usage\$1profile）
<a name="aws-glue-api-usage-profiles-CreateUsageProfile"></a>

创建 AWS Glue 使用情况配置文件。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  使用情况配置文件的名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  使用情况配置文件的描述。
+ `Configuration` – *必填：*一个 [ProfileConfiguration](#aws-glue-api-usage-profiles-ProfileConfiguration) 对象。

  `ProfileConfiguration` 对象，用于指定配置文件的任务和会话值。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  应用于用使用情况配置文件的标签列表。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  创建的使用情况配置文件的名称。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `AlreadyExistsException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `OperationNotSupportedException`

## GetUsageProfile 操作（Python：get\$1usage\$1profile）
<a name="aws-glue-api-usage-profiles-GetUsageProfile"></a>

检索有关指定 AWS Glue 使用情况配置文件的信息。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索的使用情况配置文件的名称。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  使用情况配置文件的名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  使用情况配置文件的描述。
+ `Configuration` – 一个 [ProfileConfiguration](#aws-glue-api-usage-profiles-ProfileConfiguration) 对象。

  `ProfileConfiguration` 对象，用于指定配置文件的任务和会话值。
+ `CreatedOn` – 时间戳。

  使用情况配置文件创建的日期和时间。
+ `LastModifiedOn` – 时间戳。

  使用情况配置文件上次修改的日期和时间。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `OperationNotSupportedException`

## UpdateUsageProfile 操作（Python：update\$1usage\$1profile）
<a name="aws-glue-api-usage-profiles-UpdateUsageProfile"></a>

更新 AWS Glue 使用情况配置文件。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  使用情况配置文件的名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  使用情况配置文件的描述。
+ `Configuration` – *必填：*一个 [ProfileConfiguration](#aws-glue-api-usage-profiles-ProfileConfiguration) 对象。

  `ProfileConfiguration` 对象，用于指定配置文件的任务和会话值。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  已更新的使用情况配置文件的名称。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `OperationNotSupportedException`
+ `ConcurrentModificationException`

## DeleteUsageProfile 操作（Python：delete\$1usage\$1profile）
<a name="aws-glue-api-usage-profiles-DeleteUsageProfile"></a>

删除 AWS Glue 指定使用情况配置文件。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的使用情况配置文件的名称。

**响应**
+ *无响应参数。*

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `OperationNotSupportedException`

## ListUsageProfiles 操作（Python：list\$1usage\$1profile）
<a name="aws-glue-api-usage-profiles-ListUsageProfiles"></a>

列出所有 AWS Glue 使用情况配置文件。

**请求**
+ `NextToken` – UTF-8 字符串，长度不超过 400000 个字节。

  延续标记 (如果这是延续调用，则包括)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 200。

  要在单个响应中返回的使用情况配置文件的最大数量。

**响应**
+ `Profiles` – [UsageProfileDefinition](#aws-glue-api-usage-profiles-UsageProfileDefinition) 对象的数组。

  使用情况配置文件 (`UsageProfileDefinition`) 对象的列表。
+ `NextToken` – UTF-8 字符串，长度不超过 400000 个字节。

  延续令牌 (如果当前列表片段不是最后一个，则呈现)。

**错误**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `OperationNotSupportedException`

# 机器学习 API
<a name="aws-glue-api-machine-learning-api"></a>

机器学习 API 描述了机器学习数据类型，并包括用于创建、删除或更新转换或启动机器学习任务运行的 API。

## 数据类型
<a name="aws-glue-api-machine-learning-api-objects"></a>
+ [TransformParameters 结构](#aws-glue-api-machine-learning-api-TransformParameters)
+ [EvaluationMetrics 结构](#aws-glue-api-machine-learning-api-EvaluationMetrics)
+ [MLTransform 结构](#aws-glue-api-machine-learning-api-MLTransform)
+ [FindMatchesParameters 结构](#aws-glue-api-machine-learning-api-FindMatchesParameters)
+ [FindMatchesMetrics 结构](#aws-glue-api-machine-learning-api-FindMatchesMetrics)
+ [ConfusionMatrix 结构](#aws-glue-api-machine-learning-api-ConfusionMatrix)
+ [GlueTable 结构](#aws-glue-api-machine-learning-api-GlueTable)
+ [TaskRun 结构](#aws-glue-api-machine-learning-api-TaskRun)
+ [TransformFilterCriteria 结构](#aws-glue-api-machine-learning-api-TransformFilterCriteria)
+ [TransformSortCriteria 结构](#aws-glue-api-machine-learning-api-TransformSortCriteria)
+ [TaskRunFilterCriteria 结构](#aws-glue-api-machine-learning-api-TaskRunFilterCriteria)
+ [TaskRunSortCriteria 结构](#aws-glue-api-machine-learning-api-TaskRunSortCriteria)
+ [TaskRunProperties 结构](#aws-glue-api-machine-learning-api-TaskRunProperties)
+ [FindMatchesTaskRunProperties 结构](#aws-glue-api-machine-learning-api-FindMatchesTaskRunProperties)
+ [ImportLabelsTaskRunProperties 结构](#aws-glue-api-machine-learning-api-ImportLabelsTaskRunProperties)
+ [ExportLabelsTaskRunProperties 结构](#aws-glue-api-machine-learning-api-ExportLabelsTaskRunProperties)
+ [LabelingSetGenerationTaskRunProperties 结构](#aws-glue-api-machine-learning-api-LabelingSetGenerationTaskRunProperties)
+ [SchemaColumn 结构](#aws-glue-api-machine-learning-api-SchemaColumn)
+ [TransformEncryption 结构](#aws-glue-api-machine-learning-api-TransformEncryption)
+ [MLUserDataEncryption 结构](#aws-glue-api-machine-learning-api-MLUserDataEncryption)
+ [ColumnImportance 结构](#aws-glue-api-machine-learning-api-ColumnImportance)

## TransformParameters 结构
<a name="aws-glue-api-machine-learning-api-TransformParameters"></a>

与机器学习转换关联的特定于算法的参数。

**Fields**
+ `TransformType` – *必填*：UTF-8 字符串（有效值：`FIND_MATCHES`）。

  机器学习转换的类型

  有关机器学习转换的类型的信息，请参阅 [创建 Machine Learning 转换](https://docs.aws.amazon.com/glue/latest/dg/add-job-machine-learning-transform.html)。
+ `FindMatchesParameters` – 一个 [FindMatchesParameters](#aws-glue-api-machine-learning-api-FindMatchesParameters) 对象。

  查找匹配算法的参数。

## EvaluationMetrics 结构
<a name="aws-glue-api-machine-learning-api-EvaluationMetrics"></a>

评估指标提供机器学习转换的质量估计值。

**Fields**
+ `TransformType` – *必填*：UTF-8 字符串（有效值：`FIND_MATCHES`）。

  机器学习转换的类型
+ `FindMatchesMetrics` – 一个 [FindMatchesMetrics](#aws-glue-api-machine-learning-api-FindMatchesMetrics) 对象。

  查找匹配算法的评估指标。

## MLTransform 结构
<a name="aws-glue-api-machine-learning-api-MLTransform"></a>

机器学习转换的结构。

**Fields**
+ `TransformId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  为机器学习转换生成的唯一转换 ID。ID 保证唯一性，不会改变。
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  机器学习转换的用户定义的名称。名称不保证唯一性，可随时更改。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  机器学习转换的用户定义的长格式描述文本。描述不保证唯一性，可随时更改。
+ `Status` – UTF-8 字符串（有效值：`NOT_READY` \$1`READY` \$1`DELETING` ）。

  机器学习转换的当前状态。
+ `CreatedOn` – 时间戳。

  时间戳。此机器学习转换的创建时间和日期。
+ `LastModifiedOn` – 时间戳。

  时间戳。此机器学习转换的最后一个修改时间点。
+ `InputRecordTables` – [GlueTable](#aws-glue-api-machine-learning-api-GlueTable) 对象的数组，不超过 10 个结构。

  转换使用的 AWS Glue 表定义的列表。
+ `Parameters` – 一个 [TransformParameters](#aws-glue-api-machine-learning-api-TransformParameters) 对象。

  一个 `TransformParameters` 对象。您可以使用参数来优化（自定义）机器学习转换的行为，方法是指定它从哪些数据中学习，以及您对各种权衡的偏好（例如精确率与召回率，或准确度与成本）。
+ `EvaluationMetrics` – 一个 [EvaluationMetrics](#aws-glue-api-machine-learning-api-EvaluationMetrics) 对象。

  一个 `EvaluationMetrics` 对象。评估指标提供机器学习转换的质量估计值。
+ `LabelCount` – 数字（整数）。

  对于此转换由 AWS Glue 生成的标签文件的计数标识符。要创建更好的转换，您可以迭代方式下载、标注和上载标签文件。
+ `Schema` – [SchemaColumn](#aws-glue-api-machine-learning-api-SchemaColumn) 对象的数组，不超过 100 个结构。

  键值对的映射表示该转换可针对的列和数据类型。具有 100 列的上限。
+ `Role` – UTF-8 字符串。

  具有所需权限的 IAM 角色的名称或 Amazon Resource Name（ARN）。所需权限包括 AWS Glue 资源的 AWS Glue 服务角色权限和转换所需的 Amazon S3 权限。
  + 此角色需要 AWS Glue 服务角色权限才能允许访问 AWS Glue 中的资源。请参阅[将策略附加到访问 AWS Glue 的 IAM 用户](https://docs.aws.amazon.com/glue/latest/dg/attach-policy-iam-user.html)。
  + 此角色需要对您的 Amazon Simple Storage Service (Amazon S3) 源、目标、临时目录、脚本以及此转换的任务运行所使用的任何库的权限。
+ `GlueVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #48](aws-glue-api-common.md#regex_48) 匹配。

  此值确定与此机器学习转换兼容的 AWS Glue 版本。建议大多数用户使用 Glue 1.0。如果未设置此值，则 Glue 兼容性默认为 Glue 0.9。有关更多信息，请参阅开发人员指南中的 [AWS Glue 版本](https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions)。
+ `MaxCapacity` – 数字（double）。

  分配给此转换的任务运行的 AWS Glue 数据处理单元（DPU）的数量。您可以分配 2 到 100 个 DPU；默认值为 10。DPU 是对处理能力的相对度量，它由 4 个 vCPU 的计算容量和 16GB 内存组成。有关更多信息，请参阅 [AWS Glue 价格页面](https://aws.amazon.com/glue/pricing/)。

  `MaxCapacity` 是具有 `NumberOfWorkers` 和 `WorkerType` 的互斥选项。
  + 如果已设置 `NumberOfWorkers` 或 `WorkerType`，则不能设置 `MaxCapacity`。
  + 如果已设置 `MaxCapacity`，则不能设置 `NumberOfWorkers` 或 `WorkerType`。
  + 如果已设置 `WorkerType`，则 `NumberOfWorkers` 为必填项（反之亦然）。
  + `MaxCapacity` 和 `NumberOfWorkers` 都必须至少为 1。

  在将 `WorkerType` 字段设置为 `Standard` 之外的值时，`MaxCapacity` 字段将自动设置并变为只读。
+ `WorkerType` – UTF-8 字符串（有效值：`Standard=""` \$1`G.1X=""` \$1`G.2X=""` \$1`G.025X=""` \$1`G.4X=""` \$1`G.8X=""` \$1`Z.2X=""` ）。

  在此转换的任务运行时分配的预定义工作线程的类型。接受的值为 Standard、G.1X 或 G.2X。
  + 对于 `Standard` 工作线程类型，每个工作线程提供 4 个 vCPU、16 GB 内存和 50GB 磁盘，并且每个工作线程提供 2 个执行器。
  + 对于 `G.1X` 工作线程类型，每个工作线程提供 4 个 vCPU、16 GB 内存和 64GB 磁盘，并且每个工作线程提供 1 个执行器。
  + 对于 `G.2X` 工作线程类型，每个工作线程提供 84 个 vCPU、32 GB 内存和 128GB 磁盘，并且每个工作线程提供 1 个执行器。

  `MaxCapacity` 是具有 `NumberOfWorkers` 和 `WorkerType` 的互斥选项。
  + 如果已设置 `NumberOfWorkers` 或 `WorkerType`，则不能设置 `MaxCapacity`。
  + 如果已设置 `MaxCapacity`，则不能设置 `NumberOfWorkers` 或 `WorkerType`。
  + 如果已设置 `WorkerType`，则 `NumberOfWorkers` 为必填项（反之亦然）。
  + `MaxCapacity` 和 `NumberOfWorkers` 都必须至少为 1。
+ `NumberOfWorkers` – 数字（整数）。

  在转换的任务运行时分配的已定义 `workerType` 的工作线程数。

  如果已设置 `WorkerType`，则 `NumberOfWorkers` 为必填项（反之亦然）。
+ `Timeout` - 数字（整数），至少为 1。

  机器学习转换的超时（以分钟为单位）。
+ `MaxRetries` – 数字（整数）。

  在机器学习转换的 `MLTaskRun` 失败后重试的最大次数。
+ `TransformEncryption` – 一个 [TransformEncryption](#aws-glue-api-machine-learning-api-TransformEncryption) 对象。

  应用于访问用户数据的转换的静态加密设置。机器学习转换可以访问在 Amazon S3 中使用 KMS 加密的用户数据。

## FindMatchesParameters 结构
<a name="aws-glue-api-machine-learning-api-FindMatchesParameters"></a>

用于配置查找匹配项转换的参数。

**Fields**
+ `PrimaryKeyColumnName` – UTF-8 字符串，不少于 1 个字节或超过 1024 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  唯一标识源表中的行的列名称。用于帮助标识匹配的记录。
+ `PrecisionRecallTradeoff` – 数字（双数），不超过 1.0。

  调整转换以在查准率与查全率之间取得平衡时选择的值。值 0.5 表示没有首选项；值 1.0 表示纯粹因精确率而产生的偏差，值 0.0 表示因召回率而产生的偏差。因为这是一种权衡，所以选择接近 1.0 的值表示非常低的召回率，选择接近 0.0 的值会导致非常低的精确率。

  精确率指标指示模型在预测匹配时正确的频率。

  查全率指标表示，对于实际匹配，您的模型预测匹配的频率。
+ `AccuracyCostTradeoff` – 数字（双数），不超过 1.0。

  调整转换以在准确性与成本之间取得平衡时选择的值。值 0.5 表示系统平衡准确度和成本问题。值为 1.0 表示纯粹因准确度而产生的偏差，这通常会导致成本更高，有时会高得多。值为 0.0 表示纯粹因成本而产生的偏差，这会导致 `FindMatches` 转换，有时具有不可接受的准确度。

  准确性衡量转换发现真阳性和真阴性的程度。提高准确性需要更多的机器资源和成本。但这也会导致查全率提高。

  成本衡量运行转换所消耗的计算资源（从而产生成本）的数量。
+ `EnforceProvidedLabels` – 布尔值。

  要启用或禁用的值，以强制输出与用户提供的标签相匹配。如果该值为 `True`，`find matches` 转换会强制输出来匹配提供的标注。结果将覆盖正常合并结果。如果值为 `False`，则 `find matches` 转换不能确保遵循提供的所有标签，并且结果依赖于训练后的模型。

  请注意，将此值设置为 true 可能会增加合并执行时间。

## FindMatchesMetrics 结构
<a name="aws-glue-api-machine-learning-api-FindMatchesMetrics"></a>

查找匹配算法的评估指标。通过转换预测一些匹配项并将结果与同一数据集中的已知匹配项进行比较来衡量机器学习转换的质量。质量指标基于数据的子集，因此它们并不精确。

**Fields**
+ `AreaUnderPRCurve` – 数字（双数），不超过 1.0。

  精确率与召回率曲线（AUPRC）下的区域是衡量转换整体质量的单一数字，这与精确率与召回率的选择无关。较高的值表明您具有更有吸引力的精确率与召回率权衡。

  有关更多信息，请参阅 Wikipedia 中的[查准率和查全率](https://en.wikipedia.org/wiki/Precision_and_recall)。
+ `Precision` – 数字（双数），不超过 1.0。

  精确率指标指示转换在预测匹配时正确的频率。具体而言，精确率指标衡量转换从总真阳性可能中找到真阳性的程度。

  有关更多信息，请参阅 Wikipedia 中的[查准率和查全率](https://en.wikipedia.org/wiki/Precision_and_recall)。
+ `Recall` – 数字（双数），不超过 1.0。

  召回率指标表示，对于实际匹配，转换预测匹配的频率。具体而言，召回率指标衡量转换从源数据中的总记录中找到真阳性的程度。

  有关更多信息，请参阅 Wikipedia 中的[查准率和查全率](https://en.wikipedia.org/wiki/Precision_and_recall)。
+ `F1` – 数字（双数），不超过 1.0。

  最大 F1 指标表示转换的准确度介于 0 和 1 之间，其中 1 是最大准确度。

  有关更多信息，请参阅 Wikipedia 中的 [F1 分数](https://en.wikipedia.org/wiki/F1_score)。
+ `ConfusionMatrix` – 一个 [ConfusionMatrix](#aws-glue-api-machine-learning-api-ConfusionMatrix) 对象。

  混淆矩阵显示转换正在准确预测的内容以及它正在产生的错误类型。

  有关更多信息，请参阅 Wikipedia 中的[混淆矩阵](https://en.wikipedia.org/wiki/Confusion_matrix)。
+ `ColumnImportances` – [ColumnImportance](#aws-glue-api-machine-learning-api-ColumnImportance) 对象的数组，不超过 100 个结构。

  `ColumnImportance` 结构列表，其中包含列重要性指标，按重要性降序排序。

## ConfusionMatrix 结构
<a name="aws-glue-api-machine-learning-api-ConfusionMatrix"></a>

混淆矩阵显示转换正在准确预测的内容以及它正在产生的错误类型。

有关更多信息，请参阅 Wikipedia 中的[混淆矩阵](https://en.wikipedia.org/wiki/Confusion_matrix)。

**Fields**
+ `NumTruePositives` – 数字（长型）。

  在转换的混淆矩阵中，转换正确找到的数据中的匹配项数量。
+ `NumFalsePositives` – 数字（长型）。

  在转换的混淆矩阵中，转换错误地将数据分类为匹配项的的非匹配项数量。
+ `NumTrueNegatives` – 数字（长型）。

  在转换的混淆矩阵中，转换正确拒绝的数据中的非匹配项数量。
+ `NumFalseNegatives` – 数字（长型）。

  在转换的混淆矩阵中，转换未找到的数据中的匹配项数量。

## GlueTable 结构
<a name="aws-glue-api-machine-learning-api-GlueTable"></a>

用于输入或输出数据的 AWS Glue Data Catalog 中的数据库和表。

**Fields**
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  AWS Glue Data Catalog 中的数据库名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  AWS Glue Data Catalog 中的表名称。
+ `CatalogId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  AWS Glue Data Catalog 的唯一标识符。
+ `ConnectionName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  AWS Glue Data Catalog 中的连接名称。
+ `AdditionalOptions` – 键值对的映射数组，不少于 1 对且不超过 10 对。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  每个值都是一个描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  用于表的其他选项。目前支持两个键：
  + `pushDownPredicate`：筛选分区，而不必列出并读取数据集中的所有文件。
  + `catalogPartitionPredicate`：使用 AWS Glue Data Catalog 中的分区索引来使用服务器端分区修剪。

## TaskRun 结构
<a name="aws-glue-api-machine-learning-api-TaskRun"></a>

与机器学习转换关联的采样参数。

**Fields**
+ `TransformId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  转换的唯一标识符。
+ `TaskRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  任务运行的唯一标识符。
+ `Status` – UTF-8 字符串（有效值：`RUNNING` \$1`FINISHED` \$1`FAILED` \$1`PENDING_EXECUTION` \$1`TIMED_OUT` \$1`CANCELING` \$1`CANCELED` \$1`RECEIVED_BY_TASKRUNNER` ）。

  请求任务的当前状态。
+ `LogGroupName` – UTF-8 字符串。

  用于进行安全日志记录的日志组的名称，与此任务运行关联。
+ `Properties` – 一个 [TaskRunProperties](#aws-glue-api-machine-learning-api-TaskRunProperties) 对象。

  指定与此任务运行关联的配置属性。
+ `ErrorString` – UTF-8 字符串。

  与此任务运行关联的错误字符串列表。
+ `StartedOn` – 时间戳。

  此任务运行开始的日期和时间。
+ `LastModifiedOn` – 时间戳。

  请求任务运行的最后一个时间点已更新。
+ `CompletedOn` – 时间戳。

  请求任务运行的最后一个时间点已完成。
+ `ExecutionTime` – 数字（整数）。

  任务运行使用资源的时间长度（以秒为单位）。

## TransformFilterCriteria 结构
<a name="aws-glue-api-machine-learning-api-TransformFilterCriteria"></a>

筛选机器学习转换的条件。

**Fields**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  筛选机器学习转换的唯一转换名称。
+ `TransformType` – UTF-8 字符串（有效值：`FIND_MATCHES`）。

  筛选机器学习转换的机器学习转换类型。
+ `Status` – UTF-8 字符串（有效值：`NOT_READY` \$1`READY` \$1`DELETING` ）。

  按转换的最后一个已知状态筛选机器学习转换列表（以指示是否可以使用转换）。“NOT\$1READY”、“READY”或“DELETING”之一。
+ `GlueVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #48](aws-glue-api-common.md#regex_48) 匹配。

  此值确定与此机器学习转换兼容的 AWS Glue 版本。建议大多数用户使用 Glue 1.0。如果未设置此值，则 Glue 兼容性默认为 Glue 0.9。有关更多信息，请参阅开发人员指南中的 [AWS Glue 版本](https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions)。
+ `CreatedBefore` – 时间戳。

  转换创建前的时间和日期。
+ `CreatedAfter` – 时间戳。

  转换创建后的时间和日期。
+ `LastModifiedBefore` – 时间戳。

  筛选此日期之前最后一次修改的转换。
+ `LastModifiedAfter` – 时间戳。

  筛选此日期之后最后一次修改的转换。
+ `Schema` – [SchemaColumn](#aws-glue-api-machine-learning-api-SchemaColumn) 对象的数组，不超过 100 个结构。

  筛选具有特定架构的数据集。`Map<Column, Type>` 对象是一个键值对数组，表示该转换接受的架构，其中 `Column` 是列的名称，`Type` 是数据的类型，如整数或字符串。具有 100 列的上限。

## TransformSortCriteria 结构
<a name="aws-glue-api-machine-learning-api-TransformSortCriteria"></a>

与机器学习转换关联的排序标准。

**Fields**
+ `Column` – *必填*：UTF-8 字符串（有效值：`NAME` \$1 `TRANSFORM_TYPE` \$1 `STATUS` \$1 `CREATED` \$1 `LAST_MODIFIED`）。

  在与机器学习转换关联的排序标准中所使用的列。
+ `SortDirection` – *必填：*UTF-8 字符串（有效值：`DESCENDING` \$1 `ASCENDING`）。

  在与机器学习转换关联的排序标准中所使用的排序方向。

## TaskRunFilterCriteria 结构
<a name="aws-glue-api-machine-learning-api-TaskRunFilterCriteria"></a>

筛选用于机器学习转换的任务运行的条件。

**Fields**
+ `TaskRunType` – UTF-8 字符串（有效值：`EVALUATION` \$1`LABELING_SET_GENERATION` \$1`IMPORT_LABELS` \$1`EXPORT_LABELS` \$1`FIND_MATCHES` ）。

  任务运行的类型。
+ `Status` – UTF-8 字符串（有效值：`RUNNING` \$1`FINISHED` \$1`FAILED` \$1`PENDING_EXECUTION` \$1`TIMED_OUT` \$1`CANCELING` \$1`CANCELED` \$1`RECEIVED_BY_TASKRUNNER` ）。

  任务运行的当前状态。
+ `StartedBefore` – 时间戳。

  筛选在此日期之前启动的任务运行。
+ `StartedAfter` – 时间戳。

  筛选在此日期之后启动的任务运行。

## TaskRunSortCriteria 结构
<a name="aws-glue-api-machine-learning-api-TaskRunSortCriteria"></a>

对用于机器学习转换的任务运行的列表进行排序的排序条件。

**Fields**
+ `Column` – *必填：* UTF-8 字符串（有效值：`TASK_RUN_TYPE` \$1 `STATUS` \$1 `STARTED`）。

  对用于机器学习转换的任务运行的列表进行排序的列。
+ `SortDirection` – *必填：*UTF-8 字符串（有效值：`DESCENDING` \$1 `ASCENDING`）。

  对用于机器学习转换的任务运行的列表进行排序的排序方向。

## TaskRunProperties 结构
<a name="aws-glue-api-machine-learning-api-TaskRunProperties"></a>

任务运行的配置属性。

**Fields**
+ `TaskType` – UTF-8 字符串（有效值：`EVALUATION` \$1`LABELING_SET_GENERATION` \$1`IMPORT_LABELS` \$1`EXPORT_LABELS` \$1`FIND_MATCHES` ）。

  任务运行的类型。
+ `ImportLabelsTaskRunProperties` – 一个 [ImportLabelsTaskRunProperties](#aws-glue-api-machine-learning-api-ImportLabelsTaskRunProperties) 对象。

  导入标签任务运行的配置属性。
+ `ExportLabelsTaskRunProperties` – 一个 [ExportLabelsTaskRunProperties](#aws-glue-api-machine-learning-api-ExportLabelsTaskRunProperties) 对象。

  导出标签任务运行的配置属性。
+ `LabelingSetGenerationTaskRunProperties` – 一个 [LabelingSetGenerationTaskRunProperties](#aws-glue-api-machine-learning-api-LabelingSetGenerationTaskRunProperties) 对象。

  标签集生成任务运行的配置属性。
+ `FindMatchesTaskRunProperties` – 一个 [FindMatchesTaskRunProperties](#aws-glue-api-machine-learning-api-FindMatchesTaskRunProperties) 对象。

  查找匹配项任务运行的配置属性。

## FindMatchesTaskRunProperties 结构
<a name="aws-glue-api-machine-learning-api-FindMatchesTaskRunProperties"></a>

指定“查找匹配项”任务运行的配置属性。

**Fields**
+ `JobId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  “查找匹配项”任务运行的任务 ID。
+ `JobName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于“查找匹配项”任务运行所分配给任务的名称。
+ `JobRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  “查找匹配项”任务运行的任务运行 ID。

## ImportLabelsTaskRunProperties 结构
<a name="aws-glue-api-machine-learning-api-ImportLabelsTaskRunProperties"></a>

指定导入标签任务运行的配置属性。

**Fields**
+ `InputS3Path` – UTF-8 字符串。

  您将从中导入标签的 Amazon Simple Storage Service（Amazon S3）路径。
+ `Replace` – 布尔值。

  指示是否覆盖现有标签。

## ExportLabelsTaskRunProperties 结构
<a name="aws-glue-api-machine-learning-api-ExportLabelsTaskRunProperties"></a>

指定导出标签任务运行的配置属性。

**Fields**
+ `OutputS3Path` – UTF-8 字符串。

  您将导出标签的 Amazon Simple Storage Service（Amazon S3）路径。

## LabelingSetGenerationTaskRunProperties 结构
<a name="aws-glue-api-machine-learning-api-LabelingSetGenerationTaskRunProperties"></a>

指定标签集生成任务运行的配置属性。

**Fields**
+ `OutputS3Path` – UTF-8 字符串。

  您将生成标签集的 Amazon Simple Storage Service（Amazon S3）路径。

## SchemaColumn 结构
<a name="aws-glue-api-machine-learning-api-SchemaColumn"></a>

键值对表示该转换可针对的列和数据类型。`MLTransform` 的 `Schema` 参数可能包含多达 100 个这些结构。

**Fields**
+ `Name` – UTF-8 字符串，不少于 1 个字节或超过 1024 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  列的名称。
+ `DataType` – UTF-8 字符串，不超过 131072 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  列的数据类型。

## TransformEncryption 结构
<a name="aws-glue-api-machine-learning-api-TransformEncryption"></a>

应用于访问用户数据的转换的静态加密设置。机器学习转换可以访问在 Amazon S3 中使用 KMS 加密的用户数据。

此外，导入的标签和经过训练的转换现在可以使用客户提供的 KMS 密钥进行加密。

**Fields**
+ `MlUserDataEncryption` – 一个 [MLUserDataEncryption](#aws-glue-api-machine-learning-api-MLUserDataEncryption) 对象。

  包含加密模式和客户提供的 KMS 密钥 ID 的 `MLUserDataEncryption` 对象。
+ `TaskRunSecurityConfigurationName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  安全配置的名称。

## MLUserDataEncryption 结构
<a name="aws-glue-api-machine-learning-api-MLUserDataEncryption"></a>

应用于访问用户数据的转换的静态加密设置。

**Fields**
+ `MlUserDataEncryptionMode` – *必填：*UTF-8 字符串（有效值：`DISABLED` \$1 `SSE-KMS="SSEKMS"`）。

  应用于用户数据的加密模式。有效值为：
  + DISABLED：加密已禁用
  + SSEKMS：将服务器端使用 AWS Key Management Service（SSE-KMS）进行的加密用于存储在 Amazon S3 中的用户数据。
+ `KmsKeyId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  客户提供的 KMS 密钥的 ID。

## ColumnImportance 结构
<a name="aws-glue-api-machine-learning-api-ColumnImportance"></a>

包含列名称和列重要性分数的结构。

列重要性可识别您的记录中的哪些列比其他列更重要，帮助您了解列如何对模型产生影响。

**Fields**
+ `ColumnName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  列的名称。
+ `Importance` – 数字（双数），不超过 1.0。

  列的列重要性分数（以小数形式）。

## 操作
<a name="aws-glue-api-machine-learning-api-actions"></a>
+ [CreateMLTransform 操作（Python：create\$1ml\$1transform）](#aws-glue-api-machine-learning-api-CreateMLTransform)
+ [UpdateMLTransform 操作（Python：update\$1ml\$1transform）](#aws-glue-api-machine-learning-api-UpdateMLTransform)
+ [DeleteMLTransform 操作（Python：delete\$1ml\$1transform）](#aws-glue-api-machine-learning-api-DeleteMLTransform)
+ [GetMLTransform 操作（Python：get\$1ml\$1transform）](#aws-glue-api-machine-learning-api-GetMLTransform)
+ [GetMLTransforms 操作（Python：get\$1ml\$1ransforms）](#aws-glue-api-machine-learning-api-GetMLTransforms)
+ [ListMLTransforms 操作（Python：list\$1ml\$1transforms）](#aws-glue-api-machine-learning-api-ListMLTransforms)
+ [StartMLEvaluationTaskRun 操作（Python：start\$1ml\$1evaluation\$1task\$1run）](#aws-glue-api-machine-learning-api-StartMLEvaluationTaskRun)
+ [StartMLLabelingSetGenerationTaskRun 操作（Python：start\$1ml\$1labeling\$1set\$1generation\$1task\$1run）](#aws-glue-api-machine-learning-api-StartMLLabelingSetGenerationTaskRun)
+ [GetMLTaskRun 操作（Python：get\$1ml\$1task\$1run）](#aws-glue-api-machine-learning-api-GetMLTaskRun)
+ [GetMLTaskRuns 操作（Python：get\$1ml\$1task\$1runs）](#aws-glue-api-machine-learning-api-GetMLTaskRuns)
+ [CancelMLTaskRun 操作（Python：cancel\$1ml\$1task\$1run）](#aws-glue-api-machine-learning-api-CancelMLTaskRun)
+ [StartExportLabelsTaskRun 操作（Python：start\$1export\$1labels\$1task\$1run）](#aws-glue-api-machine-learning-api-StartExportLabelsTaskRun)
+ [StartImportLabelsTaskRun 操作（Python：start\$1import\$1labels\$1task\$1run）](#aws-glue-api-machine-learning-api-StartImportLabelsTaskRun)

## CreateMLTransform 操作（Python：create\$1ml\$1transform）
<a name="aws-glue-api-machine-learning-api-CreateMLTransform"></a>

创建 AWS Glue 机器学习转换。此操作将创建转换以及训练它所有所需的参数。

调用此操作作为使用机器学习转换过程中的第一步（例如 `FindMatches` 转换）来消除重复数据。您可以提供一个可选的 `Description`，以及要用于算法的参数。

您还必须为 AWS Glue 代表您运行的任务指定特定参数，作为从数据中学习和创建高质量机器学习转换的一部分。这些参数包括 `Role`，并且可以选择 `AllocatedCapacity`、`Timeout` 和 `MaxRetries`。有关更多信息，请参阅[任务](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html)。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  在创建转换时为其提供的唯一名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  正在定义的机器学习转换的描述。默认值是空字符串。
+ `InputRecordTables` – *必填*：[GlueTable](#aws-glue-api-machine-learning-api-GlueTable) 对象的数组，不超过 10 个结构。

  转换使用的 AWS Glue 表定义的列表。
+ `Parameters` – *必填：*一个 [TransformParameters](#aws-glue-api-machine-learning-api-TransformParameters) 对象。

  特定于所使用转换类型的算法参数。有条件地依赖于转换类型。
+ `Role` – *必填：*UTF-8 字符串。

  具有所需权限的 IAM 角色的名称或 Amazon Resource Name（ARN）。所需权限包括 AWS Glue 资源的 AWS Glue 服务角色权限和转换所需的 Amazon S3 权限。
  + 此角色需要 AWS Glue 服务角色权限才能允许访问 AWS Glue 中的资源。请参阅[将策略附加到访问 AWS Glue 的 IAM 用户](https://docs.aws.amazon.com/glue/latest/dg/attach-policy-iam-user.html)。
  + 此角色需要对您的 Amazon Simple Storage Service (Amazon S3) 源、目标、临时目录、脚本以及此转换的任务运行所使用的任何库的权限。
+ `GlueVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #48](aws-glue-api-common.md#regex_48) 匹配。

  此值确定与此机器学习转换兼容的 AWS Glue 版本。建议大多数用户使用 Glue 1.0。如果未设置此值，则 Glue 兼容性默认为 Glue 0.9。有关更多信息，请参阅开发人员指南中的 [AWS Glue 版本](https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions)。
+ `MaxCapacity` – 数字（double）。

  分配给此转换的任务运行的 AWS Glue 数据处理单元（DPU）的数量。您可以分配 2 到 100 个 DPU；默认值为 10。DPU 是对处理能力的相对度量，它由 4 个 vCPU 的计算容量和 16GB 内存组成。有关更多信息，请参阅 [AWS Glue 价格页面](https://aws.amazon.com/glue/pricing/)。

  `MaxCapacity` 是具有 `NumberOfWorkers` 和 `WorkerType` 的互斥选项。
  + 如果已设置 `NumberOfWorkers` 或 `WorkerType`，则不能设置 `MaxCapacity`。
  + 如果已设置 `MaxCapacity`，则不能设置 `NumberOfWorkers` 或 `WorkerType`。
  + 如果已设置 `WorkerType`，则 `NumberOfWorkers` 为必填项（反之亦然）。
  + `MaxCapacity` 和 `NumberOfWorkers` 都必须至少为 1。

  在将 `WorkerType` 字段设置为 `Standard` 之外的值时，`MaxCapacity` 字段将自动设置并变为只读。

  在将 `WorkerType` 字段设置为 `Standard` 之外的值时，`MaxCapacity` 字段将自动设置并变为只读。
+ `WorkerType` – UTF-8 字符串（有效值：`Standard=""` \$1`G.1X=""` \$1`G.2X=""` \$1`G.025X=""` \$1`G.4X=""` \$1`G.8X=""` \$1`Z.2X=""` ）。

  在此任务运行时分配的预定义工作线程的类型。接受的值为 Standard、G.1X 或 G.2X。
  + 对于 `Standard` 工作线程类型，每个工作线程提供 4 个 vCPU、16 GB 内存和 50GB 磁盘，并且每个工作线程提供 2 个执行器。
  + 对于 `G.1X` 工作线程类型，每个工作线程提供 4 个 vCPU、16 GB 内存和 64GB 磁盘，并且每个工作线程提供 1 个执行器。
  + 对于 `G.2X` 工作线程类型，每个工作线程提供 84 个 vCPU、32 GB 内存和 128GB 磁盘，并且每个工作线程提供 1 个执行器。

  `MaxCapacity` 是具有 `NumberOfWorkers` 和 `WorkerType` 的互斥选项。
  + 如果已设置 `NumberOfWorkers` 或 `WorkerType`，则不能设置 `MaxCapacity`。
  + 如果已设置 `MaxCapacity`，则不能设置 `NumberOfWorkers` 或 `WorkerType`。
  + 如果已设置 `WorkerType`，则 `NumberOfWorkers` 为必填项（反之亦然）。
  + `MaxCapacity` 和 `NumberOfWorkers` 都必须至少为 1。
+ `NumberOfWorkers` – 数字（整数）。

  任务运行时分配的已定义 `workerType` 的工作线程数。

  如果已设置 `WorkerType`，则 `NumberOfWorkers` 为必填项（反之亦然）。
+ `Timeout` - 数字（整数），至少为 1。

  此转换的任务运行超时时间（以分钟为单位）。这是此转换的任务运行在终止并进入 `TIMEOUT` 状态前可以使用资源的最长时间。默认值为 2880 分钟（48 小时）。
+ `MaxRetries` – 数字（整数）。

  在任务运行失败后重试此转换的任务的最大次数。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  用于此机器学习转换的标签。您可以使用标签来限制对机器学习转换的访问权限。有关 AWS Glue 中的标签的更多信息，请参阅开发人员指南中的 [AWS Glue 中的 AWS 标签](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html)。
+ `TransformEncryption` – 一个 [TransformEncryption](#aws-glue-api-machine-learning-api-TransformEncryption) 对象。

  应用于访问用户数据的转换的静态加密设置。机器学习转换可以访问在 Amazon S3 中使用 KMS 加密的用户数据。

**响应**
+ `TransformId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  为转换生成的唯一标识符。

**错误**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `AccessDeniedException`
+ `ResourceNumberLimitExceededException`
+ `IdempotentParameterMismatchException`

## UpdateMLTransform 操作（Python：update\$1ml\$1transform）
<a name="aws-glue-api-machine-learning-api-UpdateMLTransform"></a>

更新现有的机器学习转换。调用此操作可优化算法参数来获得更好的结果。

调用此操作后，您可以调用 `StartMLEvaluationTaskRun` 操作来评估新参数实现目标的程度（例如提高机器学习转换的质量，或使其更具成本效益）。

**请求**
+ `TransformId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  在创建转换时为其生成的唯一标识符。
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  在创建转换时为其提供的唯一名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  对转换的说明。默认值是空字符串。
+ `Parameters` – 一个 [TransformParameters](#aws-glue-api-machine-learning-api-TransformParameters) 对象。

  特定于所使用转换类型（算法）的配置参数。有条件地依赖于转换类型。
+ `Role` – UTF-8 字符串。

  具有所需权限的 IAM 角色的名称或 Amazon Resource Name（ARN）。
+ `GlueVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #48](aws-glue-api-common.md#regex_48) 匹配。

  此值确定与此机器学习转换兼容的 AWS Glue 版本。建议大多数用户使用 Glue 1.0。如果未设置此值，则 Glue 兼容性默认为 Glue 0.9。有关更多信息，请参阅开发人员指南中的 [AWS Glue 版本](https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions)。
+ `MaxCapacity` – 数字（double）。

  分配给此转换的任务运行的 AWS Glue 数据处理单元（DPU）的数量。您可以分配 2 到 100 个 DPU；默认值为 10。DPU 是对处理能力的相对度量，它由 4 个 vCPU 的计算容量和 16GB 内存组成。有关更多信息，请参阅 [AWS Glue 价格页面](https://aws.amazon.com/glue/pricing/)。

  在将 `WorkerType` 字段设置为 `Standard` 之外的值时，`MaxCapacity` 字段将自动设置并变为只读。
+ `WorkerType` – UTF-8 字符串（有效值：`Standard=""` \$1`G.1X=""` \$1`G.2X=""` \$1`G.025X=""` \$1`G.4X=""` \$1`G.8X=""` \$1`Z.2X=""` ）。

  在此任务运行时分配的预定义工作线程的类型。接受的值为 Standard、G.1X 或 G.2X。
  + 对于 `Standard` 工作线程类型，每个工作线程提供 4 个 vCPU、16 GB 内存和 50GB 磁盘，并且每个工作线程提供 2 个执行器。
  + 对于 `G.1X` 工作线程类型，每个工作线程提供 4 个 vCPU、16 GB 内存和 64GB 磁盘，并且每个工作线程提供 1 个执行器。
  + 对于 `G.2X` 工作线程类型，每个工作线程提供 84 个 vCPU、32 GB 内存和 128GB 磁盘，并且每个工作线程提供 1 个执行器。
+ `NumberOfWorkers` – 数字（整数）。

  任务运行时分配的已定义 `workerType` 的工作线程数。
+ `Timeout` - 数字（整数），至少为 1。

  转换的任务运行超时时间（以分钟为单位）。这是此转换的任务运行在终止并进入 `TIMEOUT` 状态前可以使用资源的最长时间。默认值为 2880 分钟（48 小时）。
+ `MaxRetries` – 数字（整数）。

  在任务运行失败后重试此转换的任务的最大次数。

**响应**
+ `TransformId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  已更新的转换的唯一标识符。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `AccessDeniedException`

## DeleteMLTransform 操作（Python：delete\$1ml\$1transform）
<a name="aws-glue-api-machine-learning-api-DeleteMLTransform"></a>

删除 AWS Glue 机器学习转换。机器学习转换是一种特殊类型的转换，它通过从人类提供的示例中学习，使用机器学习来了解要执行转换的详细信息。然后，这些转换将通过 AWS Glue 保存。如果您不再需要转换，可以通过调用 `DeleteMLTransforms` 来删除它。但是，仍然引用已删除转换的任何 AWS Glue 任务将不再成功运行。

**请求**
+ `TransformId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除转换的唯一标识符。

**响应**
+ `TransformId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  已删除转换的唯一标识符。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## GetMLTransform 操作（Python：get\$1ml\$1transform）
<a name="aws-glue-api-machine-learning-api-GetMLTransform"></a>

获取 AWS Glue 机器学习转换构件及其所有相应的元数据。机器学习转换是一种特殊类型的转换，它通过从人类提供的示例中学习，使用机器学习来了解要执行转换的详细信息。然后，这些转换将通过 AWS Glue 保存。您可以通过调用 `GetMLTransform` 来检索其元数据。

**请求**
+ `TransformId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  转换的唯一标识符，在创建转换时生成。

**响应**
+ `TransformId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  转换的唯一标识符，在创建转换时生成。
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  在创建转换时为其提供的唯一名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  对转换的说明。
+ `Status` – UTF-8 字符串（有效值：`NOT_READY` \$1`READY` \$1`DELETING` ）。

  转换的最后一个已知状态（指示是否可以使用）。“NOT\$1READY”、“READY”或“DELETING”之一。
+ `CreatedOn` – 时间戳。

  转换的创建日期和时间。
+ `LastModifiedOn` – 时间戳。

  转换的上次修改日期和时间。
+ `InputRecordTables` – [GlueTable](#aws-glue-api-machine-learning-api-GlueTable) 对象的数组，不超过 10 个结构。

  转换使用的 AWS Glue 表定义的列表。
+ `Parameters` – 一个 [TransformParameters](#aws-glue-api-machine-learning-api-TransformParameters) 对象。

  特定于所使用算法的配置参数。
+ `EvaluationMetrics` – 一个 [EvaluationMetrics](#aws-glue-api-machine-learning-api-EvaluationMetrics) 对象。

  最新的评估指标。
+ `LabelCount` – 数字（整数）。

  可用于此转换的标签数量。
+ `Schema` – [SchemaColumn](#aws-glue-api-machine-learning-api-SchemaColumn) 对象的数组，不超过 100 个结构。

  `Map<Column, Type>` 对象，该对象表示此转换接受的架构。具有 100 列的上限。
+ `Role` – UTF-8 字符串。

  具有所需权限的 IAM 角色的名称或 Amazon Resource Name（ARN）。
+ `GlueVersion` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #48](aws-glue-api-common.md#regex_48) 匹配。

  此值确定与此机器学习转换兼容的 AWS Glue 版本。建议大多数用户使用 Glue 1.0。如果未设置此值，则 Glue 兼容性默认为 Glue 0.9。有关更多信息，请参阅开发人员指南中的 [AWS Glue 版本](https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions)。
+ `MaxCapacity` – 数字（double）。

  分配给此转换的任务运行的 AWS Glue 数据处理单元（DPU）的数量。您可以分配 2 到 100 个 DPU；默认值为 10。DPU 是对处理能力的相对度量，它由 4 个 vCPU 的计算容量和 16GB 内存组成。有关更多信息，请参阅 [AWS Glue 价格页面](https://aws.amazon.com/glue/pricing/)。

  在将 `WorkerType` 字段设置为 `Standard` 之外的值时，`MaxCapacity` 字段将自动设置并变为只读。
+ `WorkerType` – UTF-8 字符串（有效值：`Standard=""` \$1`G.1X=""` \$1`G.2X=""` \$1`G.025X=""` \$1`G.4X=""` \$1`G.8X=""` \$1`Z.2X=""` ）。

  在此任务运行时分配的预定义工作线程的类型。接受的值为 Standard、G.1X 或 G.2X。
  + 对于 `Standard` 工作线程类型，每个工作线程提供 4 个 vCPU、16 GB 内存和 50GB 磁盘，并且每个工作线程提供 2 个执行器。
  + 对于 `G.1X` 工作线程类型，每个工作线程提供 4 个 vCPU、16 GB 内存和 64GB 磁盘，并且每个工作线程提供 1 个执行器。
  + 对于 `G.2X` 工作线程类型，每个工作线程提供 84 个 vCPU、32 GB 内存和 128GB 磁盘，并且每个工作线程提供 1 个执行器。
+ `NumberOfWorkers` – 数字（整数）。

  任务运行时分配的已定义 `workerType` 的工作线程数。
+ `Timeout` - 数字（整数），至少为 1。

  转换的任务运行超时时间（以分钟为单位）。这是此转换的任务运行在终止并进入 `TIMEOUT` 状态前可以使用资源的最长时间。默认值为 2880 分钟（48 小时）。
+ `MaxRetries` – 数字（整数）。

  在任务运行失败后重试此转换的任务的最大次数。
+ `TransformEncryption` – 一个 [TransformEncryption](#aws-glue-api-machine-learning-api-TransformEncryption) 对象。

  应用于访问用户数据的转换的静态加密设置。机器学习转换可以访问在 Amazon S3 中使用 KMS 加密的用户数据。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## GetMLTransforms 操作（Python：get\$1ml\$1ransforms）
<a name="aws-glue-api-machine-learning-api-GetMLTransforms"></a>

获取一个可排序、可筛选的现有 AWS Glue 机器学习转换列表。机器学习转换是一种特殊类型的转换，它通过从人类提供的示例中学习，使用机器学习来了解要执行转换的详细信息。然后，这些转换将通过 AWS Glue 保存，您还可以通过调用 `GetMLTransforms` 来检索其元数据。

**请求**
+ `NextToken` – UTF-8 字符串。

  用于偏移结果的分页令牌。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的最大结果数量。
+ `Filter` – 一个 [TransformFilterCriteria](#aws-glue-api-machine-learning-api-TransformFilterCriteria) 对象。

  转换筛选条件。
+ `Sort` – 一个 [TransformSortCriteria](#aws-glue-api-machine-learning-api-TransformSortCriteria) 对象。

  排序标准。

**响应**
+ `Transforms` – *必填：*[MLTransform](#aws-glue-api-machine-learning-api-MLTransform) 对象的数组。

  机器学习转换的列表。
+ `NextToken` – UTF-8 字符串。

  分页令牌（如果有更多结果可用）。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## ListMLTransforms 操作（Python：list\$1ml\$1transforms）
<a name="aws-glue-api-machine-learning-api-ListMLTransforms"></a>

 在此 AWS 账户中检索可排序、可筛选的现有 AWS Glue 机器学习转换列表或带指定标签的资源。此操作采用可选的 `Tags` 字段，您可以将其用作响应的筛选条件，以便将标记的资源作为一个组进行检索。如果您选择使用标签筛选，则仅检索带标签的资源。

**请求**
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果这是延续请求)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的列表的最大大小。
+ `Filter` – 一个 [TransformFilterCriteria](#aws-glue-api-machine-learning-api-TransformFilterCriteria) 对象。

  用于机器学习转换筛选的 `TransformFilterCriteria`。
+ `Sort` – 一个 [TransformSortCriteria](#aws-glue-api-machine-learning-api-TransformSortCriteria) 对象。

  用于机器学习转换排序的 `TransformSortCriteria`。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  指定仅返回这些已标记的资源。

**响应**
+ `TransformIds` – *必填*：UTF-8 字符串数组。

  所有机器学习的标识符都在账户中进行转换，或者机器学习将使用指定的标签进行转换。
+ `NextToken` – UTF-8 字符串。

  延续令牌 (如果返回的列表不包含上一个可用的指标)。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## StartMLEvaluationTaskRun 操作（Python：start\$1ml\$1evaluation\$1task\$1run）
<a name="aws-glue-api-machine-learning-api-StartMLEvaluationTaskRun"></a>

开始一项任务来估计转换的质量。

当您提供标签集作为真实示例时，AWS Glue 机器学习使用其中的一些例子来学习。其余的标签用作测试，以估计质量。

返回运行的唯一标识符。您可以调用 `GetMLTaskRun` 来获取更多有关 `EvaluationTaskRun` 的统计信息。

**请求**
+ `TransformId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  机器学习转换的唯一标识符。

**响应**
+ `TaskRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与此运行关联的唯一标识符。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ConcurrentRunsExceededException`
+ `MLTransformNotReadyException`

## StartMLLabelingSetGenerationTaskRun 操作（Python：start\$1ml\$1labeling\$1set\$1generation\$1task\$1run）
<a name="aws-glue-api-machine-learning-api-StartMLLabelingSetGenerationTaskRun"></a>

启动机器学习转换的主动学习工作流，通过生成标签集和添加标签来提高转换的质量。

当 `StartMLLabelingSetGenerationTaskRun` 完成后，AWS Glue 将产生一个“标签集”或一组供人类回答的问题。

如果是 `FindMatches` 转换，这些问题的形式是“将这些行组合到完全由匹配记录组成的组中的正确方法是什么？” 

标记过程完成后，您可以通过调用 `StartImportLabelsTaskRun` 来上载您的标签。`StartImportLabelsTaskRun` 完成后，机器学习转换的所有未来运行都将使用新的和改进的标签，并执行更高质量的转换。

注意：用于将生成的标签集写入 `OutputS3Path` 的角色，是与 `CreateMLTransform` API 中指定的机器学习转换器关联的角色。

**请求**
+ `TransformId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  机器学习转换的唯一标识符。
+ `OutputS3Path` – *必填：*UTF-8 字符串。

  生成标签集的 Amazon Simple Storage Service（Amazon S3）路径。

**响应**
+ `TaskRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与此任务运行关联的唯一运行标识符。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ConcurrentRunsExceededException`

## GetMLTaskRun 操作（Python：get\$1ml\$1task\$1run）
<a name="aws-glue-api-machine-learning-api-GetMLTaskRun"></a>

获取在机器学习转换上特定任务运行的详细信息。机器学习任务运行是 AWS Glue 作为各种机器学习工作流的一部分代表您运行的异步任务。您可以通过调用使用 `TaskRunID` 及其父级转换的 `TransformID` 的 `GetMLTaskRun` 来检查任何任务运行的统计信息。

**请求**
+ `TransformId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  机器学习转换的唯一标识符。
+ `TaskRunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  任务运行的唯一标识符。

**响应**
+ `TransformId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  任务运行的唯一标识符。
+ `TaskRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与此运行关联的唯一运行标识符。
+ `Status` – UTF-8 字符串（有效值：`RUNNING` \$1`FINISHED` \$1`FAILED` \$1`PENDING_EXECUTION` \$1`TIMED_OUT` \$1`CANCELING` \$1`CANCELED` \$1`RECEIVED_BY_TASKRUNNER` ）。

  此任务运行的运行状态。
+ `LogGroupName` – UTF-8 字符串。

  与任务运行关联的日志组的名称。
+ `Properties` – 一个 [TaskRunProperties](#aws-glue-api-machine-learning-api-TaskRunProperties) 对象。

  与任务运行关联的属性列表。
+ `ErrorString` – UTF-8 字符串。

  与任务运行关联的错误字符串。
+ `StartedOn` – 时间戳。

  此任务运行开始的日期和时间。
+ `LastModifiedOn` – 时间戳。

  此任务运行的上次修改日期和时间。
+ `CompletedOn` – 时间戳。

  此任务运行的完成日期和时间。
+ `ExecutionTime` – 数字（整数）。

  任务运行使用资源的时间长度（以秒为单位）。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## GetMLTaskRuns 操作（Python：get\$1ml\$1task\$1runs）
<a name="aws-glue-api-machine-learning-api-GetMLTaskRuns"></a>

获取机器学习转换的运行列表。机器学习任务运行是 AWS Glue 作为各种机器学习工作流的一部分代表您运行的异步任务。您可以通过调用使用与其父级转换的 `TransformID` 的 `GetMLTaskRuns` 和本节中介绍的其他可选参数来获取可排序、可筛选的机器学习任务运行列表。

此操作返回历史运行列表，必须进行分页。

**请求**
+ `TransformId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  机器学习转换的唯一标识符。
+ `NextToken` – UTF-8 字符串。

  用于分页结果的令牌。默认值为空。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的最大结果数量。
+ `Filter` – 一个 [TaskRunFilterCriteria](#aws-glue-api-machine-learning-api-TaskRunFilterCriteria) 对象。

  筛选标准，位于 `TaskRunFilterCriteria` 结构，用于任务运行。
+ `Sort` – 一个 [TaskRunSortCriteria](#aws-glue-api-machine-learning-api-TaskRunSortCriteria) 对象。

  排序标准，位于 `TaskRunSortCriteria` 结构，用于任务运行。

**响应**
+ `TaskRuns` – [TaskRun](#aws-glue-api-machine-learning-api-TaskRun) 对象的数组。

  与转换相关联的任务运行列表。
+ `NextToken` – UTF-8 字符串。

  分页令牌（如果有更多结果可用）。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## CancelMLTaskRun 操作（Python：cancel\$1ml\$1task\$1run）
<a name="aws-glue-api-machine-learning-api-CancelMLTaskRun"></a>

取消（停止）任务运行。机器学习任务运行是 AWS Glue 作为各种机器学习工作流的一部分代表您运行的异步任务。您可以随时取消机器学习任务运行，方法是调用使用任务运行父级转换的 `TransformID` 和任务运行的 `TaskRunId` 的 `CancelMLTaskRun`。

**请求**
+ `TransformId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  机器学习转换的唯一标识符。
+ `TaskRunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  任务运行的唯一标识符。

**响应**
+ `TransformId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  机器学习转换的唯一标识符。
+ `TaskRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  任务运行的唯一标识符。
+ `Status` – UTF-8 字符串（有效值：`RUNNING` \$1`FINISHED` \$1`FAILED` \$1`PENDING_EXECUTION` \$1`TIMED_OUT` \$1`CANCELING` \$1`CANCELED` \$1`RECEIVED_BY_TASKRUNNER` ）。

  此运行的运行状态。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## StartExportLabelsTaskRun 操作（Python：start\$1export\$1labels\$1task\$1run）
<a name="aws-glue-api-machine-learning-api-StartExportLabelsTaskRun"></a>

开始异步任务以导出特定转换的所有标记数据。此任务是唯一不属于典型主动学习工作流的标签相关的 API 调用。当您希望同时处理所有现有标签时，例如，当您想要删除或更改以前作为真实提交的标签时，您通常使用 `StartExportLabelsTaskRun`。此 API 操作接受要导出其标签的 `TransformId`，以及将标签导出的 Amazon Simple Storage Service（Amazon S3）路径。操作返回 `TaskRunId`。您可以通过调用 `GetMLTaskRun` API 来检查任务运行状态。

**请求**
+ `TransformId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  机器学习转换的唯一标识符。
+ `OutputS3Path` – *必填：*UTF-8 字符串。

  您导出标签的 Amazon S3 路径。

**响应**
+ `TaskRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  任务运行的唯一标识符。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## StartImportLabelsTaskRun 操作（Python：start\$1import\$1labels\$1task\$1run）
<a name="aws-glue-api-machine-learning-api-StartImportLabelsTaskRun"></a>

使您能够提供其他标签（真相示例），用于教授机器学习转换并提高其质量。此 API 操作通常用作主动学习工作流的一部分，其中该工作流于 `StartMLLabelingSetGenerationTaskRun` 调用，并最终提高您的机器学习转换的质量。

`StartMLLabelingSetGenerationTaskRun` 完成后，AWS Glue 机器学习将产生一系列供人类回答的问题。（回答这些问题通常称为机器学习工作流中的“标签”）。如果是 `FindMatches` 转换，这些问题的形式是“将这些行组合到完全由匹配记录组成的组中的正确方法是什么？” 标签过程完成后，用户会通过调用 `StartImportLabelsTaskRun` 来上载他们的答案/标签。`StartImportLabelsTaskRun` 完成后，机器学习转换的所有未来运行都使用新的和改进的标签，并执行更高质量的转换。

默认情况下，`StartMLLabelingSetGenerationTaskRun` 会不断地从您上载的所有标签中学习和合并所有标签，除非您将 `Replace` 设置为 True。如果您将 `Replace` 设置为 true，`StartImportLabelsTaskRun` 会删除和忘记所有先前上载的标签，并仅从您上载的确切标签集中获取信息。如果您意识到以前上载了不正确的标签，并且您认为它们对转换质量产生负面影响，则替换标签会很有帮助。

您可以通过调用 `GetMLTaskRun` 操作来检查任务运行状态。

**请求**
+ `TransformId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  机器学习转换的唯一标识符。
+ `InputS3Path` – *必填：*UTF-8 字符串。

  导入标签的 Amazon Simple Storage Service（Amazon S3）路径。
+ `ReplaceAllLabels` – 布尔值。

  指示是否覆盖现有标签。

**响应**
+ `TaskRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  任务运行的唯一标识符。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`

# 数据质量 API
<a name="aws-glue-api-data-quality-api"></a>

数据质量 API 描述了数据质量数据类型，并包括用于创建、删除或更新数据质量规则集、运行和评估的 API。

## 数据类型
<a name="aws-glue-api-data-quality-api-objects"></a>
+ [数据源结构](#aws-glue-api-data-quality-api-DataSource)
+ [DataQualityRulesetListDetails 结构](#aws-glue-api-data-quality-api-DataQualityRulesetListDetails)
+ [DataQualityTargetTable 结构](#aws-glue-api-data-quality-api-DataQualityTargetTable)
+ [DataQualityRulesetEvaluationRunDescription 结构](#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunDescription)
+ [DataQualityRulesetEvaluationRunFilter 结构](#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunFilter)
+ [DataQualityEvaluationRunAdditionalRunOptions 结构](#aws-glue-api-data-quality-api-DataQualityEvaluationRunAdditionalRunOptions)
+ [DataQualityRuleRecommendationRunDescription 结构](#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunDescription)
+ [DataQualityRuleRecommendationRunFilter 结构](#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunFilter)
+ [DataQualityResult 结构](#aws-glue-api-data-quality-api-DataQualityResult)
+ [DataQualityAnalyzerResult 结构](#aws-glue-api-data-quality-api-DataQualityAnalyzerResult)
+ [DataQualityObservation 结构](#aws-glue-api-data-quality-api-DataQualityObservation)
+ [MetricBasedObservation 结构](#aws-glue-api-data-quality-api-MetricBasedObservation)
+ [DataQualityMetricValues 结构](#aws-glue-api-data-quality-api-DataQualityMetricValues)
+ [DataQualityRuleResult 结构](#aws-glue-api-data-quality-api-DataQualityRuleResult)
+ [DataQualityResultDescription 结构](#aws-glue-api-data-quality-api-DataQualityResultDescription)
+ [DataQualityResultFilterCriteria 结构](#aws-glue-api-data-quality-api-DataQualityResultFilterCriteria)
+ [DataQualityRulesetFilterCriteria 结构](#aws-glue-api-data-quality-api-DataQualityRulesetFilterCriteria)
+ [DataQualityAggregatedMetrics 结构](#aws-glue-api-data-quality-api-DataQualityAggregatedMetrics)
+ [StatisticAnnotation 结构](#aws-glue-api-data-quality-api-StatisticAnnotation)
+ [TimestampedInclusionAnnotation 结构](#aws-glue-api-data-quality-api-TimestampedInclusionAnnotation)
+ [AnnotionError 结构](#aws-glue-api-data-quality-api-AnnotationError)
+ [DatapointInclusionAnnotation 结构](#aws-glue-api-data-quality-api-DatapointInclusionAnnotation)
+ [StatisticSummaryList 列表](#aws-glue-api-data-quality-api-StatisticSummaryList)
+ [StatisticSummary 结构](#aws-glue-api-data-quality-api-StatisticSummary)
+ [RunIdentifier 结构](#aws-glue-api-data-quality-api-RunIdentifier)
+ [StatisticModelResult 结构](#aws-glue-api-data-quality-api-StatisticModelResult)
+ [DataQualityGlueTable 结构](#aws-glue-api-data-quality-api-DataQualityGlueTable)

## 数据源结构
<a name="aws-glue-api-data-quality-api-DataSource"></a>

要获得数据质量结果的数据源（AWS Glue 表）。

**字段**
+ `GlueTable` – 一个 [GlueTable](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-GlueTable) 对象。

  一个 AWS Glue 表。
+ `DataQualityGlueTable` – 一个 [DataQualityGlueTable](#aws-glue-api-data-quality-api-DataQualityGlueTable) 对象。

  适用于 Data Quality Operations 的 AWS Glue 表。

## DataQualityRulesetListDetails 结构
<a name="aws-glue-api-data-quality-api-DataQualityRulesetListDetails"></a>

描述 `GetDataQualityRuleset` 返回的数据质量规则集。

**字段**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据质量规则集的名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  数据质量规则集的描述。
+ `CreatedOn` – 时间戳。

  创建数据质量规则集的日期和时间。
+ `LastModifiedOn` – 时间戳。

  上次修改数据质量规则集的日期和时间。
+ `TargetTable` – 一个 [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable) 对象。

  表示 AWS Glue 表的对象。
+ `RecommendationRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  当根据建议运行创建规则集时，会生成此运行 ID 以将两者联系在一起。
+ `RuleCount` – 数字（整数）。

  规则集中的规则数量。

## DataQualityTargetTable 结构
<a name="aws-glue-api-data-quality-api-DataQualityTargetTable"></a>

表示 AWS Glue 表的对象。

**字段**
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  AWS Glue 表的名称。
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  AWS Glue 表所在数据库的名称。
+ `CatalogId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  AWS Glue 表所在的目录 ID。

## DataQualityRulesetEvaluationRunDescription 结构
<a name="aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunDescription"></a>

描述数据质量规则集评估运行的结果。

**字段**
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与此运行关联的唯一运行标识符。
+ `Status` – UTF-8 字符串（有效值：`RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`）。

  此运行的运行状态。
+ `StartedOn` – 时间戳。

  启动运行的日期和时间。
+ `DataSource` – 一个 [DataSource](#aws-glue-api-data-quality-api-DataSource) 对象。

  与运行相关的数据源（AWS Glue 表）。

## DataQualityRulesetEvaluationRunFilter 结构
<a name="aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunFilter"></a>

筛选条件。

**字段**
+ `DataSource` – *必填：*一个 [DataSource](#aws-glue-api-data-quality-api-DataSource) 对象。

  根据与运行相关的数据源（AWS Glue 表）进行筛选。
+ `StartedBefore` – 时间戳。

  按在此时间之前开始的运行筛选结果。
+ `StartedAfter` – 时间戳。

  按在此时间之后开始的运行筛选结果。

## DataQualityEvaluationRunAdditionalRunOptions 结构
<a name="aws-glue-api-data-quality-api-DataQualityEvaluationRunAdditionalRunOptions"></a>

您可以为评估运行指定的其他运行选项。

**字段**
+ `CloudWatchMetricsEnabled` – 布尔值。

  是否启用 CloudWatch 指标。
+ `ResultsS3Prefix` – UTF-8 字符串。

  用于存储结果的 Amazon S3 的前缀。
+ `CompositeRuleEvaluationMethod` – UTF-8 字符串（有效值：`COLUMN` \$1 `ROW`）。

  将规则集中复合规则的评估方法设置为 ROW/COLUMN

## DataQualityRuleRecommendationRunDescription 结构
<a name="aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunDescription"></a>

描述数据质量规则建议运行的结果。

**字段**
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与此运行关联的唯一运行标识符。
+ `Status` – UTF-8 字符串（有效值：`RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`）。

  此运行的运行状态。
+ `StartedOn` – 时间戳。

  此运行开始的日期和时间。
+ `DataSource` – 一个 [DataSource](#aws-glue-api-data-quality-api-DataSource) 对象。

  与建议运行相关的数据源（AWS Glue 表）。

## DataQualityRuleRecommendationRunFilter 结构
<a name="aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunFilter"></a>

用于列出数据质量建议运行的筛选器。

**字段**
+ `DataSource` – *必填：*一个 [DataSource](#aws-glue-api-data-quality-api-DataSource) 对象。

  根据指定的数据源（AWS Glue 表）进行筛选。
+ `StartedBefore` – 时间戳。

  根据时间进行筛选，以查看在提供的时间之前开始的结果。
+ `StartedAfter` – 时间戳。

  根据时间进行筛选，以查看在提供的时间之后开始的结果。

## DataQualityResult 结构
<a name="aws-glue-api-data-quality-api-DataQualityResult"></a>

描述数据质量结果。

**字段**
+ `ResultId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据质量结果的唯一结果 ID。
+ `ProfileId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据质量结果的配置文件 ID。
+ `Score` – 数字（双数），不超过 1.0。

  汇总的数据质量分数。表示规则与传递到规则总数的比率。
+ `DataSource` – 一个 [DataSource](#aws-glue-api-data-quality-api-DataSource) 对象。

  与数据质量结果相关的表（如果有）。
+ `RulesetName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与数据质量结果相关的规则集的名称。
+ `EvaluationContext` – UTF-8 字符串。

  在 AWS Glue Studio 中的作业环境中，画布中的每个节点通常都被分配某种名称，数据质量节点也会有名称。如果有多个节点，则 `evaluationContext` 可以区分这些节点。
+ `StartedOn` – 时间戳。

  此数据质量运行开始的日期和时间。
+ `CompletedOn` – 时间戳。

  此数据质量运行完成的日期和时间。
+ `JobName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与数据质量结果相关的作业名称（如果有）。
+ `JobRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与数据质量结果相关的作业运行 ID（如果有）。
+ `RulesetEvaluationRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  此数据质量结果的规则集评估的唯一运行 ID。
+ `RuleResults` – 一组 [DataQualityRuleResult](#aws-glue-api-data-quality-api-DataQualityRuleResult) 对象，不超过 2000 个结构。

  代表每条规则结果的 `DataQualityRuleResult` 对象列表。
+ `AnalyzerResults` – 一组 [DataQualityAnalyzerResult](#aws-glue-api-data-quality-api-DataQualityAnalyzerResult) 对象，不超过 2000 个结构。

  代表每个分析器结果的 `DataQualityAnalyzerResult` 对象列表。
+ `Observations` – [DataQualityObservation](#aws-glue-api-data-quality-api-DataQualityObservation) 对象的数组，不超过 50 个结构。

  代表评估规则和分析器后生成的观测值的 `DataQualityObservation` 对象列表。
+ `AggregatedMetrics` – 一个 [DataQualityAggregatedMetrics](#aws-glue-api-data-quality-api-DataQualityAggregatedMetrics) 对象。

   `DataQualityAggregatedMetrics` 对象的摘要，将显示已处理的行和规则总数，包括基于行级结果的通过/失败统计信息。

## DataQualityAnalyzerResult 结构
<a name="aws-glue-api-data-quality-api-DataQualityAnalyzerResult"></a>

描述数据质量分析器评估的结果。

**字段**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据质量分析器的名称。
+ `Description` – UTF-8 字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  数据质量分析器的描述。
+ `EvaluationMessage` – UTF-8 字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  评估消息。
+ `EvaluatedMetrics` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  每个值都是数字（双精度数）。

  与分析器评估相关的指标地图。

## DataQualityObservation 结构
<a name="aws-glue-api-data-quality-api-DataQualityObservation"></a>

描述评估规则和分析器后生成的观测。

**字段**
+ `Description` – UTF-8 字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  数据质量观测的描述。
+ `MetricBasedObservation` – 一个 [MetricBasedObservation](#aws-glue-api-data-quality-api-MetricBasedObservation) 对象。

  表示基于所评估数据质量指标的观测的 `MetricBasedObservation` 类型对象。

## MetricBasedObservation 结构
<a name="aws-glue-api-data-quality-api-MetricBasedObservation"></a>

描述基于所评估数据质量指标生成的基于指标的观测。

**字段**
+ `MetricName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于生成观测的数据质量指标的名称。
+ `StatisticId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  统计信息 ID。
+ `MetricValues` – 一个 [DataQualityMetricValues](#aws-glue-api-data-quality-api-DataQualityMetricValues) 对象。

  表示数据质量指标值分析的 `DataQualityMetricValues` 类型对象。
+ `NewRules` – UTF-8 字符串数组。

  根据数据质量指标值，作为观测结果的一部分生成的新数据质量规则列表。

## DataQualityMetricValues 结构
<a name="aws-glue-api-data-quality-api-DataQualityMetricValues"></a>

根据对历史数据的分析，描述数据质量指标值。

**字段**
+ `ActualValue` – 数字（double）。

  数据质量指标的实际值。
+ `ExpectedValue` – 数字（double）。

  根据对历史数据的分析，数据质量指标的预期值。
+ `LowerLimit` – 数字（double）。

  根据对历史数据的分析，数据质量指标的下限值。
+ `UpperLimit` – 数字（double）。

  根据对历史数据的分析，数据质量指标的上限值。

## DataQualityRuleResult 结构
<a name="aws-glue-api-data-quality-api-DataQualityRuleResult"></a>

描述数据质量规则评估运行的结果。

**字段**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据质量规则的名称。
+ `Description` – UTF-8 字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  数据质量规则的描述。
+ `EvaluationMessage` – UTF-8 字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  评估消息。
+ `Result` – UTF-8 字符串（有效值：`PASS` \$1 `FAIL` \$1 `ERROR`）。

  规则的通过或失败状态。
+ `EvaluatedMetrics` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  每个值都是数字（双精度数）。

  与规则评估相关的指标地图。
+ `EvaluatedRule` – UTF-8 字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  已评估的规则。
+ `RuleMetrics` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  每个值都是数字（双精度数）。

  包含与该规则的评估相关的指标图，基于行级结果。

## DataQualityResultDescription 结构
<a name="aws-glue-api-data-quality-api-DataQualityResultDescription"></a>

描述数据质量结果。

**字段**
+ `ResultId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  此数据质量结果的唯一结果 ID。
+ `DataSource` – 一个 [DataSource](#aws-glue-api-data-quality-api-DataSource) 对象。

  与数据质量结果相关的表。
+ `JobName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与数据质量结果相关的作业名称。
+ `JobRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与数据质量结果相关的作业运行 ID。
+ `StartedOn` – 时间戳。

  此数据质量结果的运行开始的时间。

## DataQualityResultFilterCriteria 结构
<a name="aws-glue-api-data-quality-api-DataQualityResultFilterCriteria"></a>

用于返回数据质量结果的标准。

**字段**
+ `DataSource` – 一个 [DataSource](#aws-glue-api-data-quality-api-DataSource) 对象。

  按指定的数据源筛选结果。例如，检索 AWS Glue 表的所有结果。
+ `JobName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  按指定的任务名称筛选结果。
+ `JobRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  按指定的任务运行 ID 筛选结果。
+ `StartedAfter` – 时间戳。

  按在此时间之后开始的运行筛选结果。
+ `StartedBefore` – 时间戳。

  按在此时间之前开始的运行筛选结果。

## DataQualityRulesetFilterCriteria 结构
<a name="aws-glue-api-data-quality-api-DataQualityRulesetFilterCriteria"></a>

用于筛选数据质量规则集的条件。

**字段**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  规则集筛选条件的名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  规则集筛选条件的描述。
+ `CreatedBefore` – 时间戳。

  筛选在此日期之前创建的规则集。
+ `CreatedAfter` – 时间戳。

  筛选在此日期之后创建的规则集。
+ `LastModifiedBefore` – 时间戳。

  筛选此日期之前最后一次修改的规则集。
+ `LastModifiedAfter` – 时间戳。

  筛选此日期之后最后一次修改的规则集。
+ `TargetTable` – 一个 [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable) 对象。

  目标表的名称和数据库名称。

## DataQualityAggregatedMetrics 结构
<a name="aws-glue-api-data-quality-api-DataQualityAggregatedMetrics"></a>

显示已处理行和规则总数的指标摘要，包括基于行级结果的通过/失败统计数据。

**字段**
+ `TotalRowsProcessed` – 数字（double）。

  在数据质量评估期间处理的总行数。
+ `TotalRowsPassed` – 数字（double）。

  通过所有适用数据质量规则的总行数。
+ `TotalRowsFailed` – 数字（double）。

  未通过一项或多项数据质量规则的总行数。
+ `TotalRulesProcessed` – 数字（double）。

  评估的数据质量规则总数。
+ `TotalRulesPassed` – 数字（double）。

  通过其评估标准的数据质量规则总数。
+ `TotalRulesFailed` – 数字（double）。

  未通过其评估标准的数据质量规则总数。

## StatisticAnnotation 结构
<a name="aws-glue-api-data-quality-api-StatisticAnnotation"></a>

统计注释。

**字段**
+ `ProfileId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  配置文件 ID。
+ `StatisticId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  统计信息 ID。
+ `StatisticRecordedOn` – 时间戳。

  带注释的统计数据被记录的时间戳。
+ `InclusionAnnotation` – 一个 [TimestampedInclusionAnnotation](#aws-glue-api-data-quality-api-TimestampedInclusionAnnotation) 对象。

  应用于统计数据的包含注释。

## TimestampedInclusionAnnotation 结构
<a name="aws-glue-api-data-quality-api-TimestampedInclusionAnnotation"></a>

带有时间戳的包含注释。

**字段**
+ `Value` – UTF-8 字符串（有效值：`INCLUDE` \$1 `EXCLUDE`）。

  包含注释值。
+ `LastModifiedOn` – 时间戳。

  上次修改包含注释的时间戳。

## AnnotionError 结构
<a name="aws-glue-api-data-quality-api-AnnotationError"></a>

失败的注释。

**字段**
+ `ProfileId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  失败注释的配置文件 ID。
+ `StatisticId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  失败注释的统计数据 ID。
+ `FailureReason` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  注释处理失败的原因。

## DatapointInclusionAnnotation 结构
<a name="aws-glue-api-data-quality-api-DatapointInclusionAnnotation"></a>

包含注释。

**字段**
+ `ProfileId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  统计数据所属的数据质量配置文件的 ID。
+ `StatisticId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  统计信息 ID。
+ `InclusionAnnotation` – UTF-8 字符串（有效值：`INCLUDE` \$1 `EXCLUDE`）。

  要应用于统计数据的包含注释值。

## StatisticSummaryList 列表
<a name="aws-glue-api-data-quality-api-StatisticSummaryList"></a>

`StatisticSummary` 列表。

[StatisticSummary](#aws-glue-api-data-quality-api-StatisticSummary) 数据元数组。

`StatisticSummary` 列表。

## StatisticSummary 结构
<a name="aws-glue-api-data-quality-api-StatisticSummary"></a>

统计数据的汇总信息。

**字段**
+ `StatisticId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  统计信息 ID。
+ `ProfileId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  配置文件 ID。
+ `RunIdentifier` – 一个 [RunIdentifier](#aws-glue-api-data-quality-api-RunIdentifier) 对象。

  运行标识符
+ `StatisticName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Custom string pattern #16](aws-glue-api-common.md#regex_16) 匹配。

  统计数据的名称。
+ `DoubleValue` – 数字（double）。

  统计数据的值。
+ `EvaluationLevel` – UTF-8 字符串（有效值：`Dataset="DATASET"` \$1 `Column="COLUMN"` \$1 `Multicolumn="MULTICOLUMN"`）。

  统计数据的评估级别。可能的值：`Dataset`、`Column`、`Multicolumn`。
+ `ColumnsReferenced` – UTF-8 字符串数组。

  统计数据引用的列的列表。
+ `ReferencedDatasets` – UTF-8 字符串数组。

  统计数据引用的数据集的列表。
+ `StatisticProperties` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  每个值都是一个描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  一个 `StatisticPropertiesMap`，其中包含 `NameString` 和 `DescriptionString`
+ `RecordedOn` – 时间戳。

  记录统计数据的时间戳。
+ `InclusionAnnotation` – 一个 [TimestampedInclusionAnnotation](#aws-glue-api-data-quality-api-TimestampedInclusionAnnotation) 对象。

  统计数据的包含注释。

## RunIdentifier 结构
<a name="aws-glue-api-data-quality-api-RunIdentifier"></a>

运行标识符。

**字段**
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  运行 ID。
+ `JobRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  作业运行 ID。

## StatisticModelResult 结构
<a name="aws-glue-api-data-quality-api-StatisticModelResult"></a>

统计模型结果。

**字段**
+ `LowerBound` – 数字（double）。

  下限。
+ `UpperBound` – 数字（double）。

  上限。
+ `PredictedValue` – 数字（double）。

  预测值。
+ `ActualValue` – 数字（double）。

  实际值。
+ `Date` – 时间戳。

  日期。
+ `InclusionAnnotation` – UTF-8 字符串（有效值：`INCLUDE` \$1 `EXCLUDE`）。

  包含注释。

## DataQualityGlueTable 结构
<a name="aws-glue-api-data-quality-api-DataQualityGlueTable"></a>

AWS Glue Data Catalog 中用作 Data Quality Operations 输入或输出数据的数据库和表。

**字段**
+ `DatabaseName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  AWS Glue Data Catalog 中的数据库名称。
+ `TableName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  AWS Glue Data Catalog 中的表名称。
+ `CatalogId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  AWS Glue Data Catalog 的唯一标识符。
+ `ConnectionName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  AWS Glue Data Catalog 中的连接名称。
+ `AdditionalOptions` – 键值对的映射数组，不少于 1 对且不超过 10 对。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  每个值都是一个描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  用于表的其他选项。目前支持两个键：
  + `pushDownPredicate`：筛选分区，而不必列出并读取数据集中的所有文件。
  + `catalogPartitionPredicate`：使用 AWS Glue Data Catalog 中的分区索引来使用服务器端分区修剪。
+ `PreProcessingQuery`：UTF-8 字符串，长度不超过 51200 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  SparkSQL 格式的 SQL 查询，可用于在运行 Data Quality Operation 之前对 AWS Glue Data Catalog 中表的数据进行预处理。

## 操作
<a name="aws-glue-api-data-quality-api-actions"></a>
+ [StartDataQualityRulesetEvaluationRun 操作（Python：start\$1data\$1quality\$1ruleset\$1evaluation\$1run）](#aws-glue-api-data-quality-api-StartDataQualityRulesetEvaluationRun)
+ [CancelDataQualityRulesetEvaluationRun 操作（Python：cancel\$1data\$1quality\$1ruleset\$1evaluation\$1run）](#aws-glue-api-data-quality-api-CancelDataQualityRulesetEvaluationRun)
+ [GetDataQualityRulesetEvaluationRun 操作（Python：get\$1data\$1quality\$1ruleset\$1evaluation\$1run）](#aws-glue-api-data-quality-api-GetDataQualityRulesetEvaluationRun)
+ [ListDataQualityRulesetEvaluationRuns 操作（Python: list\$1data\$1quality\$1ruleset\$1evaluation\$1runs）](#aws-glue-api-data-quality-api-ListDataQualityRulesetEvaluationRuns)
+ [StartDataQualityRuleRecommendationRun 操作（Python：start\$1data\$1quality\$1rule\$1recommendation\$1run）](#aws-glue-api-data-quality-api-StartDataQualityRuleRecommendationRun)
+ [CancelDataQualityRuleRecommendationRun 操作（Python：cancel\$1data\$1quality\$1rule\$1recommendation\$1run）](#aws-glue-api-data-quality-api-CancelDataQualityRuleRecommendationRun)
+ [GetDataQualityRuleRecommendationRun 操作（Python：get\$1data\$1quality\$1rule\$1recommendation\$1run）](#aws-glue-api-data-quality-api-GetDataQualityRuleRecommendationRun)
+ [ListDataQualityRuleRecommendationRuns 操作（Python：list\$1data\$1quality\$1rule\$1recommendation\$1runs）](#aws-glue-api-data-quality-api-ListDataQualityRuleRecommendationRuns)
+ [GetDataQualityResult 操作（Python：get\$1data\$1quality\$1result）](#aws-glue-api-data-quality-api-GetDataQualityResult)
+ [BatchGetDataQualityResult 操作（Python：batch\$1get\$1data\$1quality\$1result）](#aws-glue-api-data-quality-api-BatchGetDataQualityResult)
+ [ListDataQualityResults 操作（Python：list\$1data\$1quality\$1results）](#aws-glue-api-data-quality-api-ListDataQualityResults)
+ [CreateDataQualityRuleset 操作（Python：create\$1data\$1quality\$1ruleset）](#aws-glue-api-data-quality-api-CreateDataQualityRuleset)
+ [DeleteDataQualityRuleset 操作（Python：delete\$1data\$1quality\$1ruleset）](#aws-glue-api-data-quality-api-DeleteDataQualityRuleset)
+ [GetDataQualityRuleset 操作（Python：get\$1data\$1quality\$1ruleset）](#aws-glue-api-data-quality-api-GetDataQualityRuleset)
+ [ListDataQualityRulesets 操作（Python：list\$1data\$1quality\$1rulesets）](#aws-glue-api-data-quality-api-ListDataQualityRulesets)
+ [UpdateDataQualityRuleset 操作（Python：update\$1data\$1quality\$1ruleset）](#aws-glue-api-data-quality-api-UpdateDataQualityRuleset)
+ [ListDataQualityStatistics 操作（Python：list\$1data\$1quality\$1statistics）](#aws-glue-api-data-quality-api-ListDataQualityStatistics)
+ [TimestampFilter 结构](#aws-glue-api-data-quality-api-TimestampFilter)
+ [CreateDataQualityRulesetRequest 结构](#aws-glue-api-data-quality-api-CreateDataQualityRulesetRequest)
+ [GetDataQualityRulesetResponse 结构](#aws-glue-api-data-quality-api-GetDataQualityRulesetResponse)
+ [GetDataQualityResultResponse 结构](#aws-glue-api-data-quality-api-GetDataQualityResultResponse)
+ [StartDataQualityRuleRecommendationRunRequest 结构](#aws-glue-api-data-quality-api-StartDataQualityRuleRecommendationRunRequest)
+ [GetDataQualityRuleRecommendationRunResponse 结构](#aws-glue-api-data-quality-api-GetDataQualityRuleRecommendationRunResponse)
+ [BatchPutDataQualityStatisticAnnotation 操作（Python：batch\$1put\$1data\$1quality\$1statistic\$1annotation）](#aws-glue-api-data-quality-api-BatchPutDataQualityStatisticAnnotation)
+ [GetDataQualityModel 操作（Python：get\$1data\$1quality\$1model）](#aws-glue-api-data-quality-api-GetDataQualityModel)
+ [GetDataQualityModelResult 操作（Python：get\$1data\$1quality\$1model\$1result）](#aws-glue-api-data-quality-api-GetDataQualityModelResult)
+ [ListDataQualityStatisticAnnotations 操作（Python：list\$1data\$1quality\$1statistic\$1annotations）](#aws-glue-api-data-quality-api-ListDataQualityStatisticAnnotations)
+ [PutDataQualityProfileAnnotation 操作（Python：put\$1data\$1quality\$1profile\$1annotation）](#aws-glue-api-data-quality-api-PutDataQualityProfileAnnotation)

## StartDataQualityRulesetEvaluationRun 操作（Python：start\$1data\$1quality\$1ruleset\$1evaluation\$1run）
<a name="aws-glue-api-data-quality-api-StartDataQualityRulesetEvaluationRun"></a>

有了规则集定义（推荐定义或您自己的定义）后，就可以调用此操作来根据数据源（AWS Glue 表）评估规则集。评估会计算出您可以使用 `GetDataQualityResult` API 检索的结果。

**请求**
+ `DataSource` – *必填：*一个 [DataSource](#aws-glue-api-data-quality-api-DataSource) 对象。

  与此运行相关的数据源（AWS Glue 表）。
+ `Role` – *必填：*UTF-8 字符串。

  为加密运行结果而提供的 IAM 角色。
+ `NumberOfWorkers` – 数字（整数）。

  运行所用的 `G.1X` 工作线程数量。默认值为 5。
+ `Timeout` - 数字（整数），至少为 1。

  运行超时（分钟）。这是任务运行在终止并进入 `TIMEOUT` 状态前可以使用资源的最长时间。默认值为 2880 分钟（48 小时）。
+ `ClientToken` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于幂等性，建议设置为随机 ID（例如，UUID），以避免创建或启动同一资源的多个实例。
+ `AdditionalRunOptions` – 一个 [DataQualityEvaluationRunAdditionalRunOptions](#aws-glue-api-data-quality-api-DataQualityEvaluationRunAdditionalRunOptions) 对象。

  您可以为评估运行指定的其他运行选项。
+ `RulesetNames` — *必填：*UTF-8 字符串数组，不少于 1 个或不超过 10 个字符串。

  规则集名称的列表。
+ `AdditionalDataSources` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  每个值都是一个 [DataSource](#aws-glue-api-data-quality-api-DataSource) 对象。

  您可以为评估运行指定的其他数据来源的引用字符串地图。

**响应**
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与此运行关联的唯一运行标识符。

**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ConflictException`

## CancelDataQualityRulesetEvaluationRun 操作（Python：cancel\$1data\$1quality\$1ruleset\$1evaluation\$1run）
<a name="aws-glue-api-data-quality-api-CancelDataQualityRulesetEvaluationRun"></a>

取消正在根据数据源评估规则集的运行。

**请求**
+ `RunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与此运行关联的唯一运行标识符。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## GetDataQualityRulesetEvaluationRun 操作（Python：get\$1data\$1quality\$1ruleset\$1evaluation\$1run）
<a name="aws-glue-api-data-quality-api-GetDataQualityRulesetEvaluationRun"></a>

检索正在根据数据源评估规则集的特定运行。

**请求**
+ `RunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与此运行关联的唯一运行标识符。

**响应**
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与此运行关联的唯一运行标识符。
+ `DataSource` – 一个 [DataSource](#aws-glue-api-data-quality-api-DataSource) 对象。

  与此评估运行相关的数据源（AWS Glue 表）。
+ `Role` – UTF-8 字符串。

  为加密运行结果而提供的 IAM 角色。
+ `NumberOfWorkers` – 数字（整数）。

  运行所用的 `G.1X` 工作线程数量。默认值为 5。
+ `Timeout` - 数字（整数），至少为 1。

  运行超时（分钟）。这是任务运行在终止并进入 `TIMEOUT` 状态前可以使用资源的最长时间。默认值为 2880 分钟（48 小时）。
+ `AdditionalRunOptions` – 一个 [DataQualityEvaluationRunAdditionalRunOptions](#aws-glue-api-data-quality-api-DataQualityEvaluationRunAdditionalRunOptions) 对象。

  您可以为评估运行指定的其他运行选项。
+ `Status` – UTF-8 字符串（有效值：`RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`）。

  此运行的运行状态。
+ `ErrorString` – UTF-8 字符串。

  与运行关联的错误字符串。
+ `StartedOn` – 时间戳。

  此运行开始的日期和时间。
+ `LastModifiedOn` – 时间戳。

  时间戳。此数据质量规则建议运行最后一个修改时间点。
+ `CompletedOn` – 时间戳。

  此运行的完成日期和时间。
+ `ExecutionTime` – 数字（整数）。

  运行使用资源的时间长度（以秒为单位）。
+ `RulesetNames` – UTF-8 字符串数组，不少于 1 个字符串，不超过 10 个字符串。

  运行的规则集名称列表。目前，此参数仅采用一个规则集名称。
+ `ResultIds` — UTF-8 字符串数组，不少于 1 个字符串，不超过 10 个字符串。

  运行数据质量结果的结果 ID 列表。
+ `AdditionalDataSources` – 键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  每个值都是一个 [DataSource](#aws-glue-api-data-quality-api-DataSource) 对象。

  您可以为评估运行指定的其他数据来源的引用字符串地图。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## ListDataQualityRulesetEvaluationRuns 操作（Python: list\$1data\$1quality\$1ruleset\$1evaluation\$1runs）
<a name="aws-glue-api-data-quality-api-ListDataQualityRulesetEvaluationRuns"></a>

列出所有符合筛选条件的运行，其中根据数据源对规则集进行评估。

**请求**
+ `Filter` – 一个 [DataQualityRulesetEvaluationRunFilter](#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunFilter) 对象。

  筛选条件。
+ `NextToken` – UTF-8 字符串。

  用于偏移结果的分页令牌。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的最大结果数量。

**响应**
+ `Runs` – [DataQualityRulesetEvaluationRunDescription](#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunDescription) 对象的数组。

  代表数据质量规则集规则的 `DataQualityRulesetEvaluationRunDescription` 对象列表。
+ `NextToken` – UTF-8 字符串。

  分页令牌（如果有更多结果可用）。

**错误**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## StartDataQualityRuleRecommendationRun 操作（Python：start\$1data\$1quality\$1rule\$1recommendation\$1run）
<a name="aws-glue-api-data-quality-api-StartDataQualityRuleRecommendationRun"></a>

当您不知道要写什么规则时，不妨开始用于生成规则的建议运行。AWS GlueData Quality 分析数据，并就潜在的规则集提出建议。然后，您可以对规则集进行分类，并根据自己的喜好修改生成的规则集。

建议运行在 90 天后被自动删除。

**请求**

数据质量规则建议请求的请求。
+ `DataSource` – *必填：*一个 [DataSource](#aws-glue-api-data-quality-api-DataSource) 对象。

  与此运行相关的数据源（AWS Glue 表）。
+ `Role` – *必填：*UTF-8 字符串。

  为加密运行结果而提供的 IAM 角色。
+ `NumberOfWorkers` – 数字（整数）。

  运行所用的 `G.1X` 工作线程数量。默认值为 5。
+ `Timeout` - 数字（整数），至少为 1。

  运行超时（分钟）。这是任务运行在终止并进入 `TIMEOUT` 状态前可以使用资源的最长时间。默认值为 2880 分钟（48 小时）。
+ `CreatedRulesetName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  规则集的名称。
+ `DataQualitySecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  使用数据质量加密选项创建的安全配置名称。
+ `ClientToken` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于幂等性，建议设置为随机 ID（例如，UUID），以避免创建或启动同一资源的多个实例。

**响应**
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与此运行关联的唯一运行标识符。

**错误**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ConflictException`

## CancelDataQualityRuleRecommendationRun 操作（Python：cancel\$1data\$1quality\$1rule\$1recommendation\$1run）
<a name="aws-glue-api-data-quality-api-CancelDataQualityRuleRecommendationRun"></a>

取消用于生成规则的指定建议运行。

**请求**
+ `RunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与此运行关联的唯一运行标识符。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## GetDataQualityRuleRecommendationRun 操作（Python：get\$1data\$1quality\$1rule\$1recommendation\$1run）
<a name="aws-glue-api-data-quality-api-GetDataQualityRuleRecommendationRun"></a>

获取用于生成规则的指定建议运行。

**请求**
+ `RunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与此运行关联的唯一运行标识符。

**响应**

运行的数据质量规则建议的响应。
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与此运行关联的唯一运行标识符。
+ `DataSource` – 一个 [DataSource](#aws-glue-api-data-quality-api-DataSource) 对象。

  与此运行相关的数据源（AWS Glue 表）。
+ `Role` – UTF-8 字符串。

  为加密运行结果而提供的 IAM 角色。
+ `NumberOfWorkers` – 数字（整数）。

  运行所用的 `G.1X` 工作线程数量。默认值为 5。
+ `Timeout` - 数字（整数），至少为 1。

  运行超时（分钟）。这是任务运行在终止并进入 `TIMEOUT` 状态前可以使用资源的最长时间。默认值为 2880 分钟（48 小时）。
+ `Status` – UTF-8 字符串（有效值：`RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`）。

  此运行的运行状态。
+ `ErrorString` – UTF-8 字符串。

  与运行关联的错误字符串。
+ `StartedOn` – 时间戳。

  此运行开始的日期和时间。
+ `LastModifiedOn` – 时间戳。

  时间戳。此数据质量规则建议运行最后一个修改时间点。
+ `CompletedOn` – 时间戳。

  此运行的完成日期和时间。
+ `ExecutionTime` – 数字（整数）。

  运行使用资源的时间长度（以秒为单位）。
+ `RecommendedRuleset` – UTF-8 字符串，长度不少于 1 个字节，不超过 65536 个字节。

  启动规则建议运行完成后，它会创建建议的规则集（一组规则）。该成员的规则采用数据质量定义语言（DQDL）格式。
+ `CreatedRulesetName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  运行创建的规则集的名称。
+ `DataQualitySecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  使用数据质量加密选项创建的安全配置名称。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## ListDataQualityRuleRecommendationRuns 操作（Python：list\$1data\$1quality\$1rule\$1recommendation\$1runs）
<a name="aws-glue-api-data-quality-api-ListDataQualityRuleRecommendationRuns"></a>

列出符合筛选条件的建议运行。

**请求**
+ `Filter` – 一个 [DataQualityRuleRecommendationRunFilter](#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunFilter) 对象。

  筛选条件。
+ `NextToken` – UTF-8 字符串。

  用于偏移结果的分页令牌。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的最大结果数量。

**响应**
+ `Runs` – [DataQualityRuleRecommendationRunDescription](#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunDescription) 对象的数组。

  `DataQualityRuleRecommendationRunDescription` 对象的列表。
+ `NextToken` – UTF-8 字符串。

  分页令牌（如果有更多结果可用）。

**错误**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## GetDataQualityResult 操作（Python：get\$1data\$1quality\$1result）
<a name="aws-glue-api-data-quality-api-GetDataQualityResult"></a>

检索数据质量规则评估的结果。

**请求**
+ `ResultId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据质量结果的唯一结果 ID。

**响应**

数据质量结果的响应。
+ `ResultId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据质量结果的唯一结果 ID。
+ `ProfileId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据质量结果的配置文件 ID。
+ `Score` – 数字（双数），不超过 1.0。

  汇总的数据质量分数。表示规则与传递到规则总数的比率。
+ `DataSource` – 一个 [DataSource](#aws-glue-api-data-quality-api-DataSource) 对象。

  与数据质量结果相关的表（如果有）。
+ `RulesetName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与数据质量结果相关的规则集的名称。
+ `EvaluationContext` – UTF-8 字符串。

  在 AWS Glue Studio 中的作业环境中，画布中的每个节点通常都被分配某种名称，数据质量节点也会有名称。如果有多个节点，则 `evaluationContext` 可以区分这些节点。
+ `StartedOn` – 时间戳。

  开始运行此数据质量结果的日期和时间。
+ `CompletedOn` – 时间戳。

  完成运行此数据质量结果的日期和时间。
+ `JobName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与数据质量结果相关的作业名称（如果有）。
+ `JobRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与数据质量结果相关的作业运行 ID（如果有）。
+ `RulesetEvaluationRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与规则集评估相关的唯一运行 ID。
+ `RuleResults` – 一组 [DataQualityRuleResult](#aws-glue-api-data-quality-api-DataQualityRuleResult) 对象，不超过 2000 个结构。

  代表每条规则结果的 `DataQualityRuleResult` 对象列表。
+ `AnalyzerResults` – 一组 [DataQualityAnalyzerResult](#aws-glue-api-data-quality-api-DataQualityAnalyzerResult) 对象，不超过 2000 个结构。

  代表每个分析器结果的 `DataQualityAnalyzerResult` 对象列表。
+ `Observations` – [DataQualityObservation](#aws-glue-api-data-quality-api-DataQualityObservation) 对象的数组，不超过 50 个结构。

  代表评估规则和分析器后生成的观测值的 `DataQualityObservation` 对象列表。
+ `AggregatedMetrics` – 一个 [DataQualityAggregatedMetrics](#aws-glue-api-data-quality-api-DataQualityAggregatedMetrics) 对象。

   `DataQualityAggregatedMetrics` 对象的摘要，将显示已处理的行和规则总数，包括基于行级结果的通过/失败统计信息。

**错误**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `EntityNotFoundException`

## BatchGetDataQualityResult 操作（Python：batch\$1get\$1data\$1quality\$1result）
<a name="aws-glue-api-data-quality-api-BatchGetDataQualityResult"></a>

检索指定结果 ID 的数据质量结果列表。

**请求**
+ `ResultIds` – *必填：*UTF-8 字符串数组，不少于 1 个字符串，不超过 100 个字符串。

  数据质量结果的唯一结果 ID 列表。

**响应**
+ `Results` – *必填：*[DataQualityResult](#aws-glue-api-data-quality-api-DataQualityResult) 对象的数组。

  代表数据质量规则集的 `DataQualityResult` 对象列表。
+ `ResultsNotFound` – UTF-8 字符串数组，不少于 1 个字符串，不超过 100 个字符串。

  未找到结果的结果 ID 列表。

**错误**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## ListDataQualityResults 操作（Python：list\$1data\$1quality\$1results）
<a name="aws-glue-api-data-quality-api-ListDataQualityResults"></a>

返回您账户的所有数据质量执行结果。

**请求**
+ `Filter` – 一个 [DataQualityResultFilterCriteria](#aws-glue-api-data-quality-api-DataQualityResultFilterCriteria) 对象。

  筛选条件。
+ `NextToken` – UTF-8 字符串。

  用于偏移结果的分页令牌。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的最大结果数量。

**响应**
+ `Results` – *必填：*[DataQualityResultDescription](#aws-glue-api-data-quality-api-DataQualityResultDescription) 对象的数组。

  `DataQualityResultDescription` 对象的列表。
+ `NextToken` – UTF-8 字符串。

  分页令牌（如果有更多结果可用）。

**错误**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## CreateDataQualityRuleset 操作（Python：create\$1data\$1quality\$1ruleset）
<a name="aws-glue-api-data-quality-api-CreateDataQualityRuleset"></a>

创建数据质量规则集，将 DQDL 规则应用于指定 AWS Glue 表。

您可以使用数据质量定义语言 (DQDL) 创建规则集。有关更多信息，请参见 AWS Glue 开发人员指南。

**请求**

创建数据质量规则集的请求。
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据质量规则集的唯一名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  数据质量规则集的描述。
+ `Ruleset` – *必填：* UTF-8 字符串，长度不少于 1 个字节，不超过 65536 个字节。

  数据质量定义语言（DQDL）规则集。有关更多信息，请参见 AWS Glue 开发人员指南。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  应用于数据质量规则集的标签列表。
+ `TargetTable` – 一个 [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable) 对象。

  与数据质量规则集关联的目标表。
+ `RecommendationRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  建议运行的唯一运行 ID。
+ `DataQualitySecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  使用数据质量加密选项创建的安全配置名称。
+ `ClientToken` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于幂等性，建议设置为随机 ID（例如，UUID），以避免创建或启动同一资源的多个实例。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据质量规则集的唯一名称。

**错误**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ResourceNumberLimitExceededException`

## DeleteDataQualityRuleset 操作（Python：delete\$1data\$1quality\$1ruleset）
<a name="aws-glue-api-data-quality-api-DeleteDataQualityRuleset"></a>

删除数据质量规则集。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据质量规则集的名称。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## GetDataQualityRuleset 操作（Python：get\$1data\$1quality\$1ruleset）
<a name="aws-glue-api-data-quality-api-GetDataQualityRuleset"></a>

按标识符或名称返回现有规则集。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  规则集的名称。

**响应**

返回数据质量规则集响应。
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  规则集的名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  规则集的描述。
+ `Ruleset` – UTF-8 字符串，长度不少于 1 个字节，不超过 65536 个字节。

  数据质量定义语言（DQDL）规则集。有关更多信息，请参见 AWS Glue 开发人员指南。
+ `TargetTable` – 一个 [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable) 对象。

  目标表的名称和数据库名称。
+ `CreatedOn` – 时间戳。

  时间戳。此数据质量规则集的创建时间和日期。
+ `LastModifiedOn` – 时间戳。

  时间戳。此数据质量规则最后一个修改时间点。
+ `RecommendationRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  当根据建议运行创建规则集时，会生成此运行 ID 以将两者联系在一起。
+ `DataQualitySecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  使用数据质量加密选项创建的安全配置名称。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## ListDataQualityRulesets 操作（Python：list\$1data\$1quality\$1rulesets）
<a name="aws-glue-api-data-quality-api-ListDataQualityRulesets"></a>

返回指定 AWS Glue 表列表的分页规则集列表。

**请求**
+ `NextToken` – UTF-8 字符串。

  用于偏移结果的分页令牌。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的最大结果数量。
+ `Filter` – 一个 [DataQualityRulesetFilterCriteria](#aws-glue-api-data-quality-api-DataQualityRulesetFilterCriteria) 对象。

  筛选条件。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  键值对标签的列表。

**响应**
+ `Rulesets` – [DataQualityRulesetListDetails](#aws-glue-api-data-quality-api-DataQualityRulesetListDetails) 对象的数组。

  指定 AWS Glue 表列表的分页规则集列表。
+ `NextToken` – UTF-8 字符串。

  分页令牌（如果有更多结果可用）。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## UpdateDataQualityRuleset 操作（Python：update\$1data\$1quality\$1ruleset）
<a name="aws-glue-api-data-quality-api-UpdateDataQualityRuleset"></a>

更新指定的数据质量规则集。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据质量规则集的名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  规则集的描述。
+ `Ruleset` – UTF-8 字符串，长度不少于 1 个字节，不超过 65536 个字节。

  数据质量定义语言（DQDL）规则集。有关更多信息，请参见 AWS Glue 开发人员指南。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据质量规则集的名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  规则集的描述。
+ `Ruleset` – UTF-8 字符串，长度不少于 1 个字节，不超过 65536 个字节。

  数据质量定义语言（DQDL）规则集。有关更多信息，请参见 AWS Glue 开发人员指南。

**错误**
+ `EntityNotFoundException`
+ `AlreadyExistsException`
+ `IdempotentParameterMismatchException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ResourceNumberLimitExceededException`

## ListDataQualityStatistics 操作（Python：list\$1data\$1quality\$1statistics）
<a name="aws-glue-api-data-quality-api-ListDataQualityStatistics"></a>

检索数据质量统计数据列表。

**请求**
+ `StatisticId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  统计信息 ID。
+ `ProfileId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  配置文件 ID。
+ `TimestampFilter` – 一个 [TimestampFilter](#aws-glue-api-data-quality-api-TimestampFilter) 对象。

  时间戳筛选条件。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  此请求中要返回的最大结果数。
+ `NextToken` – UTF-8 字符串。

  用于请求下一页结果的分页标记。

**响应**
+ `Statistics` – [StatisticSummary](#aws-glue-api-data-quality-api-StatisticSummary) 对象的数组。

  一个 `StatisticSummaryList`。
+ `NextToken` – UTF-8 字符串。

  用于请求下一页结果的分页标记。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`

## TimestampFilter 结构
<a name="aws-glue-api-data-quality-api-TimestampFilter"></a>

时间戳筛选条件。

**字段**
+ `RecordedBefore` – 时间戳。

  应在结果中包含统计信息的截止时间戳。
+ `RecordedAfter` – 时间戳。

  应在结果中包含统计信息的起始时间戳。

## CreateDataQualityRulesetRequest 结构
<a name="aws-glue-api-data-quality-api-CreateDataQualityRulesetRequest"></a>

创建数据质量规则集的请求。

**字段**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据质量规则集的唯一名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  数据质量规则集的描述。
+ `Ruleset` – *必填：* UTF-8 字符串，长度不少于 1 个字节，不超过 65536 个字节。

  数据质量定义语言（DQDL）规则集。有关更多信息，请参见 AWS Glue 开发人员指南。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  应用于数据质量规则集的标签列表。
+ `TargetTable` – 一个 [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable) 对象。

  与数据质量规则集关联的目标表。
+ `RecommendationRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  建议运行的唯一运行 ID。
+ `DataQualitySecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  使用数据质量加密选项创建的安全配置名称。
+ `ClientToken` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于幂等性，建议设置为随机 ID（例如，UUID），以避免创建或启动同一资源的多个实例。

## GetDataQualityRulesetResponse 结构
<a name="aws-glue-api-data-quality-api-GetDataQualityRulesetResponse"></a>

返回数据质量规则集响应。

**字段**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  规则集的名称。
+ `Description` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。

  规则集的描述。
+ `Ruleset` – UTF-8 字符串，长度不少于 1 个字节，不超过 65536 个字节。

  数据质量定义语言（DQDL）规则集。有关更多信息，请参见 AWS Glue 开发人员指南。
+ `TargetTable` – 一个 [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable) 对象。

  目标表的名称和数据库名称。
+ `CreatedOn` – 时间戳。

  时间戳。此数据质量规则集的创建时间和日期。
+ `LastModifiedOn` – 时间戳。

  时间戳。此数据质量规则最后一个修改时间点。
+ `RecommendationRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  当根据建议运行创建规则集时，会生成此运行 ID 以将两者联系在一起。
+ `DataQualitySecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  使用数据质量加密选项创建的安全配置名称。

## GetDataQualityResultResponse 结构
<a name="aws-glue-api-data-quality-api-GetDataQualityResultResponse"></a>

数据质量结果的响应。

**字段**
+ `ResultId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据质量结果的唯一结果 ID。
+ `ProfileId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  数据质量结果的配置文件 ID。
+ `Score` – 数字（双数），不超过 1.0。

  汇总的数据质量分数。表示规则与传递到规则总数的比率。
+ `DataSource` – 一个 [DataSource](#aws-glue-api-data-quality-api-DataSource) 对象。

  与数据质量结果相关的表（如果有）。
+ `RulesetName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与数据质量结果相关的规则集的名称。
+ `EvaluationContext` – UTF-8 字符串。

  在 AWS Glue Studio 中的作业环境中，画布中的每个节点通常都被分配某种名称，数据质量节点也会有名称。如果有多个节点，则 `evaluationContext` 可以区分这些节点。
+ `StartedOn` – 时间戳。

  开始运行此数据质量结果的日期和时间。
+ `CompletedOn` – 时间戳。

  完成运行此数据质量结果的日期和时间。
+ `JobName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与数据质量结果相关的作业名称（如果有）。
+ `JobRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与数据质量结果相关的作业运行 ID（如果有）。
+ `RulesetEvaluationRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与规则集评估相关的唯一运行 ID。
+ `RuleResults` – 一组 [DataQualityRuleResult](#aws-glue-api-data-quality-api-DataQualityRuleResult) 对象，不超过 2000 个结构。

  代表每条规则结果的 `DataQualityRuleResult` 对象列表。
+ `AnalyzerResults` – 一组 [DataQualityAnalyzerResult](#aws-glue-api-data-quality-api-DataQualityAnalyzerResult) 对象，不超过 2000 个结构。

  代表每个分析器结果的 `DataQualityAnalyzerResult` 对象列表。
+ `Observations` – [DataQualityObservation](#aws-glue-api-data-quality-api-DataQualityObservation) 对象的数组，不超过 50 个结构。

  代表评估规则和分析器后生成的观测值的 `DataQualityObservation` 对象列表。
+ `AggregatedMetrics` – 一个 [DataQualityAggregatedMetrics](#aws-glue-api-data-quality-api-DataQualityAggregatedMetrics) 对象。

   `DataQualityAggregatedMetrics` 对象的摘要，将显示已处理的行和规则总数，包括基于行级结果的通过/失败统计信息。

## StartDataQualityRuleRecommendationRunRequest 结构
<a name="aws-glue-api-data-quality-api-StartDataQualityRuleRecommendationRunRequest"></a>

数据质量规则建议请求的请求。

**字段**
+ `DataSource` – *必填：*一个 [DataSource](#aws-glue-api-data-quality-api-DataSource) 对象。

  与此运行相关的数据源（AWS Glue 表）。
+ `Role` – *必填：*UTF-8 字符串。

  为加密运行结果而提供的 IAM 角色。
+ `NumberOfWorkers` – 数字（整数）。

  运行所用的 `G.1X` 工作线程数量。默认值为 5。
+ `Timeout` - 数字（整数），至少为 1。

  运行超时（分钟）。这是任务运行在终止并进入 `TIMEOUT` 状态前可以使用资源的最长时间。默认值为 2880 分钟（48 小时）。
+ `CreatedRulesetName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  规则集的名称。
+ `DataQualitySecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  使用数据质量加密选项创建的安全配置名称。
+ `ClientToken` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于幂等性，建议设置为随机 ID（例如，UUID），以避免创建或启动同一资源的多个实例。

## GetDataQualityRuleRecommendationRunResponse 结构
<a name="aws-glue-api-data-quality-api-GetDataQualityRuleRecommendationRunResponse"></a>

运行的数据质量规则建议的响应。

**字段**
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  与此运行关联的唯一运行标识符。
+ `DataSource` – 一个 [DataSource](#aws-glue-api-data-quality-api-DataSource) 对象。

  与此运行相关的数据源（AWS Glue 表）。
+ `Role` – UTF-8 字符串。

  为加密运行结果而提供的 IAM 角色。
+ `NumberOfWorkers` – 数字（整数）。

  运行所用的 `G.1X` 工作线程数量。默认值为 5。
+ `Timeout` - 数字（整数），至少为 1。

  运行超时（分钟）。这是任务运行在终止并进入 `TIMEOUT` 状态前可以使用资源的最长时间。默认值为 2880 分钟（48 小时）。
+ `Status` – UTF-8 字符串（有效值：`RUNNING` \$1 `FINISHED` \$1 `FAILED` \$1 `PENDING_EXECUTION` \$1 `TIMED_OUT` \$1 `CANCELING` \$1 `CANCELED` \$1 `RECEIVED_BY_TASKRUNNER`）。

  此运行的运行状态。
+ `ErrorString` – UTF-8 字符串。

  与运行关联的错误字符串。
+ `StartedOn` – 时间戳。

  此运行开始的日期和时间。
+ `LastModifiedOn` – 时间戳。

  时间戳。此数据质量规则建议运行最后一个修改时间点。
+ `CompletedOn` – 时间戳。

  此运行的完成日期和时间。
+ `ExecutionTime` – 数字（整数）。

  运行使用资源的时间长度（以秒为单位）。
+ `RecommendedRuleset` – UTF-8 字符串，长度不少于 1 个字节，不超过 65536 个字节。

  启动规则建议运行完成后，它会创建建议的规则集（一组规则）。该成员的规则采用数据质量定义语言（DQDL）格式。
+ `CreatedRulesetName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  运行创建的规则集的名称。
+ `DataQualitySecurityConfiguration` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  使用数据质量加密选项创建的安全配置名称。

## BatchPutDataQualityStatisticAnnotation 操作（Python：batch\$1put\$1data\$1quality\$1statistic\$1annotation）
<a name="aws-glue-api-data-quality-api-BatchPutDataQualityStatisticAnnotation"></a>

为特定数据质量统计数据随时间变化的数据点添加注释。对于该 API，InclusionAnnotation 输入必须同时包含 profileID 和 statisticID。该 API 仅支持将单个 statisticId 用于多个配置文件。

**请求**
+ `InclusionAnnotations` – *必填：*[DatapointInclusionAnnotation](#aws-glue-api-data-quality-api-DatapointInclusionAnnotation) 对象的数组。

  `DatapointInclusionAnnotation` 的列表。InclusionAnnotations 必须包含 profileId 和 statisticId。如有多个 InclusionAnnotations，则该列表必须引用涵盖多个 profileId 的单个 statisticId。
+ `ClientToken` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  客户端令牌。

**响应**
+ `FailedInclusionAnnotations` – [AnnotationError](#aws-glue-api-data-quality-api-AnnotationError) 对象的数组。

  `AnnotationError` 的列表。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `ResourceNumberLimitExceededException`

## GetDataQualityModel 操作（Python：get\$1data\$1quality\$1model）
<a name="aws-glue-api-data-quality-api-GetDataQualityModel"></a>

检索模型的训练状态以及更多信息（CompletedOn、StartedOn、FailureReason）。

**请求**
+ `StatisticId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  统计信息 ID。
+ `ProfileId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  配置文件 ID。

**响应**
+ `Status` – UTF-8 字符串（有效值：`RUNNING` \$1 `SUCCEEDED` \$1 `FAILED`）。

  数据质量模型的训练状态。
+ `StartedOn` – 时间戳。

  数据质量模型训练开始的时间戳。
+ `CompletedOn` – 时间戳。

  数据质量模型训练完成的时间戳。
+ `FailureReason` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  训练失败的原因。

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## GetDataQualityModelResult 操作（Python：get\$1data\$1quality\$1model\$1result）
<a name="aws-glue-api-data-quality-api-GetDataQualityModelResult"></a>

针对给定个人资料 ID 检索统计数据的预测。

**请求**
+ `StatisticId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  统计信息 ID。
+ `ProfileId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  配置文件 ID。

**响应**
+ `CompletedOn` – 时间戳。

  数据质量模型训练完成的时间戳。
+ `Model` – [StatisticModelResult](#aws-glue-api-data-quality-api-StatisticModelResult) 对象的数组。

  `StatisticModelResult` 列表

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## ListDataQualityStatisticAnnotations 操作（Python：list\$1data\$1quality\$1statistic\$1annotations）
<a name="aws-glue-api-data-quality-api-ListDataQualityStatisticAnnotations"></a>

检索数据质量统计数据的注释。

**请求**
+ `StatisticId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  统计信息 ID。
+ `ProfileId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  配置文件 ID。
+ `TimestampFilter` – 一个 [TimestampFilter](#aws-glue-api-data-quality-api-TimestampFilter) 对象。

  时间戳筛选条件。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  此请求中要返回的最大结果数。
+ `NextToken` – UTF-8 字符串。

  用于检索下一组结果的分页标记。

**响应**
+ `Annotations` – [StatisticAnnotation](#aws-glue-api-data-quality-api-StatisticAnnotation) 对象的数组。

  已应用于统计数据的 `StatisticAnnotation` 的列表
+ `NextToken` – UTF-8 字符串。

  用于检索下一组结果的分页标记。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`

## PutDataQualityProfileAnnotation 操作（Python：put\$1data\$1quality\$1profile\$1annotation）
<a name="aws-glue-api-data-quality-api-PutDataQualityProfileAnnotation"></a>

为某一个人资料的所有数据点添加注释。

**请求**
+ `ProfileId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要注释的数据质量监控配置文件的 ID。
+ `InclusionAnnotation` – *必填：*UTF-8 字符串（有效值：`INCLUDE` \$1 `EXCLUDE`）。

  要应用于配置文件的包含注释值。

**响应**
+ *无响应参数。*

**错误**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`

# 敏感数据检测 API
<a name="aws-glue-api-sensitive-data-api"></a>

敏感数据检测 API 描述了用于在结构化数据的列和行中检测敏感数据的 API。

## 数据类型
<a name="aws-glue-api-sensitive-data-api-objects"></a>
+ [CustomEntityType 结构](#aws-glue-api-sensitive-data-api-CustomEntityType)

## CustomEntityType 结构
<a name="aws-glue-api-sensitive-data-api-CustomEntityType"></a>

表示用于在结构化数据的列和行中检测敏感数据的自定义模式的对象。

**字段**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  允许稍后检索或删除的自定义模式的名称。对于每个 AWS 账户来说，该名称必须是唯一的。
+ `RegexString` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于检测自定义模式中敏感数据的正则表达式字符串。
+ `ContextWords` – UTF-8 字符串数组，不少于 1 个字符串，不超过 20 个字符串。

  上下文字词列表。如果在正则表达式附近找不到这些上下文字词，则数据将不会被检测为敏感数据。

  如果没有传递上下文字词，则只检查正则表达式。

## 操作
<a name="aws-glue-api-sensitive-data-api-actions"></a>
+ [CreateCustomEntityType 操作（Python：create\$1custom\$1entity\$1type）](#aws-glue-api-sensitive-data-api-CreateCustomEntityType)
+ [DeleteCustomEntityType 操作（Python：delete\$1custom\$1entity\$1type）](#aws-glue-api-sensitive-data-api-DeleteCustomEntityType)
+ [GetCustomEntityType 操作（Python：get\$1custom\$1entity\$1type）](#aws-glue-api-sensitive-data-api-GetCustomEntityType)
+ [BatchGetCustomEntityTypes 操作（Python：batch\$1get\$1ustom\$1entity\$1type）](#aws-glue-api-sensitive-data-api-BatchGetCustomEntityTypes)
+ [ListCustomEntityTypes 操作（Python：list\$1custom\$1entity\$1type）](#aws-glue-api-sensitive-data-api-ListCustomEntityTypes)

## CreateCustomEntityType 操作（Python：create\$1custom\$1entity\$1type）
<a name="aws-glue-api-sensitive-data-api-CreateCustomEntityType"></a>

创建自定义模式，用于在结构化数据的列和行中检测敏感数据。

您创建的每个自定义模式都会指定一个正则表达式和上下文字词的可选列表。如果没有传递上下文字词，则只检查正则表达式。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  允许稍后检索或删除的自定义模式的名称。对于每个 AWS 账户来说，该名称必须是唯一的。
+ `RegexString` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于检测自定义模式中敏感数据的正则表达式字符串。
+ `ContextWords` – UTF-8 字符串数组，不少于 1 个字符串，不超过 20 个字符串。

  上下文字词列表。如果在正则表达式附近找不到这些上下文字词，则数据将不会被检测为敏感数据。

  如果没有传递上下文字词，则只检查正则表达式。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  应用于自定义实体类型的标签列表。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  您创建的自定义模式的名称。

**错误**
+ `AccessDeniedException`
+ `AlreadyExistsException`
+ `IdempotentParameterMismatchException`
+ `InternalServiceException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`

## DeleteCustomEntityType 操作（Python：delete\$1custom\$1entity\$1type）
<a name="aws-glue-api-sensitive-data-api-DeleteCustomEntityType"></a>

通过指定自定义模式名称来将其删除。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要删除的自定义模式的名称。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  已删除的自定义模式的名称。

**错误**
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `InternalServiceException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## GetCustomEntityType 操作（Python：get\$1custom\$1entity\$1type）
<a name="aws-glue-api-sensitive-data-api-GetCustomEntityType"></a>

通过指定自定义模式名称来检索其详细信息。

**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  要检索的自定义模式的名称。

**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  已检索的自定义模式的名称。
+ `RegexString` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  用于检测自定义模式中敏感数据的正则表达式字符串。
+ `ContextWords` – UTF-8 字符串数组，不少于 1 个字符串，不超过 20 个字符串。

  上下文字词列表（如在创建自定义模式时指定）。如果在正则表达式附近找不到这些上下文字词，则数据将不会被检测为敏感数据。

**错误**
+ `EntityNotFoundException`
+ `AccessDeniedException`
+ `InternalServiceException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## BatchGetCustomEntityTypes 操作（Python：batch\$1get\$1ustom\$1entity\$1type）
<a name="aws-glue-api-sensitive-data-api-BatchGetCustomEntityTypes"></a>

检索名称列表指定的自定义模式的详细信息。

**请求**
+ `Names` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 50 个字符串。

  要检索的自定义模式的名称列表。

**响应**
+ `CustomEntityTypes` – [CustomEntityType](#aws-glue-api-sensitive-data-api-CustomEntityType) 对象的数组。

  表示已创建的自定义模式的 `CustomEntityType` 对象列表。
+ `CustomEntityTypesNotFound` – UTF-8 字符串数组，不少于 1 个字符串，不超过 50 个字符串。

  未找到的自定义模式名称列表。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`

## ListCustomEntityTypes 操作（Python：list\$1custom\$1entity\$1type）
<a name="aws-glue-api-sensitive-data-api-ListCustomEntityTypes"></a>

列出所有已创建的自定义模式。

**请求**
+ `NextToken` – UTF-8 字符串。

  用于偏移结果的分页令牌。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。

  要返回的最大结果数量。
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  键值对标签的列表。

**响应**
+ `CustomEntityTypes` – [CustomEntityType](#aws-glue-api-sensitive-data-api-CustomEntityType) 对象的数组。

  表示自定义模式的 `CustomEntityType` 对象列表。
+ `NextToken` – UTF-8 字符串。

  分页令牌（如果有更多结果可用）。

**错误**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

# AWS Glue 中的标记 API
<a name="aws-glue-api-tags"></a>

## 数据类型
<a name="aws-glue-api-tags-objects"></a>
+ [Tag 结构](#aws-glue-api-tags-Tag)

## Tag 结构
<a name="aws-glue-api-tags-Tag"></a>

`Tag` 对象表示用户可分配给 AWS 资源的标签。每个标签都包含定义的一个键和一个可选值。

有关标签以及如何控制对 AWS Glue 中资源的访问的更多信息，请参阅开发人员指南中的 [AWS Glue 中的 AWS 标签](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html)和[指定 AWS Glue 资源 ARN](https://docs.aws.amazon.com/glue/latest/dg/glue-specifying-resource-arns.html)。

**Fields**
+ `key` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  标签键。在对象上创建标签时需要这个键。键区分大小写，并且不得包含前缀 aws。
+ `value` – UTF-8 字符串，不超过 256 个字节。

  标签值。在对象上创建标签时，值是可选的。值区分大小写，并且不得包含前缀 aws。

## 操作
<a name="aws-glue-api-tags-actions"></a>
+ [TagResource 操作（Python：tag\$1resource）](#aws-glue-api-tags-TagResource)
+ [UntagResource 操作（Python：untag\$1resource）](#aws-glue-api-tags-UntagResource)
+ [GetTags 操作（Python：get\$1tags）](#aws-glue-api-tags-GetTags)

## TagResource 操作（Python：tag\$1resource）
<a name="aws-glue-api-tags-TagResource"></a>

为资源添加标签。标签是为 AWS 资源分配的标记。在 AWS Glue 中，您只能为特定资源添加标签。有关可添加标签的资源的信息，请参阅 [AWS Glue 中的 AWS 标签](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html)。

除了调用标签相关的 API 的标记权限外，您还需要在连接上调用标记 API 的 `glue:GetConnection` 权限以及对数据库调用标记 API 的 `glue:GetDatabase` 权限。

**请求**
+ `ResourceArn` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  要向其添加标签的 AWS Glue 资源的 ARN。有关 AWS Glue 资源 ARN 的更多信息，请参阅 [AWS Glue ARN 字符串模式](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html#aws-glue-api-regex-aws-glue-arn-id)。
+ `TagsToAdd` – *必填*：键值对的映射数组，不超过 50 对。

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

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

  要添加到此资源的标签。

**响应**
+ *无响应参数。*

**错误**
+ `ResourceNotFoundException`

## UntagResource 操作（Python：untag\$1resource）
<a name="aws-glue-api-tags-UntagResource"></a>

从集成资源中删除指定的标签。

**请求**
+ `ResourceArn` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  集成资源的 Amazon 资源名称 (ARN)。
+ `TagsToRemove` – *必填*：UTF-8 字符串数组，不超过 50 个字符串。

  要从资源中删除的元数据标签列表。

**响应**
+ *无响应参数。*

**错误**
+ `ResourceNotFoundException`

## GetTags 操作（Python：get\$1tags）
<a name="aws-glue-api-tags-GetTags"></a>

检索与资源关联的标签的列表。

**请求**
+ `ResourceArn` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 [Custom string pattern #50](aws-glue-api-common.md#regex_50) 匹配。

  要检索其标签的资源的 Amazon Resource Name（ARN）。

**响应**
+ `Tags` – 键值对的映射数组，不超过 50 对。

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

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

  请求的标签。

**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `EntityNotFoundException`

# 常见数据类型
<a name="aws-glue-api-common"></a>

常见数据类型介绍 AWS Glue 中的各种常见的数据类型。

## Tag 结构
<a name="aws-glue-api-common-Tag"></a>

`Tag` 对象表示用户可分配给 AWS 资源的标签。每个标签都包含定义的一个键和一个可选值。

有关标签以及如何控制对 AWS Glue 中资源的访问的更多信息，请参阅开发人员指南中的 [AWS Glue 中的 AWS 标签](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html)和[指定 AWS Glue 资源 ARN](https://docs.aws.amazon.com/glue/latest/dg/glue-specifying-resource-arns.html)。

**字段**
+ `key` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  标签键。在对象上创建标签时需要这个键。键区分大小写，并且不得包含前缀 aws。
+ `value` – UTF-8 字符串，不超过 256 个字节。

  标签值。在对象上创建标签时，值是可选的。值区分大小写，并且不得包含前缀 aws。

## DecimalNumber 结构
<a name="aws-glue-api-common-DecimalNumber"></a>

包含以十进制格式表示的数字值。

**字段**
+ `UnscaledValue` – *必填*：Blob。

  未标定的数字值。
+ `Scale` – *必填*：数字（整数）。

  确定小数点落在未标定的值中的位置的标定。

## ErrorDetail 结构
<a name="aws-glue-api-common-ErrorDetail"></a>

包含有关错误的详细信息。

**字段**
+ `ErrorCode` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](#aws-glue-api-regex-oneLine) 匹配。

  与此错误关联的代码。
+ `ErrorMessage` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](#aws-glue-api-regex-uri) 匹配。

  描述错误的消息。

## PropertyPredicate 结构
<a name="aws-glue-api-common-PropertyPredicate"></a>

定义属性谓词。

**字段**
+ `Key`：值字符串，长度不少于 1 个字节，不超过 1024 个字节。

  属性的键。
+ `Value`：值字符串，长度不少于 1 个字节，不超过 1024 个字节。

  属性的值。
+ `Comparator` – UTF-8 字符串（有效值：`EQUALS` \$1 `GREATER_THAN` \$1 `LESS_THAN` \$1 `GREATER_THAN_EQUALS` \$1 `LESS_THAN_EQUALS`）。

  用于将此属性与其他属性进行比较的比较运算符。

## ResourceUri 结构
<a name="aws-glue-api-common-ResourceUri"></a>

函数资源的 URI。

**字段**
+ `ResourceType` – UTF-8 字符串（有效值：`JAR` \$1 `FILE` \$1 `ARCHIVE`）。

  资源的类型。
+ `Uri` - 统一资源标识符 (uri)，不少于 1 个字节或超过 1024 个字节，与 [URI address multi-line string pattern](#aws-glue-api-regex-uri) 匹配。

  用于访问资源的 URI。

## ColumnStatistics 结构
<a name="aws-glue-api-common-ColumnStatistics"></a>

表示表或分区生成的列级统计数据。

**字段**
+ `ColumnName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](#aws-glue-api-regex-oneLine) 匹配。

  统计数据所属列的名称。
+ `ColumnType` – *必填*：类型名称，长度不超过 20000 个字节，与 [Single-line string pattern](#aws-glue-api-regex-oneLine) 匹配。

  列的数据类型。
+ `AnalyzedTime` – *必填*：时间戳。

  生成列统计数据的时间戳。
+ `StatisticsData` – *必填：*一个 [ColumnStatisticsData](#aws-glue-api-common-ColumnStatisticsData) 对象。

  `ColumnStatisticData` 对象，其中包含统计数据值。

## ColumnStatisticsError 结构
<a name="aws-glue-api-common-ColumnStatisticsError"></a>

封装失败的 `ColumnStatistics` 对象以及失败原因。

**字段**
+ `ColumnStatistics` – 一个 [ColumnStatistics](#aws-glue-api-common-ColumnStatistics) 对象。

  列的 `ColumnStatistics`。
+ `Error` – 一个 [ErrorDetail](#aws-glue-api-common-ErrorDetail) 对象。

  包含操作失败原因的错误消息。

## ColumnError 结构
<a name="aws-glue-api-common-ColumnError"></a>

封装失败的列名称以及失败原因。

**字段**
+ `ColumnName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](#aws-glue-api-regex-oneLine) 匹配。

  封装失败的列名称。
+ `Error` – 一个 [ErrorDetail](#aws-glue-api-common-ErrorDetail) 对象。

  包含操作失败原因的错误消息。

## ColumnStatisticsData 结构
<a name="aws-glue-api-common-ColumnStatisticsData"></a>

包含单个类型的列统计数据。只应设置一个数据对象，并由 `Type` 属性指示。

**字段**
+ `Type` – *必填*：UTF-8 字符串（有效值：`BOOLEAN` \$1 `DATE` \$1 `DECIMAL` \$1 `DOUBLE` \$1 `LONG` \$1 `STRING` \$1 `BINARY`）。

  列统计数据的类型。
+ `BooleanColumnStatisticsData` – 一个 [BooleanColumnStatisticsData](#aws-glue-api-common-BooleanColumnStatisticsData) 对象。

  布尔值列统计数据。
+ `DateColumnStatisticsData` – 一个 [DateColumnStatisticsData](#aws-glue-api-common-DateColumnStatisticsData) 对象。

  日期列统计数据。
+ `DecimalColumnStatisticsData` – 一个 [DecimalColumnStatisticsData](#aws-glue-api-common-DecimalColumnStatisticsData) 对象。

   十进制列统计数据。其中的 UnscaledValues 是 Base64 编码的二进制对象，存储十进制未缩放值的大端二进制补码表示法。
+ `DoubleColumnStatisticsData` – 一个 [DoubleColumnStatisticsData](#aws-glue-api-common-DoubleColumnStatisticsData) 对象。

  双列统计数据。
+ `LongColumnStatisticsData` – 一个 [LongColumnStatisticsData](#aws-glue-api-common-LongColumnStatisticsData) 对象。

  长列统计数据。
+ `StringColumnStatisticsData` – 一个 [StringColumnStatisticsData](#aws-glue-api-common-StringColumnStatisticsData) 对象。

  字符串列统计数据。
+ `BinaryColumnStatisticsData` – 一个 [BinaryColumnStatisticsData](#aws-glue-api-common-BinaryColumnStatisticsData) 对象。

  二进制列统计数据。

## BooleanColumnStatisticsData 结构
<a name="aws-glue-api-common-BooleanColumnStatisticsData"></a>

定义支持布尔值数据列的列统计数据。

**字段**
+ `NumberOfTrues` – *必填*：数字（长度），至多为“无”。

  列中的 True 值数量。
+ `NumberOfFalses` – *必填*：数字（长度），至多为“无”。

  列中的 False 数量。
+ `NumberOfNulls` – *必填*：数字（长度），至多为“无”。

  列中空值的数量。

## DateColumnStatisticsData 结构
<a name="aws-glue-api-common-DateColumnStatisticsData"></a>

定义支持时间戳数据列的列统计数据。

**字段**
+ `MinimumValue` – 时间戳。

  列中的最低值。
+ `MaximumValue` – 时间戳。

  列中的最高值。
+ `NumberOfNulls` – *必填*：数字（长度），至多为“无”。

  列中空值的数量。
+ `NumberOfDistinctValues` – *必填*：数字（长度），至多为“无”。

  列中的独特值的数量。

## DecimalColumnStatisticsData 结构
<a name="aws-glue-api-common-DecimalColumnStatisticsData"></a>

定义支持固定点数数据列的列统计数据。

**字段**
+ `MinimumValue` – 一个 [DecimalNumber](#aws-glue-api-common-DecimalNumber) 对象。

  列中的最低值。
+ `MaximumValue` – 一个 [DecimalNumber](#aws-glue-api-common-DecimalNumber) 对象。

  列中的最高值。
+ `NumberOfNulls` – *必填*：数字（长度），至多为“无”。

  列中空值的数量。
+ `NumberOfDistinctValues` – *必填*：数字（长度），至多为“无”。

  列中的独特值的数量。

## DoubleColumnStatisticsData 结构
<a name="aws-glue-api-common-DoubleColumnStatisticsData"></a>

定义支持浮动点数数据列的列统计数据。

**字段**
+ `MinimumValue` – 数字（double）。

  列中的最低值。
+ `MaximumValue` – 数字（double）。

  列中的最高值。
+ `NumberOfNulls` – *必填*：数字（长度），至多为“无”。

  列中空值的数量。
+ `NumberOfDistinctValues` – *必填*：数字（长度），至多为“无”。

  列中的独特值的数量。

## LongColumnStatisticsData 结构
<a name="aws-glue-api-common-LongColumnStatisticsData"></a>

定义支持整数数据列的列统计数据。

**字段**
+ `MinimumValue` – 数字（长型）。

  列中的最低值。
+ `MaximumValue` – 数字（长型）。

  列中的最高值。
+ `NumberOfNulls` – *必填*：数字（长度），至多为“无”。

  列中空值的数量。
+ `NumberOfDistinctValues` – *必填*：数字（长度），至多为“无”。

  列中的独特值的数量。

## StringColumnStatisticsData 结构
<a name="aws-glue-api-common-StringColumnStatisticsData"></a>

定义支持字符序列数据值的列统计数据。

**字段**
+ `MaximumLength` – *必填*：数字（长度），至多为“无”。

  列中最长字符串的长度。
+ `AverageLength` – *必填*：数字（长度），至多为“无”。

  列中的平均字符串长度。
+ `NumberOfNulls` – *必填*：数字（长度），至多为“无”。

  列中空值的数量。
+ `NumberOfDistinctValues` – *必填*：数字（长度），至多为“无”。

  列中的独特值的数量。

## BinaryColumnStatisticsData 结构
<a name="aws-glue-api-common-BinaryColumnStatisticsData"></a>

定义支持位序列数据值的列统计数据。

**字段**
+ `MaximumLength` – *必填*：数字（长度），至多为“无”。

  列中最长位序列的长度。
+ `AverageLength` – *必填*：数字（长度），至多为“无”。

  列中的平均位序列长度。
+ `NumberOfNulls` – *必填*：数字（长度），至多为“无”。

  列中空值的数量。

## 字符串模式
<a name="aws-glue-api-common-_string-patterns"></a>

API 使用以下正则表达式来定义对于各种字符串参数和成员有效的内容：
+ 单行字符串模式 -“`[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*`”
+ URI 地址多行字符串模式 -“`[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*`”
+ Logstash Grok 字符串模式 -“`[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\t]*`”
+ 标识符字符串模式 -“`[A-Za-z_][A-Za-z0-9_]*`”
+ AWS IAM ARN 字符串模式 –“`arn:aws:iam::\d{12}:role/.*`”
+ 版本字符串模式 -“`^[a-zA-Z0-9-_]+$`”
+ 日志组字符串模式 -“`[\.\-_/#A-Za-z0-9]+`”
+ 日志流字符串模式 -“`[^:*]*`”
+ 自定义字符串模式 \$110 –“`[a-zA-Z0-9-_]+`”
+ 自定义字符串模式 \$111 –“`[-a-zA-Z0-9+=/:_]*`”
+ 自定义字符串模式 \$112 –“`[\S\s]*`”
+ 自定义字符串模式 \$113 –“`.*\S.*`”
+ 自定义字符串模式 \$114 –“`[a-zA-Z0-9-=._/@]+`”
+ 自定义字符串模式 \$115 –“`[1-9][0-9]*|[1-9][0-9]*-[1-9][0-9]*`”
+ 自定义字符串模式 \$116 –“`[A-Z][A-Za-z\.]+`”
+ 自定义字符串模式 \$117 –“`[\S]*`”
+ 自定义字符串模式 \$118 –“`[\w]*`”
+ 自定义字符串模式 \$119 –“`arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`”
+ 自定义字符串模式 \$120 –“`subnet-[a-z0-9]+`”
+ 自定义字符串模式 \$121 –“`\d{12}`”
+ 自定义字符串模式 \$122 –“`([a-z]+)-([a-z]+-)?([a-z]+)-[0-9]+[a-z]+`”
+ 自定义字符串模式 \$123 –“`[a-zA-Z0-9.-]*`”
+ 自定义字符串模式 \$124 –“`arn:aws[a-z0-9\-]*:lambda:[a-z0-9\-]+:\d{12}:function:([\w\-]{1,64})`”
+ 自定义字符串模式 \$125 –“`^(?!(.*[.\/\\]|aws:)).*$`”
+ 自定义字符串模式 \$126 –“`[^\r\n]`”
+ 自定义字符串模式 \$127 –“`^\w+\.\w+\.\w+$`”
+ 自定义字符串模式 \$128 –“`^\w+\.\w+$`”
+ 自定义字符串模式 \$129 –“`^$|arn:aws[a-z0-9-]*:kms:.*`”
+ 自定义字符串模式 \$130 –“`arn:aws[^:]*:iam::[0-9]*:role/.+`”
+ 自定义字符串模式 \$131 –“`[\.\-_A-Za-z0-9]+`”
+ 自定义字符串模式 \$132 –“`^s3://([^/]+)/([^/]+/)*([^/]+)$`”
+ 自定义字符串模式 \$133 –“`.*`”
+ 自定义字符串模式 \$134 –“`^(Sun|Mon|Tue|Wed|Thu|Fri|Sat):([01]?[0-9]|2[0-3])$`”
+ 自定义字符串模式 \$135 – "`[a-zA-Z0-9_.-]+`"
+ 自定义字符串模式 36 –“`^arn:aws(-(cn|us-gov|eusc|iso(-[bef])?))?:secretsmanager:.*$`”
+ 自定义字符串模式 37 –“`\S+`”
+ 自定义字符串模式 \$138 –“`^[\x20-\x7E]*$`”
+ 自定义字符串模式 \$139 –“`^([a-zA-Z0-9_=]+)\.([a-zA-Z0-9_=]+)\.([a-zA-Z0-9_\-\+\/=]*)`”
+ 自定义字符串模式 \$140 –“`^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]`”
+ 自定义字符串模式 \$141 –“`^(https?):\/\/[^\s/$.?#].[^\s]*$`”
+ 自定义字符串模式 \$142 –“`arn:aws:kms:.*`”
+ 自定义字符串模式 \$143 –“`^subnet-[a-z0-9]+$`”
+ 自定义字符串模式 \$144 –“`[\p{L}\p{N}\p{P}]*`”
+ 自定义字符串模式 \$145 –“`[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`”
+ 自定义字符串模式 \$146：“`[a-zA-Z0-9-_$#.]+`”
+ 自定义字符串模式 \$147：“`^\d{12}$`”
+ 自定义字符串模式 \$148：“`^(\w+\.)+\w+$`”
+ 自定义字符串模式 \$149：“`^([2-3]|3[.]9)$`”
+ 自定义字符串模式 \$150：“`arn:aws(-(cn|us-gov|eusc|iso(-[bef])?))?:glue:.*`”
+ 自定义字符串模式 \$151：“`[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`”
+ 自定义字符串模式 \$152：“`(^arn:aws(-(cn|us-gov|eusc|iso(-[bef])?))?:iam::\w{12}:root)`”
+ 自定义字符串模式 \$153：“`^arn:aws(-(cn|us-gov|eusc|iso(-[bef])?))?:iam::[0-9]{12}:role/.+`”
+ 自定义字符串模式 \$154：“`[\s\S]*`”
+ 自定义字符串模式 \$155：“`([\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF]|[^\S\r\n"'= ;])*`”
+ 自定义字符串模式 \$156：“`^[A-Z\_]+$`”
+ 自定义字符串模式 \$157：“`^[A-Za-z0-9]+$`”
+ 自定义字符串模式 \$158：“`[*A-Za-z0-9_-]*`”
+ 自定义字符串模式 \$159:“`([\u0020-\u007E\r\s\n])*`”
+ 自定义字符串模式 \$160：“`[A-Za-z0-9_-]*`”
+ 自定义字符串模式 \$161：“`([\u0009\u000B\u000C\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF])*`”
+ 自定义字符串模式 \$162：“`([\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\s])*`”
+ 自定义字符串模式 \$163 –“`([^\r\n])*`”

# 异常
<a name="aws-glue-api-exceptions"></a>

本节介绍可以用于查找问题根源并修复问题的 AWS Glue 例外情况。有关与机器学习相关的异常的 HTTP 错误代码和字符串的详细信息，请参阅 [AWS Glue 机器学习异常](exceptions-machine-learning.md)。

## AccessDeniedException 结构
<a name="aws-glue-api-exceptions-AccessDeniedException"></a>

对资源的访问被拒绝。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## AlreadyExistsException 结构
<a name="aws-glue-api-exceptions-AlreadyExistsException"></a>

要创建或添加的资源已存在。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## ConcurrentModificationException 结构
<a name="aws-glue-api-exceptions-ConcurrentModificationException"></a>

两个进程正在同时尝试修改某个资源。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## ConcurrentRunsExceededException 结构
<a name="aws-glue-api-exceptions-ConcurrentRunsExceededException"></a>

并发运行的任务太多。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## CrawlerNotRunningException 结构
<a name="aws-glue-api-exceptions-CrawlerNotRunningException"></a>

指定的爬网程序未在运行。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## CrawlerRunningException 结构
<a name="aws-glue-api-exceptions-CrawlerRunningException"></a>

无法执行此操作，因为爬网程序已在运行。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## CrawlerStoppingException 结构
<a name="aws-glue-api-exceptions-CrawlerStoppingException"></a>

指定的爬网程序正在停止。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## EntityNotFoundException 结构
<a name="aws-glue-api-exceptions-EntityNotFoundException"></a>

指定的实体不存在

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。
+ `FromFederationSource` – 布尔值。

  表示异常是否与联合来源有关。

## FederationSourceException 结构
<a name="aws-glue-api-exceptions-FederationSourceException"></a>

联合来源失败。

**字段**
+ `FederationSourceErrorCode` - UTF-8 字符串（有效值：`AccessDeniedException` \$1 `EntityNotFoundException` \$1 `InvalidCredentialsException` \$1 `InvalidInputException` \$1 `InvalidResponseException` \$1 `OperationTimeoutException` \$1 `OperationNotSupportedException` \$1 `InternalServiceException` \$1 `PartialFailureException` \$1 `ThrottlingException`）。

  问题的错误码。
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## FederationSourceRetryableException 结构
<a name="aws-glue-api-exceptions-FederationSourceRetryableException"></a>

联合来源失败，但可能会重试该操作。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## GlueEncryptionException 结构
<a name="aws-glue-api-exceptions-GlueEncryptionException"></a>

加密操作失败。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## IdempotentParameterMismatchException 结构
<a name="aws-glue-api-exceptions-IdempotentParameterMismatchException"></a>

两个不同记录关联了相同的唯一标识符。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## IllegalWorkflowStateException 结构
<a name="aws-glue-api-exceptions-IllegalWorkflowStateException"></a>

工作流程处于无效状态，无法执行请求的操作。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## InternalServiceException 结构
<a name="aws-glue-api-exceptions-InternalServiceException"></a>

出现内部服务错误。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## InvalidExecutionEngineException 结构
<a name="aws-glue-api-exceptions-InvalidExecutionEngineException"></a>

指定的执行引擎未知或无效。

**字段**
+ `message` – UTF-8 字符串。

  描述问题的消息。

## InvalidInputException 结构
<a name="aws-glue-api-exceptions-InvalidInputException"></a>

提供的输入无效。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。
+ `FromFederationSource` – 布尔值。

  表示异常是否与联合来源有关。

## InvalidStateException 结构
<a name="aws-glue-api-exceptions-InvalidStateException"></a>

指出您的数据处于无效状态的错误。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## InvalidTaskStatusTransitionException 结构
<a name="aws-glue-api-exceptions-InvalidTaskStatusTransitionException"></a>

从一个任务正确过渡到下一个任务失败。

**字段**
+ `message` – UTF-8 字符串。

  描述问题的消息。

## JobDefinitionErrorException 结构
<a name="aws-glue-api-exceptions-JobDefinitionErrorException"></a>

作业定义无效。

**字段**
+ `message` – UTF-8 字符串。

  描述问题的消息。

## JobRunInTerminalStateException 结构
<a name="aws-glue-api-exceptions-JobRunInTerminalStateException"></a>

作业运行的最终状态标志着失败。

**字段**
+ `message` – UTF-8 字符串。

  描述问题的消息。

## JobRunInvalidStateTransitionException 结构
<a name="aws-glue-api-exceptions-JobRunInvalidStateTransitionException"></a>

作业运行遇到了从源状态到目标状态的无效转换。

**字段**
+ `jobRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。

  相关作业运行的 ID。
+ `message` – UTF-8 字符串。

  描述问题的消息。
+ `sourceState` - UTF-8 字符串（有效值：`STARTING` \$1 `RUNNING` \$1 `STOPPING` \$1 `STOPPED` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `TIMEOUT` \$1 `ERROR` \$1 `WAITING` \$1 `EXPIRED`）。

  源状态。
+ `targetState` - UTF-8 字符串（有效值：`STARTING` \$1 `RUNNING` \$1 `STOPPING` \$1 `STOPPED` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `TIMEOUT` \$1 `ERROR` \$1 `WAITING` \$1 `EXPIRED`）。

  目标状态。

## JobRunNotInTerminalStateException 结构
<a name="aws-glue-api-exceptions-JobRunNotInTerminalStateException"></a>

作业运行未处于最终状态。

**字段**
+ `message` – UTF-8 字符串。

  描述问题的消息。

## LateRunnerException 结构
<a name="aws-glue-api-exceptions-LateRunnerException"></a>

作业运行程序延迟。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## NoScheduleException 结构
<a name="aws-glue-api-exceptions-NoScheduleException"></a>

没有适用的计划。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## OperationTimeoutException 结构
<a name="aws-glue-api-exceptions-OperationTimeoutException"></a>

操作已超时。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## ResourceNotReadyException 结构
<a name="aws-glue-api-exceptions-ResourceNotReadyException"></a>

资源尚未为事务做好准备。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## ResourceNumberLimitExceededException 结构
<a name="aws-glue-api-exceptions-ResourceNumberLimitExceededException"></a>

超出了资源数字限制。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## SchedulerNotRunningException 结构
<a name="aws-glue-api-exceptions-SchedulerNotRunningException"></a>

指定的计划程序未在运行。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## SchedulerRunningException 结构
<a name="aws-glue-api-exceptions-SchedulerRunningException"></a>

指定的计划程序已在运行。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## SchedulerTransitioningException 结构
<a name="aws-glue-api-exceptions-SchedulerTransitioningException"></a>

指定的计划程序正在转换。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## UnrecognizedRunnerException 结构
<a name="aws-glue-api-exceptions-UnrecognizedRunnerException"></a>

作业运行程序无法识别。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## ValidationException 结构
<a name="aws-glue-api-exceptions-ValidationException"></a>

值无法验证。

**字段**
+ `Message` – UTF-8 字符串。

  描述问题的消息。

## VersionMismatchException 结构
<a name="aws-glue-api-exceptions-VersionMismatchException"></a>

出现版本冲突。

**字段**
+ `message` – UTF-8 字符串。

  描述问题的消息。