本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

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

本節說明 AWS Glue SDKs 和工具使用的資料類型和基本概念。有三種一般方式可在 之外以 AWS Glue 程式設計方式與 互動 AWS 管理主控台，每個都有自己的文件：
+  語言開發套件程式庫可讓您存取常見程式設計語言的 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 resource type reference](https://docs.aws.amazon.com/en_us/AWSCloudFormation/latest/UserGuide/AWS_Glue.html)。

 本節介紹獨立於這些開發套件和工具的共享基本元素。工具使用 [AWS Glue Web API 參考](https://docs.aws.amazon.com/glue/latest/webapi/WebAPI_Welcome.html)與 通訊 AWS。

**Contents**
+ [中的安全 APIs AWS Glue](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\$1policies)](aws-glue-api-jobs-security.md#aws-glue-api-jobs-security-GetResourcePolicies)
+ [Catalog objects API](aws-glue-api-catalog.md)
  + [Catalogs 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)
    + [FederatedDatabase 結構](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)
    + [FederatedTable 結構](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)
  + [Connections 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)
    + [Connection Types API](aws-glue-api-catalog-connections-connections-type.md)
      + [Connection Management 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)
  + [EncryptionConfiguration 結構](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)
  + [EvaluationMetrics 結構](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 action (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)
  + [JDBCConnectorOptions 結構](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)
  + [AggregateOperation 結構](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)
    + [Job 結構](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)
+ [中的整合 APIs AWS Glue](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)
  + [ListSessions 動作 (Python: list\$1sessions)](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\$1versions)](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-ListSchemaVersions)
  + [GetSchemaVersion 動作 (Python: get\$1schema\$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\$1schemas)](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\$1schema\$1versions)](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\$1blueprints)](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\$1profiles)](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\$1transforms)](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)
+ [Data Quality API](aws-glue-api-data-quality-api.md)
  + [資料類型](aws-glue-api-data-quality-api.md#aws-glue-api-data-quality-api-objects)
  + [DataSource 結構](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)
  + [AnnotationError 結構](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\$1custom\$1entity\$1types)](aws-glue-api-sensitive-data-api.md#aws-glue-api-sensitive-data-api-BatchGetCustomEntityTypes)
  + [ListCustomEntityTypes 動作 (Python: list\$1custom\$1entity\$1types)](aws-glue-api-sensitive-data-api.md#aws-glue-api-sensitive-data-api-ListCustomEntityTypes)
+ [在 中標記 APIs AWS Glue](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)

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

安全 API 說明安全資料類型，以及 中與安全相關的 API AWS Glue。

## 資料類型
<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>

包含了維護 Data Catalog 安全性的組態資訊。

**欄位**
+ `EncryptionAtRest` – [EncryptionAtRest](#aws-glue-api-jobs-security-EncryptionAtRest) 物件。

  為該 Data Catalog 指定靜態加密組態。
+ `ConnectionPasswordEncryption` – [ConnectionPasswordEncryption](#aws-glue-api-jobs-security-ConnectionPasswordEncryption) 物件。

  啟用連線密碼保護時，資料目錄使用客戶提供的金鑰加密密碼，做為 `CreateConnection` 或 ​`UpdateConnection` 的一部分，並將密碼存放在連線屬性中​的 `ENCRYPTED_PASSWORD` 欄位。​ 您可以啟用目錄加密，或僅使用密碼加密。

## EncryptionAtRest 結構
<a name="aws-glue-api-jobs-security-EncryptionAtRest"></a>

為該資料目錄指定靜態加密組態。

**欄位**
+ `CatalogEncryptionMode` – *必要：*UTF-8 字串 (有效值：`DISABLED` \$1 `SSE-KMS="SSEKMS"` \$1 `SSE-KMS-WITH-SERVICE-ROLE="SSEKMSWITHSERVICEROLE"`)。

  加密 Data Catalog ( Data Catalog ) 資料的靜態加密模式。
+ `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 擔任 的角色，代表發起人加密和解密 Data Catalog 物件。

## ConnectionPasswordEncryption 結構
<a name="aws-glue-api-jobs-security-ConnectionPasswordEncryption"></a>

資料目錄所使用的資料結構，用於加密密碼，做為 `CreateConnection` 或 `UpdateConnection` 的一部分，並將密碼存放在連線屬性中​的 `ENCRYPTED_PASSWORD` 欄位。​ 您可以啟用目錄加密，或僅使用密碼加密。

收到包含密碼的`CreationConnection`請求時，Data Catalog 會先使用您的 AWS KMS 金鑰加密密碼。如果啟用了目錄加密，則會再次加密整個連線物件。

此加密要求您設定 AWS KMS 金鑰許可，以根據您的安全需求啟用或限制對密碼金鑰的存取。例如，您可能希望只有管理員能擁有密碼金鑰的解密許可。

**欄位**
+ `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`許可，才能在 Data Catalog 中存放密碼。

  您可以設定解密許可，以根據您的安全要求啟用或限制密碼金鑰的存取。

## EncryptionConfiguration 結構
<a name="aws-glue-api-jobs-security-EncryptionConfiguration"></a>

指定加密組態。

**欄位**
+ `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 Data Quality 資產的加密組態。

## S3Encryption 結構
<a name="aws-glue-api-jobs-security-S3Encryption"></a>

指定 Amazon Simple Storage Service (Amazon S3) 資料應如何進行加密。

**欄位**
+ `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 資料的加密方式。

**欄位**
+ `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>

指定任務書籤資料的加密方式。

**欄位**
+ `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>

指定安全組態。

**欄位**
+ `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>

傳回資源政策的結構。

**欄位**
+ `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>

指定應如何加密帳戶中的 Data Quality 資產。

**欄位**
+ `DataQualityEncryptionMode` – UTF-8 字串 (有效值：`DISABLED` \$1 `SSE-KMS="SSEKMS"`)。

  用於加密 Data Quality 資產的加密模式。這些資產包括資料品質規則集、結果、統計資料、異常偵測模型及觀察。

  有效值 `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\$1policies)](#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)。

  用於擷取安全組態的 Data Catalog ( Data Catalog ) 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)。

  用於設定安全組態的 Data Catalog ( Data Catalog ) 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>

設定 Data Catalog 資源政策以用於存取控制。

**請求**
+ `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` 值或 null 值，則呼叫不需依賴政策的存在。
+ `EnableHybrid` – UTF-8 字串 (有效值：`TRUE` \$1 `FALSE`)。

  如果 `'TRUE'`，表示您正在使用這兩種方式授予 Data Catalog 資源的跨帳戶存取權：
  + 透過 `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。如果未提供，則會傳回 Data Catalog 資源政策。使用 `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\$1policies)
<a name="aws-glue-api-jobs-security-GetResourcePolicies"></a>

在跨帳戶許可授予 AWS Resource Access Manager 期間，由 擷取在個別資源上設定的資源政策。同時擷取 Data Catalog 資源政策。

如果您在 Data Catalog 設定中啟用中繼資料加密，而且您沒有 AWS KMS 金鑰的許可，則操作無法傳回 Data Catalog 資源政策。

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

  接續符記，如果這是接續要求。
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。

  所要回傳清單的大小上限。

**回應**
+ `GetResourcePoliciesResponseList` – 一個 [GluePolicy](#aws-glue-api-jobs-security-GluePolicy) 物件陣列。

  個別資源政策和帳號層級資源政策的清單。
+ `NextToken` – UTF-8 字串。

  接續字元，如果傳回的清單未包含最後一個可用資源政策。

**錯誤**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`

# Catalog objects API
<a name="aws-glue-api-catalog"></a>

目錄物件 API 說明與在 中使用目錄相關的資料類型和 API AWS Glue。

**Topics**
+ [Catalogs 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)
+ [Connections API](aws-glue-api-catalog-connections.md)
+ [使用者定義的函數 API](aws-glue-api-catalog-functions.md)
+ [將 Athena 目錄匯入至 AWS Glue](aws-glue-api-catalog-migration.md)

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

Catalogs 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 資料目錄或聯合來源中資料庫的邏輯分組。您現在可以建立 Redshift 聯合目錄或包含其他帳戶或區域中 Redshift 資料庫的資源連結的目錄。

**欄位**
+ `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 Resource Name (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>

描述目錄屬性的結構。

**欄位**
+ `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 外部實體的`FederatedCatalog`結構，例如 Redshift 資料庫。
+ `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>

描述資源連結的目標目錄的結構。

**欄位**
+ `CatalogArn` – *必要：*UTF-8 字串。

  目錄資源的 Amazon Resource Name (ARN)。

## CatalogProperties 結構
<a name="aws-glue-api-catalog-catalogs-CatalogProperties"></a>

指定資料湖存取屬性和其他自訂屬性的結構。

**欄位**
+ `DataLakeAccessProperties` – [DataLakeAccessProperties](#aws-glue-api-catalog-catalogs-DataLakeAccessProperties) 物件。

  指定屬性的`DataLakeAccessProperties`物件，以設定 Data Catalog 中目錄資源 AWS Glue 的資料湖存取。
+ `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>

內容屬性，其中包含目錄資源的組態屬性。

**欄位**
+ `DataLakeAccessProperties` – [DataLakeAccessPropertiesOutput](#aws-glue-api-catalog-catalogs-DataLakeAccessPropertiesOutput) 物件。

  具有輸入屬性的`DataLakeAccessProperties`物件，用於設定 Data Catalog 中目錄資源 AWS Glue 的資料湖存取。
+ `IcebergOptimizationProperties` – [IcebergOptimizationPropertiesOutput](#aws-glue-api-catalog-catalogs-IcebergOptimizationPropertiesOutput) 物件。

  用於指定目錄 Iceberg 資料表最佳化設定的 `IcebergOptimizationPropertiesOutput` 物件，包括壓縮、保留和孤立檔案刪除操作的組態。
+ `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>

輸入屬性，以設定 Data Catalog 中目錄資源 AWS Glue 的資料湖存取。

**欄位**
+ `DataLakeAccess` – 布林值。

  開啟或關閉從任何非 Redshift 引擎存取 Data Catalog 中 Amazon Redshift 資料庫的 Apache Spark 應用程式的資料湖存取，例如 Amazon Athena、Amazon EMR 或 AWS Glue ETL。
+ `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 資料表最佳化屬性的結構，包括壓縮、保留和孤立檔案刪除操作的組態。

**欄位**
+ `RoleArn` – UTF-8 字串，需符合[Custom string pattern #53](aws-glue-api-common.md#regex_53)。

  將擔任以執行 Iceberg 資料表最佳化操作之 IAM 角色的 Amazon Resource Name (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>

Data Catalog 中目錄資源的資料湖存取組態的輸出屬性 AWS Glue 。

**欄位**
+ `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 資料表最佳化組態輸出屬性的結構。

**欄位**
+ `RoleArn` – UTF-8 字串，需符合[Custom string pattern #53](aws-glue-api-common.md#regex_53)。

  用於執行 Iceberg 資料表最佳化操作的 IAM 角色的 Amazon Resource Name (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 外部實體的目錄。

**欄位**
+ `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 資料目錄移除指定的目錄。

完成此操作後，您將無法再存取已刪除目錄中的資料庫、資料表 （以及可能屬於資料表的所有資料表版本和分割區） 和使用者定義的函數。 會由服務自行決定，以非同步方式及時 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` 物件。Data Catalog 中指定 AWS Glue 目錄的定義。

**錯誤**
+ `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>

Database 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)
+ [FederatedDatabase 結構](#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)。

  資料庫存放所在 Data Catalog 的 ID。
+ `FederatedDatabase` – [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` – [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)。

  資料庫存放所在 Data Catalog 的 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)。

  目標資料庫的區域。

## FederatedDatabase 結構
<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>

在 Data Catalog 建立新的資料庫。

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  用於建立資料庫的 Data Catalog 之 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>

更新 Data Catalog 中現有的資料庫定義。

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  存放中繼資料資料庫的 Data Catalog 之 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>

從 Data Catalog 移除指定的資料庫。

**注意**  
完成此操作後，您將無法再存取已刪除資料庫中的資料表 （以及可能屬於資料表的所有資料表版本和分割區） 和使用者定義的函數。 會由服務自行決定，以非同步方式及時 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)。

  資料庫存放所在 Data Catalog 的 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)。

  資料庫存放所在 Data Catalog 的 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) 物件。

  Data Catalog 中所指定資料庫的定義。

**錯誤**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`

## GetDatabases 動作 (Python: get\$1databases)
<a name="aws-glue-api-catalog-databases-GetDatabases"></a>

擷取特定 Data Catalog 中所有已定義的資料庫。

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  用於擷取 `Databases` 的 Data Catalog 之 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>

Table API 說明與資料表相關的資料類型和操作。

## 資料類型
<a name="aws-glue-api-catalog-tables-objects"></a>
+ [Table 結構](#aws-glue-api-catalog-tables-Table)
+ [TableInput 結構](#aws-glue-api-catalog-tables-TableInput)
+ [FederatedTable 結構](#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>

表示整理為欄和列的相關資料的集合。

**欄位**
+ `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` – 時間戳記。

  在 Data Catalog 中建立資料表定義的時間。
+ `UpdateTime` – 時間戳記。

  資料表上次更新的時間。
+ `LastAccessTime` – 時間戳記。

  資料表上次存取的時間。這通常取自 HDFS，而且可能不可靠。
+ `LastAnalyzedTime` – 時間戳記。

  此資料表上次運算欄位統計的時間。
+ `Retention` – 數字 (整數)，不可大於 None (無)。

  此資料表的保留時間。
+ `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`，則會以 base64 編碼特定 Athena 組態。
+ `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)。

  資料表存放所在 Data Catalog 的 ID。
+ `VersionId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料表版本的 ID。
+ `FederatedTable` – [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>

用於定義資料表的結構。

**欄位**
+ `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` – 數字 (整數)，不可大於 None (無)。

  此資料表的保留時間。
+ `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`，則會以 base64 編碼特定 Athena 組態。
+ `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) 物件。

  包含定義檢視的所有資訊的結構，包括檢視的方言及查詢。

## FederatedTable 結構
<a name="aws-glue-api-catalog-tables-FederatedTable"></a>

指向 AWS Glue Data Catalog外部實體的資料表。

**欄位**
+ `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` 中的欄位。

**欄位**
+ `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>

描述資料表資料的實體儲存。

**欄位**
+ `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 字串陣列。

  資料表中的縮減器分組欄位、叢集欄位及值區欄位的清單。
+ `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 結構描述的物件。

**欄位**
+ `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) 的資訊。

**欄位**
+ `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>

指定已排序欄位的排序順序。

**欄位**
+ `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>

指定資料表中的偏斜值。偏斜值是指頻率發生非常高的值。

**欄位**
+ `SkewedColumnNames` – UTF-8 字串陣列。

  包含偏斜值的欄位名稱清單。
+ `SkewedColumnValues` – UTF-8 字串陣列。

  頻繁出現而被視為偏斜的值的清單。
+ `SkewedColumnValueLocationMaps` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串。

  每個值都是 UTF-8 字串。

  偏斜值與包含這些值的欄位的映射。

## TableVersion 結構
<a name="aws-glue-api-catalog-tables-TableVersion"></a>

指定資料表的版本。

**欄位**
+ `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>

資料表操作的錯誤記錄。

**欄位**
+ `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>

資料表版本操作的錯誤記錄。

**欄位**
+ `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>

指定欄位排序的依據和排序順序。

**欄位**
+ `FieldName` – 值字串，長度不可小於 1 個位元組，也不可以超過 1,024 個位元組。

  要排序的欄位名稱。
+ `Sort` – UTF-8 字串 (有效值：`ASC="ASCENDING"` \$1`DESC="DESCENDING"`)。

  遞增或遞減排序。

## TableIdentifier 結構
<a name="aws-glue-api-catalog-tables-TableIdentifier"></a>

描述資源連結的目標資料表的結構。

**欄位**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料表存放所在 Data Catalog 的 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>

由名稱和類型組成的分割區索引鍵對。

**欄位**
+ `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>

分割區索引的結構。

**欄位**
+ `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>

資料表中分割區索引的描述元。

**欄位**
+ `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：不屬於其他錯誤碼的任何錯誤。

**欄位**
+ `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 中繼資料資料表的結構。

**欄位**
+ `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>

表示開放格式資料表的結構。

**欄位**
+ `IcebergInput` – [IcebergInput](#aws-glue-api-catalog-tables-IcebergInput) 物件。

  指定定義 Apache Iceberg 中繼資料資料表的 `IcebergInput` 結構。

## ViewDefinition 結構
<a name="aws-glue-api-catalog-tables-ViewDefinition"></a>

包含表示法詳細資訊的結構。

**欄位**
+ `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 Resource Name (ARN) 的清單。
+ `Representations` – [ViewRepresentation](#aws-glue-api-catalog-tables-ViewRepresentation) 物件陣列，不小於 1 個結構，也不大於 1000 個結構。

  表示法清單。

## ViewDefinitionInput 結構
<a name="aws-glue-api-catalog-tables-ViewDefinitionInput"></a>

包含建立或更新 AWS Glue 檢視之詳細資訊的結構。

**欄位**
+ `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>

包含檢視方言的結構，及定義檢視的查詢。

**欄位**
+ `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` 用於使用者想要查看建立檢視的原始 DDL 命令的情況 (如 `SHOW CREATE VIEW`)。
+ `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 檢視的表示法詳細資訊的結構。

**欄位**
+ `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。

**欄位**
+ `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 資料表的更新操作。

**欄位**
+ `UpdateIcebergTableInput` – *必要：*[UpdateIcebergTableInput](#aws-glue-api-catalog-tables-UpdateIcebergTableInput) 物件。

  要套用至 Iceberg 資料表的特定更新操作，其中包含定義資料表新狀態的更新清單，包括結構描述、分區和屬性。

## CreateIcebergTableInput 結構
<a name="aws-glue-api-catalog-tables-CreateIcebergTableInput"></a>

在 AWS Glue Data Catalog 中建立新的 Iceberg 資料表所需的組態參數，包括資料表屬性和中繼資料規格。

**欄位**
+ `Location` – *必要：*位置字串，長度不可超過 2,056 個位元組，需符合 [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 資料表的更新操作，定義資料表中繼資料的新狀態。

**欄位**
+ `Updates` – *必要：*一個 [IcebergTableUpdate](#aws-glue-api-catalog-tables-IcebergTableUpdate) 物件。

  指定要對 Iceberg 資料表進行變更的資料表更新操作清單，包括結構描述修改、分區規格和資料表屬性。

## IcebergSortOrder 結構
<a name="aws-glue-api-catalog-tables-IcebergSortOrder"></a>

定義 Iceberg 資料表的排序順序規格，決定如何在分區內排序資料，以最佳化查詢效能。

**欄位**
+ `OrderId` – *必要：*數字 (整數)。

  Iceberg 資料表中繼資料內此排序順序規格的唯一識別碼。
+ `Fields` – *必要：*一個 [IcebergSortField](#aws-glue-api-catalog-tables-IcebergSortField) 物件。

  定義 Iceberg 資料表資料的排序條件的欄位清單及其排序方向。

## IcebergSortField 結構
<a name="aws-glue-api-catalog-tables-IcebergSortField"></a>

定義 Iceberg 排序順序規格內的單一欄位，包括來源欄位、轉換、排序方向和 null 值排序。

**欄位**
+ `SourceId` – *必要：*數字 (整數)。

  此排序欄位所根據的資料表結構描述的來源欄位識別碼。
+ `Transform` – *必要：*UTF-8 字串。

  在排序之前套用至來源欄位的轉換函數，例如身分、儲存貯體或截斷。
+ `Direction` – *必要：*UTF-8 字串 (有效值：`asc="ASC"` \$1 `desc="DESC"`)。

  此欄位的排序方向 (遞增或遞減)。
+ `NullOrder` – *必要：*UTF-8 字串 (有效值：`nulls-first="NULLS_FIRST"` \$1 `nulls-last="NULLS_LAST"`)。

  此欄位中 null 值的排序行為，指定 null 在排序順序中應先顯示還是最後顯示。

## IcebergPartitionSpec 結構
<a name="aws-glue-api-catalog-tables-IcebergPartitionSpec"></a>

定義 Iceberg 資料表的分區規格，決定如何組織和分區資料表資料，以獲得最佳查詢效能。

**欄位**
+ `Fields` – *必要：*一個 [IcebergPartitionField](#aws-glue-api-catalog-tables-IcebergPartitionField) 物件。

  定義如何對資料表資料進行分區的分區欄位清單，包括來源欄位及其轉換。
+ `SpecId` – 數字 (整數)。

  Iceberg 資料表的中繼資料歷史記錄內此分區規格的唯一識別碼。

## IcebergPartitionField 結構
<a name="aws-glue-api-catalog-tables-IcebergPartitionField"></a>

定義 Iceberg 分區規格內的單一分區欄位，包括來源欄位、轉換函數、分區名稱和唯一識別碼。

**欄位**
+ `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 資料表的結構描述結構，包括欄位定義、資料類型及結構描述中繼資料。

**欄位**
+ `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 資料表結構描述內的單一欄位，包括其識別碼、名稱、資料類型、可為 Null 性及文件。

**欄位**
+ `Id` – *必要：*數字 (整數)。

  Iceberg 資料表結構描述內指派給此欄位的唯一識別碼，用於結構描述演變和欄位追蹤。
+ `Name` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 1024 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  欄位在資料表結構描述和查詢操作中顯示的名稱。
+ `Type` – *必要：*名為 `IcebergDocument` 的空白結構。

  此欄位的資料類型定義，指定其包含資料的結構和格式。
+ `Required` – *必要：*布林值。

  指出此欄位在資料表結構描述中是必要 (不可為 Null) 還是選用 (可為 Null)。
+ `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 資料表的完整更新集，包括結構描述變更、分區修改、排序順序調整、位置更新和屬性變更。

**欄位**
+ `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` – *必要：*位置字串，長度不可超過 2,056 個位元組，需符合 [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 稽核內容的結構。

**欄位**
+ `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>

在 Data Catalog 建立新的資料表定義。

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  用於建立 `Table` 的 Data Catalog 之 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>

在 Data Catalog 更新中繼資料資料表。

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料表所在的 Data Catalog 的 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。
+ `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>

從 Data Catalog 移除資料表定義。

**注意**  
完成此操作之後，您就不能再存取屬於已刪除資料表的資料表版本和分割區。 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)。

  資料表所在的 Data Catalog 的 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。

**回應**
+ *無回應參數。*

**錯誤**
+ `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)。

  資料表所在的 Data Catalog 的 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。

**回應**
+ `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>

擷取 Data Catalog 中指定資料表的 `Table` 定義。

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  資料表所在的 Data Catalog 的 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。
+ `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)。

  資料表所在的 Data Catalog 的 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。
+ `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)。

  資料表所在的 Data Catalog 的 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)。

  資料表所在的 Data Catalog 的 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)。

  資料表所在的 Data Catalog 的 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)。

  資料表所在的 Data Catalog 的 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 個位元組，也不可以超過 1,024 個位元組。

  用於文字搜尋的字串。

  根據與值的完全相符，在引號篩選條件中指定值。
+ `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)。

  有問題分區所在 Data Catalog 的 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) 物件陣列。

  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)。

  有問題分區所在 Data Catalog 的 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)。

  有問題分區所在 Data Catalog 的 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>

Partition 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>

代表資料表資料的切片。

**欄位**
+ `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)。

  分割區所在 Data Catalog 的 ID。

## PartitionInput 結構
<a name="aws-glue-api-catalog-partitions-PartitionInput"></a>

用於建立和更新分割區的結構。

**欄位**
+ `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>

適用於共用實體位置的分區的分區規格。

**欄位**
+ `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>

列出相關的分區。

**欄位**
+ `Partitions` – 一個 [分割區](#aws-glue-api-catalog-partitions-Partition) 物件陣列。

  符合組成規格的分區的清單。

## PartitionSpecProxy 結構
<a name="aws-glue-api-catalog-partitions-PartitionSpecProxy"></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)。

  包含資分區之資料表的名稱。
+ `RootPath` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  定址分區的 Proxy 的根路徑。
+ `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>

包含定義分區的值的清單。

**欄位**
+ `Values` – *必要：*UTF-8 字串陣列。

  值的清單。

## Segment 結構
<a name="aws-glue-api-catalog-partitions-Segment"></a>

定義資料表分割區的非重疊區域，讓多個要求以平行方式執行。

**欄位**
+ `SegmentNumber` – *必要：*數字 (整數)，不可大於 None (無)。

  區段的零基索引號碼。例如，如果區段總數為 4，則 `SegmentNumber` 的值將從 0 到 3。
+ `TotalSegments` – *必要：*數字 (整數)，不可小於 1，也不可以大於 10。

  區段的總數。

## PartitionError 結構
<a name="aws-glue-api-catalog-partitions-PartitionError"></a>

包含有關分區錯誤的資訊。

**欄位**
+ `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>

包含有關批次更新分割區錯誤的資訊。

**欄位**
+ `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>

包含用於更新分割區的值和結構的結構。

**欄位**
+ `PartitionValueList` – *必要：*UTF-8 字串的陣列，不可超過 100 個字串。

  定義分割區的值的清單。
+ `PartitionInput` – *必要：*[PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput) 物件。

  用於更新分割區的結構。

## StorageDescriptor 結構
<a name="aws-glue-api-catalog-partitions-StorageDescriptor"></a>

描述資料表資料的實體儲存。

**欄位**
+ `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 字串陣列。

  資料表中的縮減器分組欄位、叢集欄位及值區欄位的清單。
+ `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 結構描述的物件。

**欄位**
+ `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) 的資訊。

**欄位**
+ `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>

指定資料表中的偏斜值。偏斜值是指頻率發生非常高的值。

**欄位**
+ `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)。

  要更新之分區所在 Data Catalog 的 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)。

  要刪除分區所在 Data Catalog 的 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)。

  要刪除分區所在 Data Catalog 的 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)。

  有問題分區所在 Data Catalog 的 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)。

  有問題分區所在 Data Catalog 的 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) 剖析該表達式。

  *Operators (運算子)*：以下是您可以在 `Expression` API 呼叫中使用的運算子：  
=  
檢查兩個運算元的值是否相等；如果是，則條件成立。  
範例：假設「variable a」(變數 a) 保持為 10，而「variable b」(變數 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` – 布林值。

  如果為 True，指定不返回分割區資料行結構描述。僅對其他分割區屬性 (例如分割區值或位置) 感興趣時會很實用。這種方法不會傳回重複的資料，從而避免了大型響應的問題。
+ `TransactionId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Custom string pattern #44](aws-glue-api-common.md#regex_44)。

  藉助其讀取分割區內容的交易 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)。

  有問題分區所在 Data Catalog 的 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)。

  有問題分區所在 Data Catalog 的 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)。

  有問題分區所在 Data Catalog 的 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)。

  有問題分區所在 Data Catalog 的 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`

# Connections API
<a name="aws-glue-api-catalog-connections"></a>

Connections API 說明與在 中使用連線相關的資料類型和 API AWS Glue。

**Topics**
+ [連線 API](aws-glue-api-catalog-connections-connections.md)
+ [Connection Types 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>

Connection 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>

定義連接至資料來源的連線

**欄位**
+ `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` `NETWORK` \$1 `MARKETPLACE` `CUSTOM` \$1 `SALESFORCE` `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 \$1 `GOOGLEANALYTICS4` \$1 \$1 \$1 \$1 \$1 \$1 `SERVICENOW` `MARKETO` `SAPODATA` `ZENDESK` `JIRACLOUD` `NETSUITEERP` `HUBSPOT` `FACEBOOKADS` `INSTAGRAMADS` `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 \$1 \$1 \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 \$1 \$1 `SLACK` `LINKEDIN` `MIXPANEL` `ASANA` `STRIPE` `SMARTSHEET` `DATADOG` \$1 `WOOCOMMERCE` \$1 \$1 `INTERCOM` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `ORACLE` \$1 \$1 \$1 `SNAPCHATADS` `PAYPAL` `QUICKBOOKS` `FACEBOOKPAGEINSIGHTS` `FRESHDESK` `TWILIO` `DOCUSIGNMONITOR` `FRESHSALES` `ZOOM` `GOOGLESEARCHCONSOLE` `SALESFORCECOMMERCECLOUD` `SAPCONCUR` `DYNATRACE` `MICROSOFTDYNAMIC365FINANCEANDOPS` `MICROSOFTTEAMS` `BLACKBAUDRAISEREDGENXT` `MAILCHIMP` `GITLAB` `PENDO` `PRODUCTBOARD` `CIRCLECI` `PIPEDIVE` `SENDGRID` `AZURECOSMOS` `AZURESQL` `BIGQUERY` `BLACKBAUD` `CLOUDERAHIVE` `CLOUDERAIMPALA` `CLOUDWATCH` `CLOUDWATCHMETRICS` `CMDB` `DATALAKEGEN2` `DB2` `DB2AS400` `DOCUMENTDB` `DOMO` `DYNAMODB` `GOOGLECLOUDSTORAGE` `HBASE` `KUSTOMER` `MICROSOFTDYNAMICS365CRM` `MONDAY` `MYSQL` `OKTA` `OPENSEARCH` \$1 \$1 `PIPEDRIVE` \$1 \$1 \$1 \$1 `POSTGRESQL` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `SAPHANA` `SQLSERVER` `SYNAPSE` `TERADATA` `TERADATANOS` `TIMESTREAM` `TPCDS` `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` - 當您在 Data Catalog 加密設定中的 `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 連線強制使用主機名稱相符的 Secure Sockets Layer (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` - 用於憑證的秘密管理器的秘密 ID。
  + `CONNECTOR_URL` - MARKETPLACE 或 CUSTOM 連線的連接器 URL。
  + `CONNECTOR_TYPE` - MARKETPLACE 或 CUSTOM 連線的連接器類型。
  + `CONNECTOR_CLASS_NAME` - MARKETPLACE 或 CUSTOM 連線的連接器類別名稱。
  + `KAFKA_BOOTSTRAP_SERVERS` - 主機和連接埠對的逗號分隔清單，列出 Kafka 叢集中 Kafka 用戶端即將連線以引導自身的 Apache Kafka 中介裝置地址。
  + `KAFKA_SSL_ENABLED` - 在 Apache Kafka 連線上啟用或是停用 SSL。預設值為 "true"。
  + `KAFKA_CUSTOM_CERT` - 私有 CA 憑證檔的 Amazon S3 URL (.pem 格式)。預設為空字串。
  + `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` - 是否略過 AWS Glue 三種演算法的 CA 憑證檔案驗證：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 Resource Name。
  + `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 無伺服器工作群組或 Amazon Athena 工作群組的名稱。
  + `CLUSTER_IDENTIFIER` - 將在其中執行查詢的 Amazon Redshift 叢集的叢集識別碼。
  + `DATABASE` - 您要連線的 Amazon Redshift 資料庫。
+ `SparkProperties` – 金鑰值對的映射陣列。

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

  每個值均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  Spark 運算環境特定的連線屬性。
+ `AthenaProperties` – 金鑰值對的映射陣列。

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

  每個值均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  Athena 運算環境特定的連線屬性。
+ `PythonProperties` – 金鑰值對的映射陣列。

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

  每個值均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  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>

結構用於指定要建立或更新的連線。

**欄位**
+ `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` `KAFKA` \$1 `NETWORK` `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` `VIEW_VALIDATION_REDSHIFT` \$1 \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 \$1 \$1 \$1 \$1 \$1 `INSTAGRAMADS` \$1 `GOOGLESHEETS` `GOOGLEANALYTICS4` `SERVICENOW` `MARKETO` `SAPODATA` `ZENDESK` `JIRACLOUD` `NETSUITEERP` `HUBSPOT` `FACEBOOKADS` \$1 \$1 \$1 `ZOHOCRM` \$1 \$1 \$1 \$1 `SALESFORCEPARDOT` `SALESFORCEMARKETINGCLOUD` `ADOBEANALYTICS` `SLACK` `LINKEDIN` `MIXPANEL` `ASANA` `STRIPE` \$1 `SMARTSHEET` \$1 \$1 `DATADOG` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `WOOCOMMERCE` `INTERCOM` `SNAPCHATADS` `PAYPAL` `QUICKBOOKS` `FACEBOOKPAGEINSIGHTS` `FRESHDESK` `TWILIO` `DOCUSIGNMONITOR` `FRESHSALES` `ZOOM` `GOOGLESEARCHCONSOLE` `SALESFORCECOMMERCECLOUD` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `SAPCONCUR` `DYNATRACE` `MICROSOFTDYNAMIC365FINANCEANDOPS` `MICROSOFTTEAMS` `BLACKBAUDRAISEREDGENXT` `MAILCHIMP` `GITLAB` `PENDO` `PRODUCTBOARD` `CIRCLECI` `PIPEDIVE` `SENDGRID` `AZURECOSMOS` `AZURESQL` `BIGQUERY` `BLACKBAUD` `CLOUDERAHIVE` `CLOUDERAIMPALA` `CLOUDWATCH` `CLOUDWATCHMETRICS` `CMDB` `DATALAKEGEN2` `DB2` `DB2AS400` `DOCUMENTDB` `DOMO` `DYNAMODB` `GOOGLECLOUDSTORAGE` `HBASE` `KUSTOMER` `MICROSOFTDYNAMICS365CRM` `MONDAY` `MYSQL` `OKTA` \$1 \$1 \$1 `OPENSEARCH` \$1 \$1 \$1 \$1 \$1 \$1 `ORACLE` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `PIPEDRIVE` `POSTGRESQL` `SAPHANA` `SQLSERVER` `SYNAPSE` `TERADATA` `TERADATANOS` `TIMESTREAM` `TPCDS` `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 個位元組，也不可以超過 2,048 個位元組。

  Spark 運算環境特定的連線屬性。
+ `AthenaProperties` – 金鑰值對的映射陣列。

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

  每個值均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  Athena 運算環境特定的連線屬性。
+ `PythonProperties` – 金鑰值對的映射陣列。

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

  每個值均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  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>

用於指定測試服務的連線的結構。

**欄位**
+ `ConnectionType` – *必要：*UTF-8 字串 （有效值： `JDBC` \$1 `SFTP` \$1 `MONGODB` `KAFKA` \$1 `NETWORK` `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 \$1 `GOOGLEADS` \$1 \$1 \$1 \$1 \$1 `GOOGLESHEETS` `GOOGLEANALYTICS4` `SERVICENOW` `MARKETO` `SAPODATA` `ZENDESK` `JIRACLOUD` `NETSUITEERP` `HUBSPOT` `FACEBOOKADS` \$1 \$1 `INSTAGRAMADS` \$1 \$1 \$1 `ZOHOCRM` \$1 \$1 \$1 \$1 `SALESFORCEPARDOT` `SALESFORCEMARKETINGCLOUD` `ADOBEANALYTICS` `SLACK` `LINKEDIN` `MIXPANEL` `ASANA` `STRIPE` \$1 `SMARTSHEET` \$1 \$1 `DATADOG` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `WOOCOMMERCE` `INTERCOM` `SNAPCHATADS` `PAYPAL` `QUICKBOOKS` `FACEBOOKPAGEINSIGHTS` `FRESHDESK` `TWILIO` `DOCUSIGNMONITOR` `FRESHSALES` `ZOOM` `GOOGLESEARCHCONSOLE` `SALESFORCECOMMERCECLOUD` `SAPCONCUR` `DYNATRACE` `MICROSOFTDYNAMIC365FINANCEANDOPS` `MICROSOFTTEAMS` `BLACKBAUDRAISEREDGENXT` `MAILCHIMP` `GITLAB` `PENDO` `PRODUCTBOARD` `CIRCLECI` `PIPEDIVE` `SENDGRID` `AZURECOSMOS` `AZURESQL` `BIGQUERY` `BLACKBAUD` `CLOUDERAHIVE` `CLOUDERAIMPALA` `CLOUDWATCH` `CLOUDWATCHMETRICS` `CMDB` `DATALAKEGEN2` `DB2` `DB2AS400` `DOCUMENTDB` `DOMO` `DYNAMODB` `GOOGLECLOUDSTORAGE` `HBASE` `KUSTOMER` `MICROSOFTDYNAMICS365CRM` `MONDAY` `MYSQL` `OKTA` \$1 \$1 \$1 \$1 \$1 \$1 `OPENSEARCH` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `ORACLE` `PIPEDRIVE` `POSTGRESQL` `SAPHANA` `SQLSERVER` `SYNAPSE` `TERADATA` `TERADATANOS` `TIMESTREAM` `TPCDS` `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 用戶端應用程式。

**欄位**
+ `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 操作傳回的連線定義。

**欄位**
+ `MatchCriteria` – UTF-8 字串的陣列，不可超過 10 個字串。

  條件字串必須符合連線定義中記錄的條件，才能傳回該連線定義。
+ `ConnectionType` – UTF-8 字串 （有效值： `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` `NETWORK` \$1 `MARKETPLACE` `CUSTOM` \$1 `SALESFORCE` `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 \$1 \$1 \$1 \$1 `MARKETO` `SAPODATA` `ZENDESK` `JIRACLOUD` `NETSUITEERP` `HUBSPOT` `FACEBOOKADS` `INSTAGRAMADS` `ZOHOCRM` \$1 \$1 `SALESFORCEPARDOT` \$1 \$1 `SALESFORCEMARKETINGCLOUD` \$1 \$1 `ADOBEANALYTICS` \$1 \$1 \$1 `SLACK` `LINKEDIN` `MIXPANEL` `ASANA` `STRIPE` `SMARTSHEET` `DATADOG` \$1 \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `SNAPCHATADS` `PAYPAL` `QUICKBOOKS` `FACEBOOKPAGEINSIGHTS` `FRESHDESK` `TWILIO` `DOCUSIGNMONITOR` `FRESHSALES` `ZOOM` `GOOGLESEARCHCONSOLE` `SALESFORCECOMMERCECLOUD` `SAPCONCUR` \$1 `DYNATRACE` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `ORACLE` \$1 \$1 \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` `MICROSOFTTEAMS` `BLACKBAUDRAISEREDGENXT` `MAILCHIMP` `GITLAB` `PENDO` `PRODUCTBOARD` `CIRCLECI` `PIPEDIVE` `SENDGRID` `AZURECOSMOS` `AZURESQL` `BIGQUERY` `BLACKBAUD` `CLOUDERAHIVE` `CLOUDERAIMPALA` `CLOUDWATCH` `CLOUDWATCHMETRICS` `CMDB` `DATALAKEGEN2` `DB2` `DB2AS400` `DOCUMENTDB` `DOMO` `DYNAMODB` `GOOGLECLOUDSTORAGE` `HBASE` `KUSTOMER` `MICROSOFTDYNAMICS365CRM` `MONDAY` `MYSQL` `OKTA` `OPENSEARCH` \$1 \$1 \$1 `PIPEDRIVE` \$1 \$1 \$1 `POSTGRESQL` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `SAPHANA` `SQLSERVER` `SYNAPSE` `TERADATA` `TERADATANOS` `TIMESTREAM` `TPCDS` `VERTICA`

  傳回的連線類型。目前不支援 SFTP。
+ `ConnectionSchemaVersion` – 數字 （整數），不可小於 1 或大於 2。

  表示連線是使用結構描述第 1 版還是第 2 版建立。

## AuthenticationConfiguration
<a name="aws-glue-api-catalog-connections-connections-AuthenticationConfiguration"></a>

包含身分驗證組態的結構。

**欄位**
+ `AuthenticationType` – UTF-8 字串 (有效值：`BASIC` \$1 `OAUTH2` \$1 `CUSTOM` \$1 `IAM`)。

  包含身分驗證組態的結構。
+ `SecretArn` – UTF-8 字串，需符合[Custom string pattern #36](aws-glue-api-common.md#regex_36)。

  用於儲存憑證的 Secret Manager ARN。
+ `KmsKeyArn` – UTF-8 字串，需符合[Custom string pattern #42](aws-glue-api-common.md#regex_42)。

  用於加密敏感身分驗證資訊的 KMS 金鑰的 Amazon Resource Name (ARN)。此金鑰用於保護儲存在身分驗證組態中的憑證和其他敏感資料。
+ `OAuth2Properties` – [OAuth2Properties](#aws-glue-api-catalog-connections-connections-OAuth2Properties) 物件。

  OAuth2 身分驗證的屬性。

## AuthenticationConfigurationInput 結構
<a name="aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput"></a>

CreateConnection 請求中包含身分驗證組態的結構。

**欄位**
+ `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 請求中儲存憑證的 Secret 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 個位元組，也不可以超過 2,048 個位元組。

  身分驗證類型為自訂身分驗證時使用的憑證。

## OAuth2Properties 結構
<a name="aws-glue-api-catalog-connections-connections-OAuth2Properties"></a>

包含 OAuth2 身分驗證屬性的結構。

**欄位**
+ `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 屬性的結構。

**欄位**
+ `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 用戶端應用程式。

**欄位**
+ `UserManagedClientApplicationClientId` – UTF-8 字串，長度不可超過 2048 個位元組，且需符合 [Custom string pattern #37](aws-glue-api-common.md#regex_37)。

  用戶端應用程式 clientID (如果 ClientAppType 為 `USER_MANAGED`)。
+ `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` 授權類型工作流程所需的屬性集。

**欄位**
+ `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` 值時提供基本身分驗證憑證。

**欄位**
+ `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 身分驗證時使用的憑證。

**欄位**
+ `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 Token (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>

在 Data Catalog 中建立連線定義。

用於建立聯合資源的連線需要 IAM `glue:PassConnection` 許可。

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  用於建立連線的 Data Catalog 之 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>

從 Data Catalog 刪除連線。

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  連線所在的 Data Catalog 之 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>

從 Data Catalog 擷取連線定義

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  連線所在的 Data Catalog 之 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` – [連線](#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>

從 Data Catalog 擷取連線定義清單。

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  連線所在的 Data Catalog 之 ID。如果未提供，預設會使用 AWS 帳戶 ID。
+ `Filter` – [GetConnectionsFilter](#aws-glue-api-catalog-connections-connections-GetConnectionsFilter) 物件。

  用於控制將傳回哪些連線的篩選條件。
+ `HidePassword` – 布林值。

  可讓您擷取連線中繼資料，無需傳回密碼。例如， AWS Glue 主控台會使用此旗標來擷取連線，而不會顯示密碼。當發起人可能沒有使用 AWS KMS 金鑰解密密碼的許可，但確實具有存取其餘連線屬性的許可時，請設定此參數。
+ `NextToken` – UTF-8 字串。

  接續符記，如果這是接續呼叫。
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。

  一次回應傳回的最大連線數量。

**回應**
+ `ConnectionList` – 一個 [連線](#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>

更新 Data Catalog 中的連線定義。

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  連線所在的 Data Catalog 之 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>

從 Data Catalog 刪除連線定義清單。

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  連線所在的 Data Catalog 之 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`

# Connection Types API
<a name="aws-glue-api-catalog-connections-connections-type"></a>

連線類型 API 說明與描述連線類型相關的 AWS Glue APIs。

## Connection Management 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` 定義可在傳遞至資料框的連線選項映射中的 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 傳回的支援連線類型的簡短資訊。

**欄位**
+ `ConnectionType` – UTF-8 字串 （有效值： `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` `NETWORK` \$1 `MARKETPLACE` `CUSTOM` \$1 `SALESFORCE` `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 \$1 `GOOGLEANALYTICS4` \$1 \$1 \$1 \$1 \$1 \$1 `SERVICENOW` `MARKETO` `SAPODATA` `ZENDESK` `JIRACLOUD` `NETSUITEERP` `HUBSPOT` `FACEBOOKADS` `INSTAGRAMADS` `ZOHOCRM` \$1 \$1 `SALESFORCEPARDOT` \$1 \$1 \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 \$1 \$1 `SLACK` `LINKEDIN` `MIXPANEL` `ASANA` `STRIPE` `SMARTSHEET` `DATADOG` \$1 `WOOCOMMERCE` \$1 \$1 `INTERCOM` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `SNAPCHATADS` `PAYPAL` `QUICKBOOKS` `FACEBOOKPAGEINSIGHTS` `FRESHDESK` `TWILIO` `DOCUSIGNMONITOR` `FRESHSALES` `ZOOM` `GOOGLESEARCHCONSOLE` `SALESFORCECOMMERCECLOUD` `SAPCONCUR` \$1 `DYNATRACE` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `ORACLE` \$1 \$1 \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` `MICROSOFTTEAMS` `BLACKBAUDRAISEREDGENXT` `MAILCHIMP` `GITLAB` `PENDO` `PRODUCTBOARD` `CIRCLECI` `PIPEDIVE` `SENDGRID` `AZURECOSMOS` `AZURESQL` `BIGQUERY` `BLACKBAUD` `CLOUDERAHIVE` `CLOUDERAIMPALA` `CLOUDWATCH` `CLOUDWATCHMETRICS` `CMDB` `DATALAKEGEN2` `DB2` `DB2AS400` `DOCUMENTDB` `DOMO` `DYNAMODB` `GOOGLECLOUDSTORAGE` `HBASE` `KUSTOMER` `MICROSOFTDYNAMICS365CRM` `MONDAY` `MYSQL` `OKTA` `OPENSEARCH` \$1 \$1 \$1 \$1 `PIPEDRIVE` \$1 \$1 `POSTGRESQL` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `SAPHANA` `SQLSERVER` `SYNAPSE` `TERADATA` `TERADATANOS` `TIMESTREAM` `TPCDS` `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 中連線類型的變體。連線類型變體為相同一般連線類型的不同實作提供了特定的組態和行為。

**欄位**
+ `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>

定義如何在連線屬性上執行驗證。

**欄位**
+ `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 傳回的連線的身分驗證組態。

**欄位**
+ `AuthenticationType` – *必要：*[屬性](#aws-glue-api-catalog-connections-connections-type-Property) 物件。

  用於連線的身分驗證類型。
+ `SecretArn` – [屬性](#aws-glue-api-catalog-connections-connections-type-Property) 物件。

  Secrets Manager 的 Amazon Resource Name (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 傳回的支援的身分驗證類型。

**欄位**
+ `SupportedAuthenticationTypes` – *必要：*UTF-8 字串陣列。

  支援的身分驗證類型清單。
+ `SupportedDataOperations` – *必要：*UTF-8 字串陣列。

  支援的資料操作清單。
+ `SupportedComputeEnvironments` – *必要：*UTF-8 字串陣列。

  支援的運算環境清單。

## 屬性結構
<a name="aws-glue-api-catalog-connections-connections-type-Property"></a>

定義運算環境連線類型的物件。

**欄位**
+ `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>

代表屬性允許值的物件。

**欄位**
+ `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) 組態的物件。

**欄位**
+ `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` 支援的實體。

**欄位**
+ `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` 物件具有與連接器中欄位關聯的不同屬性的相關資訊。

**欄位**
+ `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` – 布林值。

  指出此欄位是否可為 null。
+ `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。這可以是 null，根據預設， 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。這可以是 null，根據預設， 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 資料目錄的預覽資料。

以 JSON Blob 陣列傳回記錄。每個記錄都會根據 `DescribeEntity` API 定義的欄位類型，使用 Jackson JsonNode 進行格式化。

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。這可以是 null，根據預設， 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，也不可以大於 1,000。

  限制透過請求擷取的記錄數目。
+ `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)。

  函數所在的 Data Catalog 之 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>

在 Data Catalog 建立新的函數定義。

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  用於建立函數的 Data Catalog 之 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) 物件。

  定義在 Data Catalog 中所建立函數的 `FunctionInput` 物件。

**回應**
+ *無回應參數。*

**錯誤**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`

## UpdateUserDefinedFunction 動作 (Python: update\$1user\$1defined\$1function)
<a name="aws-glue-api-catalog-functions-UpdateUserDefinedFunction"></a>

更新 Data Catalog 中現有的函數定義

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  要更新函數所在 Data Catalog 的 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` 物件，可在 Data Catalog 內重新定義函數。

**回應**
+ *無回應參數。*

**錯誤**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`

## DeleteUserDefinedFunction 動作 (Python: delete\$1user\$1defined\$1function)
<a name="aws-glue-api-catalog-functions-DeleteUserDefinedFunction"></a>

從 Data Catalog 刪除現有的函數定義

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  欲刪除函數所在的 Data Catalog 之 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>

從 Data Catalog 擷取指定的函數定義

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  要擷取函數所在 Data Catalog 的 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>

從 Data Catalog 擷取多函數定義。

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  要擷取函數所在 Data Catalog 的 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 Data Catalog 匯入至 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)
+ [EncryptionConfiguration 結構](#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)
+ [EvaluationMetrics 結構](#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 連線名稱。

## EncryptionConfiguration 結構
<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`：將小型檔案合併為較大的檔案，通常以大小超過 100 MB 為目標，同時套用任何待定的刪除。這是適用於大多數使用案例的建議壓縮策略。
  +  `sort`：根據在壓縮期間以階層方式排序的所指定資料欄來組織資料，從而改善篩選操作的查詢效能。在您的查詢經常篩選特定資料欄時，建議使用此策略。若要使用此策略，您必須先使用 `sort_order` 資料表屬性在 Iceberg 資料表屬性中定義排序順序。
  +  `z-order`：透過將多個屬性混合到可用於排序的單一純量值來最佳化資料組織，從而實現跨多個維度的有效查詢。在您需要同時查詢多個維度的資料時，建議使用此策略。若要使用此策略，您必須先使用 `sort_order` 資料表屬性在 Iceberg 資料表屬性中定義排序順序。

  如果未提供輸入，則會使用預設值 '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`：將小型檔案合併為較大的檔案，通常以大小超過 100 MB 為目標，同時套用任何待定的刪除。這是適用於大多數使用案例的建議壓縮策略。
  +  `sort`：根據在壓縮期間以階層方式排序的所指定資料欄來組織資料，從而改善篩選操作的查詢效能。在您的查詢經常篩選特定資料欄時，建議使用此策略。若要使用此策略，您必須先使用 `sort_order` 資料表屬性在 Iceberg 資料表屬性中定義排序順序。
  +  `z-order`：透過將多個屬性混合到可用於排序的單一純量值來最佳化資料組織，從而實現跨多個維度的有效查詢。在您需要同時查詢多個維度的資料時，建議使用此策略。若要使用此策略，您必須先使用 `sort_order` 資料表屬性在 Iceberg 資料表屬性中定義排序順序。
+ `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。

## EvaluationMetrics 結構
<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` – 數字 (雙位數)。

  任務花費的 DPU 小時數。
+ `NumberOfDpus` – 數字 (整數)。

  任務耗用的 DPU 數目，四捨五入至最接近的整數。
+ `JobDurationInHour` – 數字 (雙位數)。

  任務的持續時間 (以小時為單位)。

## IcebergRetentionMetrics 結構
<a name="aws-glue-api-table-optimizers-IcebergRetentionMetrics"></a>

Iceberg 用於最佳化工具執行的快照保留指標。

**欄位**
+ `DpuHours` – 數字 (雙位數)。

  任務花費的 DPU 小時數。
+ `NumberOfDpus` – 數字 (整數)。

  任務耗用的 DPU 數目，四捨五入至最接近的整數。
+ `JobDurationInHour` – 數字 (雙位數)。

  任務的持續時間 (以小時為單位)。

## IcebergOrphanFileDeletionMetrics 結構
<a name="aws-glue-api-table-optimizers-IcebergOrphanFileDeletionMetrics"></a>

Iceberg 用於最佳化工具執行的孤立檔案刪除指標。

**欄位**
+ `DpuHours` – 數字 (雙位數)。

  任務花費的 DPU 小時數。
+ `NumberOfDpus` – 數字 (整數)。

  任務耗用的 DPU 數目，四捨五入至最接近的整數。
+ `JobDurationInHour` – 數字 (雙位數)。

  任務的持續時間 (以小時為單位)。

## 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 action (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 action (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` 分類器，或者透過 `Classifier` 物件中其中一個欄位指定的自訂 `CSV` 分類器。

**欄位**
+ `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` – 數字 (long)。

  此分類器的版本。
+ `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` – 數字 (long)。

  此分類器的版本。
+ `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` – 數字 (long)。

  此分類器的版本。
+ `JsonPath` – *必要：*UTF-8 字串。

  定義分類器要分類的 JSON 資料的`JsonPath`字串。 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` – 數字 (long)。

  此分類器的版本。
+ `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，並且將在資料目錄中套用該 Serde。有效值為 `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 字串。

  定義分類器要分類的 JSON 資料的`JsonPath`字串。 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 字串。

  定義分類器要分類的 JSON 資料的`JsonPath`字串。 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，並且將在資料目錄中套用該 Serde。有效值為 `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，並且將在資料目錄中套用該 Serde。有效值為 `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>

從 Data Catalog 移除分類器。

**請求**
+ `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>

列出 Data Catalog 中所有的分類器物件。

**請求**
+ `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。

**欄位**
+ `Name` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  爬蟲程式的名稱。
+ `Role` – UTF-8 字串。

  用來存取 Amazon Simple Storage Service (Amazon S3) 資料等客戶資源 IAM 角色的 Amazon Resource Name (ARN)。
+ `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` – [Schedule](aws-glue-api-crawler-scheduler.md#aws-glue-api-crawler-scheduler-Schedule) 物件。

  如為排程的爬蟲程式，也就是爬蟲程式執行的排程。
+ `CrawlElapsedTime` – 數字 (long)。

  如果爬蟲程式正在執行，包含爬蟲程式上次啟動後經過的總時間。
+ `CreationTime` – 時間戳記。

  爬蟲程式建立的時間。
+ `LastUpdated` – 時間戳記。

  爬蟲程式上次更新的時間。
+ `LastCrawl` – [LastCrawlInfo](#aws-glue-api-crawler-crawling-LastCrawlInfo) 物件。

  最後一次編目的狀態，以及發生錯誤時的可能錯誤資訊。
+ `Version` – 數字 (long)。

  爬蟲程式的版本。
+ `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` 陳述式來將事件排程。

**欄位**
+ `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>

指定要編目的資料存放區。

**欄位**
+ `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) 中資料存放區。

**欄位**
+ `Path` – UTF-8 字串。

  至 Amazon S3 目標的路徑。
+ `Exclusions` – UTF-8 字串陣列。

  用於排除於編目的 glob 模式清單。如需詳細資訊，請參閱[使用爬蟲程式建立資料表目錄](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html)。
+ `ConnectionName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  連線的名稱，允許任務或爬蟲程式在 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 資料來源的目標。

**欄位**
+ `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>

指定寫入 Delta Lake 資料來源的目標 Amazon S3。

**欄位**
+ `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 資料存放區。

**欄位**
+ `ConnectionName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  用來連接到 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 資料存放區。

**欄位**
+ `ConnectionName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  用來連接到 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 資料表。

**欄位**
+ `Path` – UTF-8 字串。

  所要抓取 DynamoDB 資料表的名稱。
+ `scanAll` – 布林值。

  指出是否掃描所有記錄，還是從資料表中取樣資料列。當資料表不是高傳輸量資料表時，掃描所有記錄可能需要很長的時間。

  一個 `true` 值代表會掃描所有記錄，而一個 `false` 值代表會取樣記錄。如果未指定任何值，則預設值為 `true`。
+ `scanRate` – 數字 (雙位數)。

   AWS Glue 爬蟲程式要使用的已設定讀取容量單位百分比。讀取容量單位是 DynamoDB 定義的術語，此數值可作為每秒可在該資料表上執行的讀取次數速率限制符號。

  有效值為 null 值或介於 0.1 到 1.5 之間的值。當使用者未提供值，且預設為已設定讀取容量單位的 0.5 (針對已佈建的資料表)，或最大設定讀取容量單位的 0.25 (針對使用隨需模式的資料表) 時，系統會使用 Null 值。

## DeltaTarget 結構
<a name="aws-glue-api-crawler-crawling-DeltaTarget"></a>

指定用於網路爬取一個或多個 Delta 資料表的 Delta 資料存放區。

**欄位**
+ `DeltaTables` – UTF-8 字串陣列。

  Delta 資料表的 Amazon S3 路徑清單。
+ `ConnectionName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  用來連接到 Delta 資料表目標的連線名稱。
+ `WriteManifest` – 布林值。

  指定是否將資訊清單檔案寫入 Delta 資料表路徑。
+ `CreateNativeDeltaTable` – 布林值。

  指定爬蟲程式是否要建立原生資料表，以便與支援直接查詢 Delta 交易記錄日誌的查詢引擎整合。

## IcebergTarget 結構
<a name="aws-glue-api-crawler-crawling-IcebergTarget"></a>

指定 Apache Iceberg 資料來源，其中 Iceberg 資料表存放在 Amazon S3中。

**欄位**
+ `Paths` – UTF-8 字串陣列。

  包含 Iceberg 中繼資料資料夾做為 的一或多個 Amazon S3 路徑`s3://bucket/prefix`。
+ `ConnectionName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  用來連線到 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 資料來源。

**欄位**
+ `Paths` – UTF-8 字串陣列。

  Hudi Amazon S3 的位置字串陣列，每個字串都會指出 Hudi 資料表中繼資料檔案所在的根資料夾。Hudi 資料夾可能位於根資料夾的子資料夾中。

  爬蟲程式將掃描路徑下所有資料夾中的 Hudi 資料夾。
+ `ConnectionName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  用來連線到 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 目標。

**欄位**
+ `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 個位元組，也不可以超過 2,048 個位元組。

  配對使用 `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>

指定爬蟲程式的指標。

**欄位**
+ `CrawlerName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  爬蟲程式的名稱。
+ `TimeLeftSeconds` – 數字 (雙精度浮點數)，不可大於 None (無)。

  完成執行中爬蟲程式的預估剩餘時間。
+ `StillEstimating` – 布林值。

  假如爬蟲程式仍在預估完成執行所需要的時間，將顯示 True。
+ `LastRuntimeSeconds` – 數字 (雙精度浮點數)，不可大於 None (無)。

  爬蟲程式最近一次執行的持續時間 (以秒為單位)。
+ `MedianRuntimeSeconds` – 數字 (雙精度浮點數)，不可大於 None (無)。

  此爬蟲程式執行的中位數持續時間 (以秒為單位)。
+ `TablesCreated` – 數字 (整數)，不可大於 None (無)。

  此爬蟲程式建立的資料表數量。
+ `TablesUpdated` – 數字 (整數)，不可大於 None (無)。

  此爬蟲程式更新的資料表數量。
+ `TablesDeleted` – 數字 (整數)，不可大於 None (無)。

  此爬蟲程式刪除的資料表數量。

## CrawlerHistory 結構
<a name="aws-glue-api-crawler-crawling-CrawlerHistory"></a>

包含爬蟲程式的執行資訊。

**欄位**
+ `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` – 數字 (雙精度浮點數)，不可大於 None (無)。

  網路爬取所使用的資料處理單位 (DPU) 的數目 (以小時為單位)。

## CrawlsFilter 結構
<a name="aws-glue-api-crawler-crawling-CrawlsFilter"></a>

欄位、比較運算子和值的清單，您可以用來篩選指定爬蟲程式的爬蟲程式執行。

**欄位**
+ `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>

可以針對爬蟲程式指定更新和刪除行為的政策。

**欄位**
+ `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>

關於最近一次編目的狀態和錯誤探索。

**欄位**
+ `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)。

**欄位**
+ `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>

指定爬蟲程式的資料歷程組態設定。

**欄位**
+ `CrawlerLineageSettings` – UTF-8 字串 (有效值：`ENABLE` \$1 `DISABLE`)。

  指定是否啟用爬蟲程式的資料歷程。有效的值如下：
  + ENABLE：啟用爬蟲程式的資料歷程
  + DISABLE：停用爬蟲程式的資料歷程

## LakeFormationConfiguration 結構
<a name="aws-glue-api-crawler-crawling-LakeFormationConfiguration"></a>

指定爬蟲程式的 AWS Lake Formation 組態設定。

**欄位**
+ `UseLakeFormationCredentials` – 布林值。

  指定是否使用爬蟲程式的 AWS Lake Formation 登入資料，而非 IAM 角色登入資料。
+ `AccountId` – UTF-8 字串，長度不可超過 12 個位元組。

  跨帳戶網路爬取的必要項目。對於與目標資料相同的帳戶網路爬取，則可以將其保留為 null。

## 作業
<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 中的 中的標籤 AWS Glue](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 個字串。

  未尋獲爬蟲程式的名稱清單。

**錯誤**
+ `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 APIs。

## 資料類型
<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)。

  資料表所在的 Data Catalog 的 ID。如果未提供，預設會使用 AWS 帳戶 ID。
+ `Role` – UTF-8 字串。

  服務用於產生統計資料的 IAM 角色。
+ `SampleSize`：數字 (雙位數)，不可大於 100。

  用來產生統計資料的資料列百分比。若未提供，則系統將會使用整個資料表產生統計資料。
+ `SecurityConfiguration` – UTF-8 字串，長度不可超過 128 個位元組。

  用於加密資料欄統計資料任務執行之 CloudWatch 日誌的安全組態名稱。
+ `NumberOfWorkers` – 數字 (整數)，至少為 1。

  用於產生資料欄統計資料的工作者數量。此任務已預先設定為自動擴展至 25 個執行個體。
+ `WorkerType` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  用於產生統計資料的工作者類型。預設值為 `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` – 數字 (雙精度浮點數)，不可大於 None (無)。

  所有自動擴展之工作者的計算 DPU 用量 (以秒為單位)。

## ColumnStatisticsTaskSettings 結構
<a name="aws-glue-api-crawler-column-statistics-ColumnStatisticsTaskSettings"></a>

資料欄統計資料任務的設定。

**欄位**
+ `DatabaseName` – UTF-8 字串。

  資料表所在的資料庫名稱。
+ `TableName` – UTF-8 字串。

  為其產生資料欄統計資料的資料表名稱。
+ `Schedule` – [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)。

  資料庫存放所在 Data Catalog 的 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)。

  資料表所在之 Data Catalog 的 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)。

  資料庫存放所在 Data Catalog 的 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)。

  資料庫存放所在 Data Catalog 的 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` – [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` – [Location](#aws-glue-api-etl-script-generation-Location) 物件。

  映射用的參數。
+ `Language` – UTF-8 字串 (有效值：`PYTHON` \$1 `SCALA`)。

  用來進行映射的程式碼的程式設計語言。
+ `AdditionalPlanOptionsMap` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串。

  每個值都是 UTF-8 字串。

  用於保存額外選用鍵-值參數的映射。

  目前支援下列鍵值對：
  + `inferSchema`  —  指定任務所產生的預設指令碼是`inferSchema`設定為 true 還是 false AWS Glue 。例如，若要將 `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 可讓您使用代表任務視覺化組態的 JSON 物件中的 AWS Glue API 來建立資料整合 AWS Glue 任務。

清單`CodeGenConfigurationNodes`會提供給建立或更新任務 API，以在 AWS Glue Studio 中為建立的任務註冊 DAG，並產生相關聯的程式碼。

## 資料類型
<a name="aws-glue-api-visual-job-api-objects"></a>
+ [CodeGenConfigurationNode 結構](#aws-glue-api-visual-job-api-CodeGenConfigurationNode)
+ [JDBCConnectorOptions 結構](#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)
+ [AggregateOperation 結構](#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` 列舉所有有效的節點類型。僅可以填入一個成員變數。

**欄位**
+ `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) 物件。

  指定 Data Catalog 中的 AWS Glue 資料存放區。
+ `RedshiftSource` – [RedshiftSource](#aws-glue-api-visual-job-api-RedshiftSource) 物件。

  指定 Amazon Redshift 資料存放區。
+ `S3CatalogSource` – [S3CatalogSource](#aws-glue-api-visual-job-api-S3CatalogSource) 物件。

  在 Data Catalog 中指定 Amazon S3 AWS Glue 資料存放區。
+ `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) 物件。

  指定 Data Catalog 中的 DynamoDBC Catalog AWS Glue 資料存放區。
+ `JDBCConnectorTarget` – [JDBCConnectorTarget](#aws-glue-api-visual-job-api-JDBCConnectorTarget) 物件。

  指定以 Apache Parquet 直欄式儲存寫入 Amazon S3 的資料目標。
+ `SparkConnectorTarget` – [SparkConnectorTarget](#aws-glue-api-visual-job-api-SparkConnectorTarget) 物件。

  指定使用 Apache Spark 連接器的目標。
+ `CatalogTarget` – [BasicCatalogTarget](#aws-glue-api-visual-job-api-BasicCatalogTarget) 物件。

  指定使用 AWS Glue Data Catalog 資料表的目標。
+ `RedshiftTarget` – [RedshiftTarget](#aws-glue-api-visual-job-api-RedshiftTarget) 物件。

  指定使用 Amazon Redshift 的目標。
+ `S3CatalogTarget` – [S3CatalogTarget](#aws-glue-api-visual-job-api-S3CatalogTarget) 物件。

  指定使用 Data Catalog 寫入 Amazon S3 AWS Glue 的資料目標。
+ `S3GlueParquetTarget` – [S3GlueParquetTarget](#aws-glue-api-visual-job-api-S3GlueParquetTarget) 物件。

  指定以 Apache Parquet 直欄式儲存寫入 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` – [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 Data Catalog 中指定 Kinesis 資料來源。
+ `CatalogKafkaSource` – [CatalogKafkaSource](#aws-glue-api-visual-job-api-CatalogKafkaSource) 物件。

  指定 Data Catalog 中的 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` – [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) 物件。

  指定受管 Data Catalog 中的 資料來源。
+ `MicrosoftSQLServerCatalogSource` – [MicrosoftSQLServerCatalogSource](#aws-glue-api-visual-job-api-MicrosoftSQLServerCatalogSource) 物件。

  指定 AWS Glue Data Catalog 中的 Microsoft SQL 伺服器資料來源。
+ `MySQLCatalogSource` – [MySQLCatalogSource](#aws-glue-api-visual-job-api-MySQLCatalogSource) 物件。

  在 AWS Glue Data Catalog 中指定 MySQL 資料來源。
+ `OracleSQLCatalogSource` – [OracleSQLCatalogSource](#aws-glue-api-visual-job-api-OracleSQLCatalogSource) 物件。

  在 AWS Glue Data Catalog 中指定 Oracle 資料來源。
+ `PostgreSQLCatalogSource` – [PostgreSQLCatalogSource](#aws-glue-api-visual-job-api-PostgreSQLCatalogSource) 物件。

  在 AWS Glue Data Catalog 中指定 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) 物件。

  指定存放於 的 Hudi 資料來源 Amazon S3。
+ `S3HudiCatalogTarget` – [S3HudiCatalogTarget](#aws-glue-api-visual-job-api-S3HudiCatalogTarget) 物件。

  指定在 AWS Glue Data Catalog 中寫入 Hudi 資料來源的目標。
+ `S3HudiDirectTarget` – [S3HudiDirectTarget](#aws-glue-api-visual-job-api-S3HudiDirectTarget) 物件。

  指定寫入 Hudi 資料來源的目標 Amazon S3。
+ `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) 物件。

  指定存放於 的 Delta Lake 資料來源 Amazon S3。
+ `S3DeltaCatalogTarget` – [S3DeltaCatalogTarget](#aws-glue-api-visual-job-api-S3DeltaCatalogTarget) 物件。

  指定在 AWS Glue Data Catalog 中寫入 Delta Lake 資料來源的目標。
+ `S3DeltaDirectTarget` – [S3DeltaDirectTarget](#aws-glue-api-visual-job-api-S3DeltaDirectTarget) 物件。

  指定寫入 Delta Lake 資料來源的目標 Amazon S3。
+ `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` – [S3CatalogIcebergSource](#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 連接器來源。

## JDBCConnectorOptions 結構
<a name="aws-glue-api-visual-job-api-JDBCConnectorOptions"></a>

連接器的其他連接選項。

**欄位**
+ `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` – 數字 (long)，不可大於 None (無)。

  用來決定分割區步幅的 `partitionColumn` 最小值。
+ `UpperBound` – 數字 (long)，不可大於 None (無)。

  用來決定分割區步幅的 `partitionColumn` 最大值。
+ `NumPartitions` – 數字 (long)，不可大於 None (無)。

  分割區數。這個值，搭配 `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 資料類型的映射。例如， 選項會透過呼叫驅動程式的 `ResultSet.getString()`方法，將 JDBC 類型的資料欄位`"dataTypeMapping":{"FLOAT":"STRING"}`映射`FLOAT`至 Java `String`類型，並使用它來建置 AWS Glue 記錄。`ResultSet` 物件是由每個驅動程式實作，因此行為是特定於您使用的驅動程式。請參閱 JDBC 驅動程式的文件，瞭解驅動程式如何執行轉換。

## StreamingDataPreviewOptions 結構
<a name="aws-glue-api-visual-job-api-StreamingDataPreviewOptions"></a>

指定與資料預覽相關的選項，以檢視資料範例。

**欄位**
+ `PollingTime` – 數字 (長)，至少為 10。

  輪詢時間 (以毫秒為單位)。
+ `RecordPollingLimit` – 數字 (長)，至少為 1。

  輪詢的記錄數上限。

## AthenaConnectorSource 結構
<a name="aws-glue-api-visual-job-api-AthenaConnectorSource"></a>

指定 Amazon Athena 資料來源的連接器。

**欄位**
+ `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)。

  連線類型，例如 marketplace.athena 或 custom.athena，指定連線到 Amazon 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 資料來源的連接器。

**欄位**
+ `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)。

  連線類型，例如 marketplace.jdbc 或 custom.jdbc，同時指定與 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 資料來源的連接器。

**欄位**
+ `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)。

  連接的類型，如 marketplace.spark 或 custom.spark，指定 Apache 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>

指定 Data Catalog 中的 AWS Glue 資料存放區。

**欄位**
+ `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 Data Catalog 中指定 MySQL 資料來源。

**欄位**
+ `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 Data Catalog 中指定 PostgresSQL 資料來源。

**欄位**
+ `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 Data Catalog 中指定 Oracle 資料來源。

**欄位**
+ `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 Data Catalog 中的 Microsoft SQL 伺服器資料來源。

**欄位**
+ `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 Data Catalog 中指定 Kinesis 資料來源。

**欄位**
+ `Name` – *必要：*UTF-8 字串，需符合[Custom string pattern #63](aws-glue-api-common.md#regex_63)。

  資料來源的名稱。
+ `WindowSize` – 數字 (整數)，不可大於 None (無)。

  處理每個微批次的時間量。
+ `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 資料來源。

**欄位**
+ `Name` – *必要：*UTF-8 字串，需符合[Custom string pattern #63](aws-glue-api-common.md#regex_63)。

  資料來源的名稱。
+ `WindowSize` – 數字 (整數)，不可大於 None (無)。

  處理每個微批次的時間量。
+ `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 串流資料來源的其他選項。

**欄位**
+ `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"`。

  注意：僅 4.0 AWS Glue 版或更新版本支援使用 "startingPosition" 的 UTC 格式時間戳記字串值。
+ `MaxFetchTimeInMs` – 數字 (long)，不可大於 None (無)。

  任務執行器從 Kinesis 資料串流讀取目前批次記錄所花費的最長時間，以毫秒 (ms) 為單位指定。在此期間可以進行多次 `GetRecords` API 呼叫。預設值為 `1000`。
+ `MaxFetchRecordsPerShard` – 數字 (long)，不可大於 None (無)。

  每個微批次的 Kinesis 資料串流中每個碎片要擷取的記錄數目上限。注意：如果串流任務已從 Kinesis 讀取額外的記錄 (在相同的 get-records 呼叫中)，用戶端可以超過此限制。如果 `MaxFetchRecordsPerShard` 需要嚴格控制，則其必須是 `MaxRecordPerRead` 的倍數。預設值為 `100000`。
+ `MaxRecordPerRead` – 數字 (long)，不可大於 None (無)。

  要從每個 getRecords 操作的 Kinesis 資料串流中擷取的記錄數量上限。預設值為 `10000`。
+ `AddIdleTimeBetweenReads` – 布林值。

  增加兩個連續 getRecords 操作之間的時間延遲。預設值為 `"False"`。此選項僅在 AWS Glue 2.0 及更高版本上才可設定。
+ `IdleTimeBetweenReadsInMs` – 數字 (long)，不可大於 None (無)。

  連續兩個 getRecords 操作之間的最小延遲時間，以毫秒為單位指定。預設值為 `1000`。此選項僅適用於 2.0 版及更新 AWS Glue 版本。
+ `DescribeShardInterval` – 數字 (long)，不可大於 None (無)。

  指令碼考慮重新分片之兩個 ListShards API 呼叫之間的最小時間間隔。預設值為 `1s`。
+ `NumRetries` – 數字 (整數)，不可大於 None (無)。

  Kinesis Data Streams API 請求的重試數上限。預設值為 `3`。
+ `RetryIntervalMs` – 數字 (long)，不可大於 None (無)。

  重試 Kinesis Data Streams API 呼叫之前的冷卻時間期間 (以毫秒為單位)。預設值為 `1000`。
+ `MaxRetryIntervalMs` – 數字 (long)，不可大於 None (無)。

  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' 時，每個批次都會在串流接收的最舊記錄到送達 AWS Glue CloudWatch 的時間之間發出指標。指標的名稱為 "glue.driver.streaming.maxConsumerLagInMs"。預設值為 'false'。在 AWS Glue 4.0 版或更新版中支援此選項。
+ `StartingTimestamp` – UTF-8 字串。

  Kinesis 資料串流中開始讀取資料之記錄的時間戳記。可能的值是 `yyyy-mm-ddTHH:MM:SSZ` 模式的 UTC 格式的時間戳記字串 (其中 Z 代表以 \$1/- 表示的 UTC 時區偏移。例如："2023-04-04T08:00:00\$108:00")。
+ `FanoutConsumerARN` – UTF-8 字串，需符合[Custom string pattern #61](aws-glue-api-common.md#regex_61)。

  Kinesis Data Streams 增強型展開傳送消費者的 Amazon Resource Name (ARN)。指定時，會針對專用輸送量啟用增強型展開傳送，並降低延遲資料取用。

## CatalogKafkaSource 結構
<a name="aws-glue-api-visual-job-api-CatalogKafkaSource"></a>

指定 Data Catalog 中的 Apache Kafka 資料存放區。

**欄位**
+ `Name` – *必要：*UTF-8 字串，需符合[Custom string pattern #63](aws-glue-api-common.md#regex_63)。

  資料存放區的名稱。
+ `WindowSize` – 數字 (整數)，不可大於 None (無)。

  處理每個微批次的時間量。
+ `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 資料存放區。

**欄位**
+ `Name` – *必要：*UTF-8 字串，需符合[Custom string pattern #63](aws-glue-api-common.md#regex_63)。

  資料存放區的名稱。
+ `StreamingOptions` – [KafkaStreamingSourceOptions](#aws-glue-api-visual-job-api-KafkaStreamingSourceOptions) 物件。

  指定串流選項。
+ `WindowSize` – 數字 (整數)，不可大於 None (無)。

  處理每個微批次的時間量。
+ `DetectSchema` – 布林值。

  是否自動從傳入資料確定結構描述。
+ `DataPreviewOptions` – [StreamingDataPreviewOptions](#aws-glue-api-visual-job-api-StreamingDataPreviewOptions) 物件。

  指定與資料預覽相關的選項，以檢視資料範例。

## KafkaStreamingSourceOptions 結構
<a name="aws-glue-api-visual-job-api-KafkaStreamingSourceOptions"></a>

其他串流選項。

**欄位**
+ `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 呼叫中指定，或在 Data Catalog 的資料表中繼資料中定義。
+ `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 中指定的主題名稱。您必須指定至少 1 個 `"topicName"`、`"assign"` 或 `"subscribePattern"`。
+ `Assign` – UTF-8 字串，需符合[Custom string pattern #61](aws-glue-api-common.md#regex_61)。

  要取用的特定 `TopicPartitions`。您必須指定至少 1 個 `"topicName"`、`"assign"` 或 `"subscribePattern"`。
+ `SubscribePattern` – UTF-8 字串，需符合[Custom string pattern #61](aws-glue-api-common.md#regex_61)。

  識別要訂閱的主題清單的 Java regex 字串。您必須指定至少 1 個 `"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` – 數字 (long)，不可大於 None (無)。

  在 Spark 任務執行器中從 Kafka 輪詢資料的逾時 (以毫秒為單位)。預設值為 `512`。
+ `NumRetries` – 數字 (整數)，不可大於 None (無)。

  擷取 Kafka 位移失敗之前，要重試的次數。預設值為 `3`。
+ `RetryIntervalMs` – 數字 (long)，不可大於 None (無)。

  重試擷取 Kafka 偏移量之前等待的時間 (毫秒)。預設值為 `10`。
+ `MaxOffsetsPerTrigger` – 數字 (long)，不可大於 None (無)。

  每個觸發程序間隔所處理之偏移數目上限的速率限制。指定的偏移總數會按比例跨 `topicPartitions` 或不同磁碟區而分割。預設值為 null，這表示消費者讀取所有偏移，直到已知的最新偏移。
+ `MinPartitions` – 數字 (整數)，不可大於 None (無)。

  從 Kafka 讀取所需的分割區最小數量。預設值為 null，這表示 Spark 分割區的數量等於 Kafka 分割區的數量。
+ `IncludeHeaders` – 布林值。

  是否包括 Kafka 標頭。當選項設定為「true」時，資料輸出將包含一個名為「glue\$1streaming\$1kafka\$1headers」的額外欄，其類型為 `Array[Struct(key: String, value: String)]`。預設值為 "false"。此選項僅適用於 3.0 AWS Glue 版或更新版本。
+ `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」時，每個批次都會在主題接收的最舊記錄到送達 AWS Glue CloudWatch 的時間之間發出指標。指標的名稱為 "glue.driver.streaming.maxConsumerLagInMs"。預設值為 'false'。在 AWS Glue 4.0 版或更新版中支援此選項。
+ `StartingTimestamp` – UTF-8 字串。

  Kafka 主題中開始讀取資料之記錄的時間戳記。可能的值是 `yyyy-mm-ddTHH:MM:SSZ` 模式的 UTC 格式的時間戳記字串 (其中 Z 代表以 \$1/- 表示的 UTC 時區偏移。例如："2023-04-04T08:00:00\$108:00")。

  只能設定 `StartingTimestamp` 或 `StartingOffsets`。

## RedshiftSource 結構
<a name="aws-glue-api-visual-job-api-RedshiftSource"></a>

指定 Amazon Redshift 資料存放區。

**欄位**
+ `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 來源。

**欄位**
+ `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 Reshift 來源節點的資料。

## AmazonRedshiftNodeData 結構
<a name="aws-glue-api-visual-job-api-AmazonRedshiftNodeData"></a>

指定 Amazon Redshift 節點。

**欄位**
+ `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 資料目錄時的資料目錄資料表名稱。
+ `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 字串。

  當 SourceType 為「查詢」時，用於從 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 叢集時指定選用值。

**欄位**
+ `Key` – UTF-8 字串。

  其他連線選項的金鑰。
+ `Value` – UTF-8 字串。

  其他連線選項的值。

## 選項結構
<a name="aws-glue-api-visual-job-api-Option"></a>

指定選項值。

**欄位**
+ `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>

在 Data Catalog 中指定 Amazon S3 AWS Glue 資料存放區。

**欄位**
+ `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 資料存放區的其他連線選項。

**欄位**
+ `BoundedSize` – 數字 (long)。

  設定要處理之資料集的目標大小上限 (以位元組為單位)。
+ `BoundedFiles` – 數字 (long)。

  設定要處理的檔案目標數目的上限。

## S3CsvSource 結構
<a name="aws-glue-api-visual-job-api-S3CsvSource"></a>

指定存放在 Amazon S3 中的命令分隔值 (CSV) 資料存放區。

**欄位**
+ `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` – 數字 (整數)，不可大於 None (無)。

  此選項可控制 s3 清單可能會在多長時間 (以毫秒為單位) 後變得一致。使用 JobBookmarks 來考量 Amazon S3 最終一致性時，會特別追蹤修改時間戳記落在最後 maxBand 毫秒內的檔案。使用者大多不需要設定此選項。預設值為 900000 毫秒或 15 分鐘。
+ `MaxFilesInBand` – 數字 (整數)，不可大於 None (無)。

  此選項會指定從最後 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 為基礎的直欄式記憶體格式。僅適用於 3.0 AWS Glue 版。
+ `OutputSchemas` – 一個 [GlueSchema](#aws-glue-api-visual-job-api-GlueSchema) 物件陣列。

  指定自訂 S3 CSV 來源的資料結構描述。

## DirectJDBCSource 結構
<a name="aws-glue-api-visual-job-api-DirectJDBCSource"></a>

指定直接 JDBC 來源連線。

**欄位**
+ `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 資料存放區的其他連線選項。

**欄位**
+ `BoundedSize` – 數字 (long)。

  設定要處理之資料集的目標大小上限 (以位元組為單位)。
+ `BoundedFiles` – 數字 (long)。

  設定要處理的檔案目標數目的上限。
+ `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 資料存放區。

**欄位**
+ `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` – 數字 (整數)，不可大於 None (無)。

  此選項可控制 s3 清單可能會在多長時間 (以毫秒為單位) 後變得一致。使用 JobBookmarks 來考量 Amazon S3 最終一致性時，會特別追蹤修改時間戳記落在最後 maxBand 毫秒內的檔案。使用者大多不需要設定此選項。預設值為 900000 毫秒或 15 分鐘。
+ `MaxFilesInBand` – 數字 (整數)，不可大於 None (無)。

  此選項會指定從最後 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 資料存放區。

**欄位**
+ `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` – 數字 (整數)，不可大於 None (無)。

  此選項可控制 s3 清單可能會在多長時間 (以毫秒為單位) 後變得一致。使用 JobBookmarks 來考量 Amazon S3 最終一致性時，會特別追蹤修改時間戳記落在最後 maxBand 毫秒內的檔案。使用者大多不需要設定此選項。預設值為 900000 毫秒或 15 分鐘。
+ `MaxFilesInBand` – 數字 (整數)，不可大於 None (無)。

  此選項會指定從最後 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>

指定存放於 的 Delta Lake 資料來源 Amazon S3。

**欄位**
+ `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。

**欄位**
+ `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 資料來源。

**欄位**
+ `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>

指定存放於 的 Hudi 資料來源 Amazon S3。

**欄位**
+ `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。

**欄位**
+ `Name` – *必要：*UTF-8 字串，需符合[Custom string pattern #63](aws-glue-api-common.md#regex_63)。

  Hudi 資料來源的名稱。
+ `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 資料來源。

**欄位**
+ `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` – 數字 (整數)，不可大於 None (無)。

  要使用的處理頻段數目上限。
+ `MaxFilesInBand` – 數字 (整數)，不可大於 None (無)。

  每個頻段中要處理的檔案數目上限。
+ `AdditionalOptions` – [S3DirectSourceAdditionalOptions](#aws-glue-api-visual-job-api-S3DirectSourceAdditionalOptions) 物件。

  S3 直接來源處理的其他組態選項。
+ `NumberRows` – 數字 (long)。

  從每個 Excel 檔案處理的資料列數。
+ `SkipFooter` – 數字 (整數)，不可大於 None (無)。

  每個 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 資料來源。

**欄位**
+ `Name` – *必要：*UTF-8 字串，需符合[Custom string pattern #63](aws-glue-api-common.md#regex_63)。

  Hudi 資料來源的名稱。
+ `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 Data Catalog 中指定 DynamoDB 資料來源。

**欄位**
+ `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 Data Catalog 中的關聯式資料庫資料來源。

**欄位**
+ `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 Parquet 直欄式儲存寫入 Amazon S3 的資料目標。

**欄位**
+ `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)。

  連線類型，例如 marketplace.jdbc 或 custom.jdbc，指定與 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 連接器的目標。

**欄位**
+ `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)。

  連接的類型，如 marketplace.spark 或 custom.spark，指定 Apache 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 Data Catalog 資料表的目標。

**欄位**
+ `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)。

  從清單中選擇包含要用作目標之資料表的資料庫。此資料庫必須存在於 Data Catalog 中。
+ `Table` – *必要：*UTF-8 字串，需符合[Custom string pattern #61](aws-glue-api-common.md#regex_61)。

  定義輸出資料結構描述的資料表。此資料表必須已存在於 Data Catalog 中。

## MySQLCatalogTarget 結構
<a name="aws-glue-api-visual-job-api-MySQLCatalogTarget"></a>

指定使用 MySQL 的目標。

**欄位**
+ `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 的目標。

**欄位**
+ `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 的目標。

**欄位**
+ `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 的目標。

**欄位**
+ `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 的目標。

**欄位**
+ `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 目標。

**欄位**
+ `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 操作的選項。

**欄位**
+ `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>

指定使用 Data Catalog 寫入 Amazon S3 AWS Glue 的資料目標。

**欄位**
+ `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 Parquet 直欄式儲存寫入 Amazon S3 的資料目標。

**欄位**
+ `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>

可以針對爬蟲程式指定更新行為的政策。

**欄位**
+ `EnableUpdateCatalog` – 布林值。

  爬蟲程式找到變更的結構描述時是否使用指定的更新行為。
+ `UpdateBehavior` – UTF-8 字串 (有效值：`UPDATE_IN_DATABASE` \$1 `LOG`)。

  爬蟲程式找到變更結構描述時的更新行為。

## S3DirectTarget 結構
<a name="aws-glue-api-visual-job-api-S3DirectTarget"></a>

指定寫入 Amazon S3 的資料目標。

**欄位**
+ `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 資料來源的目標。

**欄位**
+ `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>

指定寫入 Hudi 資料來源的目標 Amazon S3。

**欄位**
+ `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 資料來源的目標。

**欄位**
+ `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>

指定寫入 Delta Lake 資料來源的目標 Amazon S3。

**欄位**
+ `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 資料目標。

**欄位**
+ `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 資料來源的目標。

**欄位**
+ `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>

可以針對爬蟲程式指定更新行為的政策。

**欄位**
+ `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>

指定將資料來源中的資料屬性索引鍵映射至資料目標中資料屬性索引鍵的轉換。您可以重新命名索引鍵、修改索引鍵的資料類型，以及選擇要從資料集中捨棄哪些索引鍵。

**欄位**
+ `Name` – *必要：*UTF-8 字串，需符合[Custom string pattern #63](aws-glue-api-common.md#regex_63)。

  轉換節點的名稱。
+ `Inputs` – *必要：*UTF-8 字串的陣列，不可小於 1 或超過 1 個字串。

  由其節點名稱識別的資料輸入。
+ `Mapping` – *必要：*一個 [映射](#aws-glue-api-visual-job-api-Mapping) 物件。

  將資料來源中的資料屬性索引鍵映射至資料目標中的資料屬性索引鍵。

## Mapping 結構
<a name="aws-glue-api-visual-job-api-Mapping"></a>

指定資料屬性索引鍵的映射。

**欄位**
+ `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` – 一個 [映射](#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>

指定選擇要保留之資料屬性索引鍵的轉換。

**欄位**
+ `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>

指定選擇要捨棄之資料屬性索引鍵的轉換。

**欄位**
+ `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>

指定重新命名單一資料屬性索引鍵的轉換。

**欄位**
+ `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 儲存貯體的轉換。

**欄位**
+ `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>

使用指定資料屬性索引鍵上的比較片語，將兩個資料集聯結為一個資料集。可以使用內、外、左、右、左半、左反聯結。

**欄位**
+ `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>

指定要聯結的資料行。

**欄位**
+ `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` 的集合：一個具有所選資料屬性索引鍵，另一個具有其餘資料屬性索引鍵。

**欄位**
+ `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`。

**欄位**
+ `Name` – *必要：*UTF-8 字串，需符合[Custom string pattern #63](aws-glue-api-common.md#regex_63)。

  轉換節點的名稱。
+ `Inputs` – *必要：*UTF-8 字串的陣列，不可小於 1 或超過 1 個字串。

  由其節點名稱識別的資料輸入。
+ `Index` – *必要：*數字 (整數)，不可大於 None (無)。

  要選取的 DynamicFrame 的索引。

## FillMissingValues 結構
<a name="aws-glue-api-visual-job-api-FillMissingValues"></a>

指定如下轉換：尋找遺失值之資料集中的記錄，並新增具有由插補決定值的新欄位。輸入資料集會用於訓練機器學習模型，以決定遺失值應該是什麼。

**欄位**
+ `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>

指定根據篩選條件將資料集分割成兩個的轉換。

**欄位**
+ `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>

指定篩選條件表達式。

**欄位**
+ `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` 的值清單中的單一項目。

**欄位**
+ `Type` – *必要：*UTF-8 字串 (有效值：`COLUMNEXTRACTED` \$1 `CONSTANT`)。

  篩選條件值的類型。
+ `Value` – *必要：*UTF-8 字串陣列。

  要關聯的值。

## CustomCode 結構
<a name="aws-glue-api-visual-job-api-CustomCode"></a>

指定使用您提供的自訂程式碼來執行資料轉換的轉換。輸出是 DynamicFrames 的集合。

**欄位**
+ `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`。

**欄位**
+ `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` 的值清單中的單一項目。

**欄位**
+ `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。

**欄位**
+ `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) 物件。

  表示某些值是否被識別為空值以進行移除的結構。
+ `NullTextList` – [NullValueField](#aws-glue-api-visual-job-api-NullValueField) 物件陣列，不可超過 50 個結構。

  指定 NullValueField 結構清單的結構，該結構代表自訂的空值，例如零或作為資料集唯一的空預留位置使用的其他值。

  此 `DropNullFields` 轉換只會在空預留位置和資料類型的值都符合資料時才移除自訂的空值。

## NullCheckBoxList 結構
<a name="aws-glue-api-visual-job-api-NullCheckBoxList"></a>

表示某些值是否被識別為空值以進行移除。

**欄位**
+ `IsEmpty` – 布林值。

  指定一個空字串被視為空值。
+ `IsNullString` – 布林值。

  指定拼寫為單字 null 的值被視為空值。
+ `IsNegOne` – 布林值。

  指定 -1 的整數值被視為空值。

## NullValueField 結構
<a name="aws-glue-api-visual-job-api-NullValueField"></a>

代表自訂的空值，例如零或用作資料集唯一的空預留位置的其他值。

**欄位**
+ `Value` – *必要：*UTF-8 字串，需符合[Custom string pattern #61](aws-glue-api-common.md#regex_61)。

  空預留位置的值。
+ `Datatype` – *必要：*[Datatype](#aws-glue-api-visual-job-api-Datatype) 物件。

  值的資料類型。

## Datatype 結構
<a name="aws-glue-api-visual-job-api-Datatype"></a>

代表該值的資料類型的結構。

**欄位**
+ `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)。

  指派給資料類型的標籤。

## Merge 結構
<a name="aws-glue-api-visual-job-api-Merge"></a>

指定根據指定的主索引鍵來合併此 `DynamicFrame` 與暫存 `DynamicFrame` 以識別記錄的轉換。重複的記錄 (具有相同主索引鍵的記錄) 不會被刪除重複資料。

**欄位**
+ `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>

指定將兩個或多個資料集中的列合併為單一結果的轉換。

**欄位**
+ `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 資料的轉換。

**欄位**
+ `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` – 數字 (整數)，不可大於 None (無)。

  在偵測到的 PII 內容左側從修訂中排除的字元數。這允許保留敏感資料的相關內容。
+ `NumRightCharsToExclude` – 數字 (整數)，不可大於 None (無)。

  在偵測到的 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>

指定轉換，依照所選欄位來分組行，並依照指定函數計算彙總值。

**欄位**
+ `Name` – *必要：*UTF-8 字串，需符合[Custom string pattern #63](aws-glue-api-common.md#regex_63)。

  轉換節點的名稱。
+ `Inputs` – *必要：*UTF-8 字串的陣列，不可小於 1 或超過 1 個字串。

  指定欄位和行作為彙總轉換輸入。
+ `Groups` – *必要：*UTF-8 字串陣列。

  指定分組所依據的欄位。
+ `Aggs` – *必要：*[AggregateOperation](#aws-glue-api-visual-job-api-AggregateOperation) 物件陣列，不小於 1 個結構，也不大於 30 個結構。

  指定要在指定欄位執行的彙總函數。

## DropDuplicates 結構
<a name="aws-glue-api-visual-job-api-DropDuplicates"></a>

指定用於從資料集刪除重複資料行的轉換。

**欄位**
+ `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>

指定使用 Data Catalog 寫入 Amazon S3 AWS Glue 的資料目標。

**欄位**
+ `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>

指定受管 Data Catalog 中的 AWS Glue 資料存放區。

**欄位**
+ `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) 物件。

  指定其他連接選項。

## AggregateOperation 結構
<a name="aws-glue-api-visual-job-api-AggregateOperation"></a>

指定執行彙總轉換中彙總所需的參數集。

**欄位**
+ `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 countDistinct、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決定架構時，指定使用者定義的架構。

**欄位**
+ `Columns` – 一個 [GlueStudioSchemaColumn](#aws-glue-api-visual-job-api-GlueStudioSchemaColumn) 物件陣列。

  指定組成 AWS Glue 結構描述的資料欄定義。

## GlueStudioSchemaColumn 結構
<a name="aws-glue-api-visual-job-api-GlueStudioSchemaColumn"></a>

指定 AWS Glue 結構描述定義中的單一資料欄。

**欄位**
+ `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)。

  Studio 中定義的資料欄資料類型 AWS Glue 。

## GlueStudioColumn 結構
<a name="aws-glue-api-visual-job-api-GlueStudioColumn"></a>

指定 AWS Glue Studio 中的單一資料欄。

**欄位**
+ `Key` – *必要：*UTF-8 字串，需符合[Custom string pattern #61](aws-glue-api-common.md#regex_61)。

   AWS Glue Studio 中資料欄的索引鍵。
+ `FullPath` – *必要：*UTF-8 字串陣列。

  TThe中資料欄的完整 URL。 AWS Glue 
+ `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"`)。

  TThe中資料欄的類型。 AWS Glue 
+ `Children` – 結構的陣列。

  TThe中父欄的子項。 AWS Glue 
+ `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"`)。

  Studio 中定義的資料欄資料類型 AWS Glue 。

## DynamicTransform 結構
<a name="aws-glue-api-visual-job-api-DynamicTransform"></a>

指定執行動態轉換所需的參數集。

**欄位**
+ `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>

指定動態轉換組態檔案的參數。

**欄位**
+ `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>

指定資料品質評估標準。

**欄位**
+ `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>

設定資料品質評估結果發佈方式的選項。

**欄位**
+ `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>

設定資料品質評估失敗時如何停止任務的選項。

**欄位**
+ `StopJobOnFailureTiming` – UTF-8 字串 (有效值：`Immediate` \$1 `AfterDataLoad`)。

  資料品質評估失敗時停止任務的時機。選項包括 Immediate (立即) 或 AfterDataLoad (載入資料後)。

## EvaluateDataQualityMultiFrame 結構
<a name="aws-glue-api-visual-job-api-EvaluateDataQualityMultiFrame"></a>

指定資料品質評估標準。

**欄位**
+ `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 節點。

**欄位**
+ `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 配方的參考。

**欄位**
+ `RecipeArn` – *必要：*UTF-8 字串，需符合[Custom string pattern #61](aws-glue-api-common.md#regex_61)。

   DataBrew 配方的 ARN。
+ `RecipeVersion` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 16 個位元組。

   DataBrew 配方的 RecipeVersion。

## SnowflakeNodeData 結構
<a name="aws-glue-api-visual-job-api-SnowflakeNodeData"></a>

指定 AWS Glue Studio 中 Snowflake 節點的組態。

**欄位**
+ `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 的資料型錄連線。
+ `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 字串。

  SQL 字串，用於擷取具有 `query` sourcetype 的資料。
+ `PreAction` – UTF-8 字串。

  SQL 字串會在 Snowflake 連接器執行其標準動作之前執行。
+ `PostAction` – UTF-8 字串。

  SQL 字串會在 Snowflake 連接器執行其標準動作之後執行。
+ `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` 或 upsert `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 資料來源。

**欄位**
+ `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 目標。

**欄位**
+ `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>

指定使用標準連線選項產生的來源。

**欄位**
+ `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)。

  `connectionType`提供給基礎 AWS Glue 程式庫的 。此節點類型支援下列連線類型：
  + `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) 物件陣列。

  指定此來源的資料結構描述。

## ConnectorDataTarget 結構
<a name="aws-glue-api-visual-job-api-ConnectorDataTarget"></a>

指定使用標準連線選項產生的目標。

**欄位**
+ `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)。

  `connectionType`提供給基礎 AWS Glue 程式庫的 。此節點類型支援下列連線類型：
  + `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 資料準備配方節點中使用的配方步驟。

**欄位**
+ `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 資料準備配方節點中定義的動作。

**欄位**
+ `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 個位元組，也不可以超過 32,768 個位元組。

  配方動作的參數。

## ConditionExpression 結構
<a name="aws-glue-api-visual-job-api-ConditionExpression"></a>

 AWS Glue Studio 資料準備配方節點中定義的條件表達式。

**欄位**
+ `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。

**欄位**
+ `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 資料來源。

**欄位**
+ `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 中註冊資料表。

**欄位**
+ `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 連接器來源。

**欄位**
+ `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 資料表連接和擷取資料。

**欄位**
+ `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 Resource Name (ARN)。此參數指定 ELT 操作的來源資料表。
+ `DynamodbS3Bucket` – UTF-8 字串，需符合[Custom string pattern #61](aws-glue-api-common.md#regex_61)。

  在 DynamoDB ELT 程序期間用於中繼儲存的 Amazon S3 儲存貯體名稱。此儲存貯體用於暫時儲存匯出的 DynamoDB 資料，然後再由 ELT 任務處理。
+ `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)。

  中指定之 S3 儲存貯體擁有者 AWS 的帳戶 ID`DynamodbS3Bucket`。當 S3 儲存貯體擁有的帳戶與執行 ELT 任務 AWS 的帳戶不同時，需要此參數，以便跨帳戶存取中繼儲存貯體。
+ `DynamodbStsRoleArn` – UTF-8 字串，需符合[Custom string pattern #61](aws-glue-api-common.md#regex_61)。

  在 ELT 操作期間存取 DynamoDB 和 S3 資源時，要擔任之 AWS 安全字符服務 (STS) 角色的 Amazon Resource Name (ARN)。此角色必須具有從 DynamoDB 資料表讀取和寫入中繼 S3 儲存貯體的必要許可。

## DDBELTCatalogAdditionalOptions 結構
<a name="aws-glue-api-visual-job-api-DDBELTCatalogAdditionalOptions"></a>

指定 DynamoDB ELT 目錄操作的其他選項。

**欄位**
+ `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>

指定路由節點，根據定義的篩選條件將資料導向不同的輸出路徑。

**欄位**
+ `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>

指定具有邏輯運算子的篩選條件群組，該邏輯運算子決定如何組合篩選條件來評估路由條件。

**欄位**
+ `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 操作期間啟用自動化資料品質檢查和監控，有助於確保資料完整性和可靠性，而無需手動介入。

**欄位**
+ `IsEnabled` – 布林值。

  指定是否啟用自動資料品質評估。設為 `true` 時，會自動執行資料品質檢查。
+ `EvaluationContext` – UTF-8 字串，需符合[Custom string pattern #61](aws-glue-api-common.md#regex_61)。

  自動資料品質檢查的評估內容。這會定義資料品質評估的範圍和參數。

# 任務 API
<a name="aws-glue-api-jobs"></a>

Jobs API 說明任務資料類型，並包含用於在其中使用任務、任務執行和觸發程序APIs AWS Glue。

**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 說明與建立、更新、刪除或檢視任務相關的資料類型和 API AWS Glue。

## 資料類型
<a name="aws-glue-api-jobs-job-objects"></a>
+ [Job 結構](#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)

## Job 結構
<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` 欄位遺失或為 null 時， `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)。
+ `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` – 數字 (整數)。

  如果 JobRun 失敗，此任務可重試的次數上限。
+ `AllocatedCapacity` – 數字 (整數)。

  此欄位已作廢。請改用 `MaxCapacity`。

  分配給此任務執行的 AWS Glue 資料處理單位 (DPUs) 數量。您可以分配至少 2 個 DPU，預設值為 10。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [AWS Glue 定價頁面](https://aws.amazon.com/glue/pricing/)。

  
+ `Timeout` – 數字 (整數)，至少為 1。

  任務逾時 (以分鐘為單位)。此為任務執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。

  任務的逾時值必須少於 7 天或 10,080 分鐘。否則，任務會擲回例外狀況。

  在值保留空白時，逾時預設為 2,880 分鐘。

  逾時值大於 7 天的任何現有 AWS Glue 任務將預設為 7 天。例如，如果您為批次任務指定了 20 天的逾時，則會在第 7 天停止。

  對於串流任務，如果您已設定維護時段，則會在 7 天後的維護時段期間重新啟動任務。
+ `MaxCapacity` – 數字 (雙位數)。

  對於 Glue 1.0 版或更早版本的任務，使用標準工作者類型，此任務執行時可配置的 AWS Glue 資料處理單位 (DPUs) 數量。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [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 Streaming ETL 任務：
  + 當您指定 Python shell 任務 (`JobCommand.Name`="pythonshell") 時，您可以擇一分配 0.0625 或 1 個 DPU。預設為 0.0625 個 DPU。
  + 指定 Apache Spark ETL 任務 (`JobCommand.Name`="glueetl") 或 Apache Spark Streaming 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=""` `G.8X=""` \$1 `G.12X=""` \$1 \$1 `G.16X=""` `R.1X=""` \$1 `R.2X=""` \$1 `R.4X=""` \$1 `R.8X=""` \$1 \$1 `Z.2X=""`)。

  將在任務執行時分配的預先定義工作者類型。

  AWS Glue 提供多種工作者類型，以因應不同的工作負載需求：

  G 工作者類型 (一般用途運算工作者)：
  + G.025X：0.25 DPU (2 個 vCPUs、4 GB 記憶體、84GB 磁碟）
  + 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 記憶體、1,024 GB 磁碟)

  R 工作者類型 (記憶體最佳化工作者)：
  + R.1X：1 個 DPU (4 vCPUs、32 GB 記憶體、94GB 磁碟）
  + R.2X：2 個 DPU (8 vCPUs、64 GB 記憶體、128GB 磁碟）
  + R.4X：4 個 DPU (16 個 vCPUs、128 GB 記憶體、256GB 磁碟）
  + R.8X：8 個 DPU (32 個 vCPUs、256 GB 記憶體、512GB 磁碟）
+ `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=""`)。

  表示任務執行使用的是標準執行類別還是彈性執行類別。標準執行類別非常適合需要快速任務啟動和專用資源的時間敏感型工作負載。

  彈性執行類別適用於開始和完成時間可能會有所變化的時間敏感型任務。

  只有版本 3.0 和更高 AWS Glue 版本以及命令類型的任務`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 Streaming 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` 欄位遺失或為 null 時， `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 資料處理單位 (DPUs) 數目。您可以分配至少 2 個 DPU，預設值為 10。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [AWS Glue 定價頁面](https://aws.amazon.com/glue/pricing/)。
+ `Timeout` – 數字 (整數)，至少為 1。

  任務逾時 (以分鐘為單位)。此為任務執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。

  任務的逾時值必須少於 7 天或 10,080 分鐘。否則，任務會擲回例外狀況。

  在值保留空白時，逾時預設為 2,880 分鐘。

  逾時值大於 7 天的任何現有 AWS Glue 任務將預設為 7 天。例如，如果您為批次任務指定了 20 天的逾時，則會在第 7 天停止。

  對於串流任務，如果您已設定維護時段，則會在 7 天後的維護時段期間重新啟動任務。
+ `MaxCapacity` – 數字 (雙位數)。

  對於 Glue 1.0 版或更早版本的任務，使用標準工作者類型，此任務執行時可配置的 AWS Glue 資料處理單位 (DPUs) 數量。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [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 Streaming ETL 任務：
  + 當您指定 Python shell 任務 (`JobCommand.Name`="pythonshell") 時，您可以擇一分配 0.0625 或 1 個 DPU。預設為 0.0625 個 DPU。
  + 指定 Apache Spark ETL 任務 (`JobCommand.Name`="glueetl") 或 Apache Spark Streaming ETL 任務 (`JobCommand.Name`="gluestreaming") 時，您可以配置 2 到 100 個 DPU。預設值是 10 個 DPU。此任務類型沒有小數的 DPU 分配。
+ `WorkerType` – UTF-8 字串 （有效值： `Standard=""` \$1 `G.025X=""` \$1 `G.1X=""` \$1 `G.2X=""` `G.4X=""` \$1 `G.8X=""` \$1 `G.12X=""` \$1 \$1 `G.16X=""` \$1 `R.1X=""` `R.2X=""` \$1 `R.4X=""` \$1 `R.8X=""` \$1 \$1 `Z.2X=""`)。

  將在任務執行時分配的預先定義工作者類型。對於 Spark 任務，接受 G.025X、G.1X、G.2X、G.4X、G.8X、G.12X、G.16X、R.1X、R.2X、R.4X 或 R.8X 的值。接受 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=""`)。

  表示任務執行使用的是標準執行類別還是彈性執行類別。標準執行類別非常適合需要快速的任務啟動和專用資源的時間敏感型工作負載。

  彈性執行類別適用於開始和完成時間可能會有所變化的時間敏感型任務。

  只有版本 3.0 和更高 AWS Glue 版本以及命令類型的任務`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` 欄位遺失或為 null 時， `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 資料處理單位 (DPUs) 數目。您可以分配至少 2 個 DPU，預設值為 10。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [AWS Glue 定價頁面](https://aws.amazon.com/glue/pricing/)。
+ `Timeout` – 數字 (整數)，至少為 1。

  任務逾時 (以分鐘為單位)。此為任務執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。

  任務的逾時值必須少於 7 天或 10,080 分鐘。否則，任務會擲回例外狀況。

  在值保留空白時，逾時預設為 2,880 分鐘。

  逾時值大於 7 天的任何現有 AWS Glue 任務將預設為 7 天。例如，如果您為批次任務指定了 20 天的逾時，則會在第 7 天停止。

  對於串流任務，如果您已設定維護時段，則會在 7 天後的維護時段期間重新啟動任務。
+ `MaxCapacity` – 數字 (雙位數)。

  對於 Glue 1.0 版或更早版本的任務，使用標準工作者類型，此任務執行時可配置的 AWS Glue 資料處理單位 (DPUs) 數量。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [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 Streaming ETL 任務：
  + 當您指定 Python shell 任務 (`JobCommand.Name`="pythonshell") 時，您可以擇一分配 0.0625 或 1 個 DPU。預設為 0.0625 個 DPU。
  + 指定 Apache Spark ETL 任務 (`JobCommand.Name`="glueetl") 或 Apache Spark Streaming 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 中的 中的標籤 AWS Glue](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=""` `G.4X=""` \$1 `G.8X=""` \$1 `G.12X=""` \$1 \$1 `G.16X=""` \$1 `R.1X=""` `R.2X=""` \$1 `R.4X=""` \$1 `R.8X=""` \$1 \$1 `Z.2X=""`)。

  將在任務執行時分配的預先定義工作者類型。對於 Spark 任務，接受 G.025X、G.1X、G.2X、G.4X、G.8X、G.12X、G.16X、R.1X、R.2X、R.4X 或 R.8X 的值。接受 Ray 任務的 Z.2X 值。
  + 用於 `G.025X` 工作者類型時，每個工作者會映射到 0.25 個 DPU (2 個 vCPU、4 GB 的記憶體)，外加 84 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議低容量串流任務採用這種工作者類型。此工作者類型僅適用於 3.0 AWS Glue 版或更新版本的串流任務。
  + 用於 `G.1X` 工作者類型時，每個工作者會映射到 1 個 DPU (4 個 vCPU、16 GB 的記憶體)，外加 94 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議將此工作者類型用於資料轉換、聯結和查詢等工作負載，以提供可擴展且符合成本效益的方式來執行大部分任務。
  + 用於 `G.2X` 工作者類型時，每個工作者會映射到 2 個 DPU (8 個 vCPU、32 GB 的記憶體)，外加 138 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議將此工作者類型用於資料轉換、聯結和查詢等工作負載，以提供可擴展且符合成本效益的方式來執行大部分任務。
  + 用於 `G.4X` 工作者類型時，每個工作者會映射到 4 個 DPU (16 個 vCPU、64 GB 的記憶體)，外加 256 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議工作負載包含最嚴苛轉換、彙總、聯結和查詢的任務採用這種工作者類型。此工作者類型僅適用於下列 AWS 區域中的 3.0 AWS Glue 版或更新版本 Spark ETL 任務：美國東部 （俄亥俄）、美國東部 （維吉尼亞北部）、美國西部 （加利佛尼亞北部）、美國西部 （奧勒岡）、亞太區域 （孟買）、亞太區域 （首爾）、亞太區域 （新加坡）、亞太區域 （雪梨）、亞太區域 （東京）、加拿大 （中部）、歐洲 （法蘭克福）、歐洲 （愛爾蘭）、歐洲 （倫敦）、歐洲 （西班牙）、歐洲 （斯德哥爾摩） 和 
  + 用於 `G.8X` 工作者類型時，每個工作者會映射到 8 個 DPU (32 個 vCPU、128 GB 的記憶體)，外加 512 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議工作負載包含最嚴苛轉換、彙總、聯結和查詢的任務採用這種工作者類型。此工作者類型僅適用於 3.0 AWS Glue 版或更新版本的 Spark ETL 任務，適用於與`G.4X`工作者類型支援的相同 AWS 區域。
  + 對於`G.12X`工作者類型，每個工作者會映射到具有 768GB 個 vCPUs、192 GB 記憶體），並為每個工作者提供 1 個執行器。對於工作負載非常大的任務，我們建議使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`G.16X`工作者類型，每個工作者對應到具有 1024 GB 磁碟的 1024GB6 個 DPU (64 個 vCPUs、256 GB 記憶體），並為每個工作者提供 1 個執行器。對於工作負載非常大的任務，我們建議使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.1X`工作者類型，每個工作者會映射到具有 94GB磁碟的 1 個 DPU (4 個 vCPUs，32 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.2X`工作者類型，每個工作者對應到具有 128GB磁碟的 2 個 DPU (8 個 vCPUs、64 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.4X`工作者類型，每個工作者會映射到具有 256GB磁碟的 4 個 DPU (16 個 vCPUs、128 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.8X`工作者類型，每個工作者對應到具有 512GB磁碟的 8 個 DPU (32 個 vCPUs、256 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於 `Z.2X` 工作者類型，每個工作者都會映射到 2 個 M-DPU (8 個 vCPU、64 GB 記憶體)，外加 128 GB 磁碟，並根據自動縮放器提供最多 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=""`)。

  表示任務執行使用的是標準執行類別還是彈性執行類別。標準執行類別非常適合需要快速的任務啟動和專用資源的時間敏感型工作負載。

  彈性執行類別適用於開始和完成時間可能會有所變化的時間敏感型任務。

  只有版本 3.0 和更高 AWS Glue 版本以及命令類型的任務`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>

 Jobs Runs API 說明啟動、停止或檢視任務執行，以及重設任務書籤的相關資料類型和 API AWS Glue。您可以存取工作流程和任務執行的 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` 欄位遺失或為 null 時， `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` – 一個 [前置任務](#aws-glue-api-jobs-runs-Predecessor) 物件陣列。

  此次任務執行的前置任務的清單。
+ `AllocatedCapacity` – 數字 (整數)。

  此欄位已作廢。請改用 `MaxCapacity`。

  分配給此 JobRun 的 AWS Glue 資料處理單位 (DPU) 數量。 DPUs 可分配 2 到 100 DPU，預設值為 10。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [AWS Glue 定價頁面](https://aws.amazon.com/glue/pricing/)。
+ `ExecutionTime` – 數字 (整數)。

  任務執行消耗資源所需的時間 (以秒為單位)。
+ `Timeout` – 數字 (整數)，至少為 1。

  `JobRun` 逾時 (以分鐘為單位)。此為任務執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。此值會覆寫父任務所設的逾時值。

  任務的逾時值必須少於 7 天或 10,080 分鐘。否則，任務會擲回例外狀況。

  在值保留空白時，逾時預設為 2,880 分鐘。

  逾時值大於 7 天的任何現有 AWS Glue 任務將預設為 7 天。例如，如果您為批次任務指定了 20 天的逾時，則會在第 7 天停止。

  對於串流任務，如果您已設定維護時段，則會在 7 天後的維護時段期間重新啟動任務。
+ `MaxCapacity` – 數字 (雙位數)。

  對於 Glue 1.0 版或更早版本任務，使用標準工作者類型，此任務執行時可配置的 AWS Glue 資料處理單位 (DPUs) 數量。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [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 Streaming ETL 任務：
  + 當您指定 Python shell 任務 (`JobCommand.Name`="pythonshell") 時，您可以擇一分配 0.0625 或 1 個 DPU。預設為 0.0625 個 DPU。
  + 指定 Apache Spark ETL 任務 (`JobCommand.Name`="glueetl") 或 Apache Spark Streaming 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=""` `G.8X=""` \$1 `G.12X=""` \$1 \$1 `G.16X=""` \$1 `R.1X=""` `R.2X=""` \$1 `R.4X=""` \$1 `R.8X=""` \$1 \$1 `Z.2X=""`)。

  將在任務執行時分配的預先定義工作者類型。對於 Spark 任務，接受 G.025X、G.1X、G.2X、G.4X、G.8X、G.12X、G.16X、R.1X、R.2X、R.4X 或 R.8X 的值。接受 Ray 任務的 Z.2X 值。
  + 用於 `G.1X` 工作者類型時，每個工作者會映射到 1 個 DPU (4 個 vCPU、16 GB 的記憶體)，外加 94 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議將此工作者類型用於資料轉換、聯結和查詢等工作負載，以提供可擴展且符合成本效益的方式來執行大部分任務。
  + 用於 `G.2X` 工作者類型時，每個工作者會映射到 2 個 DPU (8 個 vCPU、32 GB 的記憶體)，外加 138 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議將此工作者類型用於資料轉換、聯結和查詢等工作負載，以提供可擴展且符合成本效益的方式來執行大部分任務。
  + 用於 `G.4X` 工作者類型時，每個工作者會映射到 4 個 DPU (16 個 vCPU、64 GB 的記憶體)，外加 256 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議工作負載包含最嚴苛轉換、彙總、聯結和查詢的任務採用這種工作者類型。此工作者類型僅適用於下列 AWS 區域中的 3.0 AWS Glue 版或更新版本 Spark ETL 任務：美國東部 （俄亥俄）、美國東部 （維吉尼亞北部）、美國西部 （奧勒岡）、亞太區域 （新加坡）、亞太區域 （雪梨）、亞太區域 （東京）、加拿大 （中部）、歐洲 （法蘭克福）、歐洲 （愛爾蘭） 和歐洲 （斯德哥爾摩）。
  + 用於 `G.8X` 工作者類型時，每個工作者會映射到 8 個 DPU (32 個 vCPU、128 GB 的記憶體)，外加 512 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議工作負載包含最嚴苛轉換、彙總、聯結和查詢的任務採用這種工作者類型。此工作者類型僅適用於 3.0 AWS Glue 版或更新版本的 Spark ETL 任務，其位於與`G.4X`工作者類型支援的相同 AWS 區域中。
  + 對於`G.12X`工作者類型，每個工作者會映射到具有 768GB 個 vCPUs、192 GB 記憶體），並為每個工作者提供 1 個執行器。對於工作負載非常大的任務，我們建議使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`G.16X`工作者類型，每個工作者對應到具有 1024 GB 磁碟的 1024GB6 個 DPU (64 個 vCPUs、256 GB 記憶體），並為每個工作者提供 1 個執行器。對於工作負載非常大的任務，我們建議使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 用於 `G.025X` 工作者類型時，每個工作者會映射到 0.25 個 DPU (2 個 vCPU、4 GB 的記憶體)，外加 84 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議低容量串流任務採用這種工作者類型。此工作者類型僅適用於 3.0 AWS Glue 版或更新版本的串流任務。
  + 對於`R.1X`工作者類型，每個工作者對應到具有 94GB磁碟的 1 個 DPU (4 個 vCPUs，32 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.2X`工作者類型，每個工作者對應到具有 128GB磁碟的 2 個 DPU (8 個 vCPUs、64 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.4X`工作者類型，每個工作者會映射到具有 256GB磁碟的 4 個 DPU (16 個 vCPUs、128 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.8X`工作者類型，每個工作者會映射到具有 512GB 個 vCPUs、256 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 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 字串。

  用於確保記錄安全的名稱，可以使用 AWS KMS在 Amazon CloudWatch 中進行伺服器端加密。此名稱可為 `/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` – 數字 (雙位數)。

  此欄位可以針對具有執行類別 `FLEX` 的任務執行設定或在啟用 Auto Scaling 時設定，表示每個執行器在任務執行生命週期內執行的總時間 (以秒為單位) 乘以 DPU 因子 (`G.2X` 為 1、`G.1X` 為 2、`G.025X` 工作者為 0.25)。此值可能不同於 Auto Scaling 任務案例中的 `executionEngineRuntime` \$1 `MaxCapacity`，因為在給定時間執行的執行程序數量可能少於 `MaxCapacity`。因此，`DPUSeconds` 的值有可能小於 `executionEngineRuntime` \$1 `MaxCapacity`。
+ `ExecutionClass` – UTF-8 字串，長度不可超過 16 個位元組 (有效值：`FLEX=""` \$1 `STANDARD=""`)。

  表示任務執行使用的是標準執行類別還是彈性執行類別。標準執行類別非常適合需要快速的任務啟動和專用資源的時間敏感型工作負載。

  彈性執行類別適用於開始和完成時間可能會有所變化的時間敏感型任務。

  只有 3.0 版及更高 AWS Glue 版本以及命令類型的任務`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 個位元組。

  此欄位會保留與任務執行狀態相關的詳細資訊。欄位可以為 null。

  例如，當任務執行因任務執行佇列而處於 WAITING 狀態時， 欄位具有任務執行處於該狀態的原因。
+ `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) 主題。

  如需有關設定 Ray 任務時可提供給此欄位之引數的資訊，請參閱開發人員指南中的 [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) 數量。 DPUs 您可以分配至少 2 個 DPU，預設值為 10。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [AWS Glue 定價頁面](https://aws.amazon.com/glue/pricing/)。
+ `Timeout` – 數字 (整數)，至少為 1。

  `JobRun` 逾時 (以分鐘為單位)。此為任務執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。此值會覆寫父任務所設的逾時值。

  任務的逾時值必須少於 7 天或 10,080 分鐘。否則，任務會擲回例外狀況。

  在值保留空白時，逾時預設為 2,880 分鐘。

  逾時值大於 7 天的任何現有 AWS Glue 任務將預設為 7 天。例如，如果您為批次任務指定了 20 天的逾時，則會在第 7 天停止。

  對於串流任務，如果您已設定維護時段，則會在 7 天後的維護時段期間重新啟動任務。
+ `MaxCapacity` – 數字 (雙位數)。

  對於 Glue 1.0 版或更早版本任務，使用標準工作者類型，此任務執行時可配置的 AWS Glue 資料處理單位 (DPUs) 數量。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [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 Streaming ETL 任務：
  + 當您指定 Python shell 任務 (`JobCommand.Name`="pythonshell") 時，您可以擇一分配 0.0625 或 1 個 DPU。預設為 0.0625 個 DPU。
  + 指定 Apache Spark ETL 任務 (`JobCommand.Name`="glueetl") 或 Apache Spark Streaming 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=""`)。

  將在任務執行時分配的預先定義工作者類型。接受 Spark 任務的 G.1X、G.2X、G.4X、G.8X 或 G.025X 值。接受 Ray 任務的 Z.2X 值。
  + 用於 `G.1X` 工作者類型時，每個工作者會映射到 1 個 DPU (4 個 vCPU、16 GB 的記憶體)，外加 94 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議將此工作者類型用於資料轉換、聯結和查詢等工作負載，以提供可擴展且符合成本效益的方式來執行大部分任務。
  + 用於 `G.2X` 工作者類型時，每個工作者會映射到 2 個 DPU (8 個 vCPU、32 GB 的記憶體)，外加 138 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議將此工作者類型用於資料轉換、聯結和查詢等工作負載，以提供可擴展且符合成本效益的方式來執行大部分任務。
  + 用於 `G.4X` 工作者類型時，每個工作者會映射到 4 個 DPU (16 個 vCPU、64 GB 的記憶體)，外加 256 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議工作負載包含最嚴苛轉換、彙總、聯結和查詢的任務採用這種工作者類型。此工作者類型僅適用於下列 AWS 區域中的 3.0 AWS Glue 版或更新版本 Spark ETL 任務：美國東部 （俄亥俄）、美國東部 （維吉尼亞北部）、美國西部 （奧勒岡）、亞太區域 （新加坡）、亞太區域 （雪梨）、亞太區域 （東京）、加拿大 （中部）、歐洲 （法蘭克福）、歐洲 （愛爾蘭） 和歐洲 （斯德哥爾摩）。
  + 用於 `G.8X` 工作者類型時，每個工作者會映射到 8 個 DPU (32 個 vCPU、128 GB 的記憶體)，外加 512 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議工作負載包含最嚴苛轉換、彙總、聯結和查詢的任務採用這種工作者類型。此工作者類型僅適用於 3.0 AWS Glue 版或更新版本的 Spark ETL 任務，其位於與`G.4X`工作者類型支援的相同 AWS 區域中。
  + 對於`G.12X`工作者類型，每個工作者會映射到具有 768GB 個 vCPUs、192 GB 記憶體），並為每個工作者提供 1 個執行器。對於工作負載非常大的任務，我們建議使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`G.16X`工作者類型，每個工作者對應到具有 1024 GB 磁碟的 1024GB6 個 DPU (64 個 vCPUs、256 GB 記憶體），並為每個工作者提供 1 個執行器。對於工作負載非常大的任務，我們建議使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 用於 `G.025X` 工作者類型時，每個工作者會映射到 0.25 個 DPU (2 個 vCPU、4 GB 的記憶體)，外加 84 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議低容量串流任務採用這種工作者類型。此工作者類型僅適用於 3.0 AWS Glue 版或更新版本的串流任務。
  + 對於`R.1X`工作者類型，每個工作者對應到具有 94GB磁碟的 1 個 DPU (4 個 vCPUs，32 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.2X`工作者類型，每個工作者對應到具有 128GB磁碟的 2 個 DPU (8 個 vCPUs、64 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.4X`工作者類型，每個工作者會映射到具有 256GB磁碟的 4 個 DPU (16 個 vCPUs、128 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於`R.8X`工作者類型，每個工作者會映射到具有 512GB 個 vCPUs、256 GB 記憶體），並為每個工作者提供 1 個執行器。我們建議針對記憶體密集型工作負載使用此工作者類型。此工作者類型僅適用於 4.0 AWS Glue 版或更新版本的 Spark ETL 任務。
  + 對於 `Z.2X` 工作者類型，每個工作者都會映射到 2 個 M-DPU (8 個 vCPU、64 GB 記憶體)，外加 128 GB 磁碟，並根據自動縮放器提供最多 8 個 Ray 工作者。
+ `NumberOfWorkers` – 數字 (整數)。

  當任務執行時所配置的已定義 `workerType` 的工作者數目。
+ `ExecutionClass` – UTF-8 字串，長度不可超過 16 個位元組 (有效值：`FLEX=""` \$1 `STANDARD=""`)。

  表示任務執行使用的是標準執行類別還是彈性執行類別。標準執行類別非常適合需要快速的任務啟動和專用資源的時間敏感型工作負載。

  彈性執行類別適用於開始和完成時間可能會有所變化的時間敏感型任務。

  只有 3.0 版及更高 AWS Glue 版本以及命令類型的任務`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>

Triggers API 說明與建立、更新或刪除，以及啟動和停止任務觸發程序相關的資料類型和 API AWS Glue。

## 資料類型
<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` – 一個 [Action](#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` – 一個 [Action](#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 天或 10,080 分鐘。否則，任務會擲回例外狀況。

  在值保留空白時，逾時預設為 2,880 分鐘。

  逾時值大於 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` – *必要：*一個 [Action](#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` 觸發。True 不支援 `ON_DEMAND` 觸發。
+ `Tags` – 金鑰值對的對應陣列，不超過 50 對。

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

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

  要搭配此觸發條件使用的標籤。您可以使用標籤來限制對於觸發條件的存取情況。如需 中標籤的詳細資訊 AWS Glue，請參閱《 開發人員指南》中的 [AWS 中的標籤 AWS Glue](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`

# 中的整合 APIs AWS Glue
<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 Resource Name (ARN)。
+ `KmsKeyId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  用於加密頻道的 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 個位元組，也不可以超過 2,048 個位元組。

  使用 Maxwell 篩選條件語法選取整合的來源資料表。

## IntegrationConfig 結構
<a name="aws-glue-api-integrations-IntegrationConfig"></a>

與整合關聯的屬性。

**欄位**
+ `RefreshInterval` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。

  指定 CDC (變更資料擷取) 提取或增量載入應發生的頻率。此參數提供彈性，可讓重新整理速率與您的特定資料更新模式、系統負載考量和效能最佳化目標保持一致。時間增量可以設定為 15 分鐘至 8,640 分鐘 (6 天)。
+ `SourceProperties` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串。

  每個值都是 UTF-8 字串。

   金鑰值對的集合，可指定整合來源的其他屬性。這些屬性提供組態選項，可用於在資料整合操作期間自訂 ODB 來源的行為。
+ `ContinuousSync` – 布林值。

  啟用隨需資料擷取的持續同步：1) SaaS 應用程式到 Amazon Redshift 和 等 AWS 資料服務 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-01-15)
  + `hour` - 從時間戳記值中擷取小時 (例如 2023-01-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 個位元組，也不可以超過 2,048 個位元組。

  描述錯誤的訊息。

## 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 個位元組，也不可以超過 2,048 個位元組。

  用於加密的 KMS 金鑰的 ARN。
+ `ConnectionName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。

  用於設定在客戶 VPC 中執行之 AWS Glue 任務的 AWS Glue 網路連線。
+ `EventBusArn` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  接收整合狀態通知的 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 Resource Name (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 個位元組，也不可以超過 2,048 個位元組。

  使用 Maxwell 篩選條件語法選取整合的來源資料表。
+ `KmsKeyId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  用於加密頻道的 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 Resource Name (ARN)。
+ `KmsKeyId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  用於加密頻道的 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 個位元組，也不可以超過 2,048 個位元組。

  使用 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 Resource Name (ARN)。
+ `Description` – UTF-8 字串，長度不可超過 1000 個位元組，需符合 [Custom string pattern #12](aws-glue-api-common.md#regex_12)。

  整合的描述。
+ `DataFilter` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  使用 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 Resource Name (ARN)。
+ `KmsKeyId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  用於加密頻道的 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 個位元組，也不可以超過 2,048 個位元組。

  使用 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 Resource Name (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 Resource Name (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 Resource Name (ARN)。
+ `KmsKeyId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  用於加密頻道的 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 個位元組，也不可以超過 2,048 個位元組。

  使用 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 Resource Name (ARN)。
+ `Marker` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。

  用以指定分頁開始位置的字符。這是來自先前已截斷回應的標記。
+ `MaxRecords` – 數字 (整數)。

  要在輸出中傳回的項目總數。
+ `TargetArn` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。

  整合中目標資源的 Amazon Resource Name (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`SourceTableConfig`，以及`TargetTableConfig`分別與 `ResourceArn` `ResourceArn`相同的 AWS Glue 資料庫 ARN 來叫用相同的 API。

**請求**
+ `ResourceArn` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。

  要為其建立整合資料表屬性的目標資料表的 Amazon Resource Name (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`SourceTableConfig`，以及`TargetTableConfig`分別與 `ResourceArn` `ResourceArn`相同的 AWS Glue 資料庫 ARN 來叫用相同的 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 Resource Name (ARN)。目前，此 API 僅支援擷取目標資料表的屬性，而提供的 ARN 應該是 AWS Glue 資料目錄中目標資料表的 ARN。尚未實作擷取來源連線 (使用連線 ARN) 整合資料表屬性的支援，將在未來版本中新增。
+ `TableName` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。

  要複寫的資料表名稱。

**回應**
+ `ResourceArn` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。

  要為其擷取整合資料表屬性的目標資料表的 Amazon Resource Name (ARN)。目前，此 API 僅支援擷取目標資料表的屬性，而提供的 ARN 應該是 AWS Glue 資料目錄中目標資料表的 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 連線`ResourceProperty`的 （適用於來源） 或 AWS Glue 資料庫 ARN （適用於目標）。這些屬性可以包含角色來存取連線或資料庫。若要同時設定來源和目標屬性，需要分別使用與 `ResourceArn`相同的 AWS Glue 連線 ARN `SourceProcessingProperties`和與 AWS Glue `ResourceArn`相同的資料庫 ARN 來叫用相同的 API`TargetProcessingProperties`。

**請求**
+ `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 連線`ResourceProperty`的 （適用於來源） 或 AWS Glue 資料庫 ARN （適用於目標）。這些屬性可以包含角色來存取連線或資料庫。由於相同的資源可用於多個整合，因此更新資源屬性會影響使用其所有整合。

**請求**
+ `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 連線`ResourceProperty`的 （適用於來源） 或 AWS Glue 資料庫 ARN （適用於目標）

**請求**
+ `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 Resource Name (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 執行階段環境執行的期間。

**欄位**
+ `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` – 數字 (雙位數)。

  工作階段的程式碼執行進度。
+ `MaxCapacity` – 數字 (雙位數)。

  任務執行時可配置的 AWS Glue 資料處理單位 (DPUs) 數量。DPU 是相對的處理能力，包含 4 個 vCPU 的運算容量和 16 GB 的記憶體。
+ `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=""`)。

  工作階段執行時分配的預先定義工作者類型。接受 Spark 工作階段的 `G.1X`、`G.2X`、`G.4X` 或 `G.8X` 值。接受 Ray 工作階段的 `Z.2X` 值。
+ `CompletedOn` – 時間戳記。

  此工作階段完成的日期和時間。
+ `ExecutionTime` – 數字 (雙位數)。

  工作階段執行的總時間。
+ `DPUSeconds` – 數字 (雙位數)。

  工作階段使用的 DPU (公式：ExecutionTime \$1 MaxCapacity)。
+ `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`。

**欄位**
+ `Name` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  指定 SessionCommand 的名稱。可以是 'glueetl' 或 '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>

在工作階段中發生的特定動作陳述式或請求。

**欄位**
+ `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` – 數字 (雙位數)。

  程式碼執行進度。
+ `StartedOn` – 數字 (long)。

  開始任務定義的 unix 時間和日期。
+ `CompletedOn` – 數字 (long)。

  完成任務定義的 unix 時間和日期。

## StatementOutput 結構
<a name="aws-glue-api-interactive-sessions-StatementOutput"></a>

JSON 格式的程式碼執行輸出。

**欄位**
+ `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 格式的程式碼執行輸出。

**欄位**
+ `TextPlain` – UTF-8 字串。

  文字格式的程式碼執行輸出。

## ConnectionsList 結構
<a name="aws-glue-api-interactive-sessions-ConnectionsList"></a>

指定任務所使用的連線。

**欄位**
+ `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)
+ [ListSessions 動作 (Python: list\$1sessions)](#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 小時 (2,880 分鐘)。如需其他任務類型，請參閱文件。
+ `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` – 數字 (雙位數)。

  任務執行時可配置的 AWS Glue 資料處理單位 (DPUs) 數量。DPU 是相對的處理能力，包含 4 個 vCPU 的運算容量和 16 GB 的記憶體。
+ `NumberOfWorkers` – 數字 (整數)。

  用於工作階段的已定義 `WorkerType` 的工作者數量。
+ `WorkerType` – UTF-8 字串 (有效值：`Standard=""` \$1 `G.1X=""` \$1 `G.2X=""` \$1 `G.025X=""` \$1 `G.4X=""` \$1 `G.8X=""` \$1 `Z.2X=""`)。

  將在任務執行時分配的預先定義工作者類型。接受 Spark 任務的 G.1X、G.2X、G.4X 或 G.8X 值。接受 Ray 筆記本的 Z.2X 值。
  + 用於 `G.1X` 工作者類型時，每個工作者會映射到 1 個 DPU (4 個 vCPU、16 GB 的記憶體)，外加 94 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議將此工作者類型用於資料轉換、聯結和查詢等工作負載，以提供可擴展且符合成本效益的方式來執行大部分任務。
  + 用於 `G.2X` 工作者類型時，每個工作者會映射到 2 個 DPU (8 個 vCPU、32 GB 的記憶體)，外加 138 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議將此工作者類型用於資料轉換、聯結和查詢等工作負載，以提供可擴展且符合成本效益的方式來執行大部分任務。
  + 用於 `G.4X` 工作者類型時，每個工作者會映射到 4 個 DPU (16 個 vCPU、64 GB 的記憶體)，外加 256 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議工作負載包含最嚴苛轉換、彙總、聯結和查詢的任務採用這種工作者類型。此工作者類型僅適用於下列 AWS 區域中的 3.0 AWS Glue 版或更新版本 Spark ETL 任務：美國東部 （俄亥俄）、美國東部 （維吉尼亞北部）、美國西部 （奧勒岡）、亞太區域 （新加坡）、亞太區域 （雪梨）、亞太區域 （東京）、加拿大 （中部）、歐洲 （法蘭克福）、歐洲 （愛爾蘭） 和歐洲 （斯德哥爾摩）。
  + 用於 `G.8X` 工作者類型時，每個工作者會映射到 8 個 DPU (32 個 vCPU、128 GB 的記憶體)，外加 512 GB 磁碟，並為每個工作者提供 1 個執行器。我們建議工作負載包含最嚴苛轉換、彙總、聯結和查詢的任務採用這種工作者類型。此工作者類型僅適用於 3.0 AWS Glue 版或更新版本的 Spark ETL 任務，適用於與`G.4X`工作者類型支援的相同 AWS 區域。
  + 對於 `Z.2X` 工作者類型，每個工作者都會映射到 2 個 M-DPU (8 個 vCPU、64 GB 記憶體)，外加 128 GB 磁碟，並根據自動縮放器提供最多 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`

## ListSessions 動作 (Python: list\$1sessions)
<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 Resource Name (ARN)。
+ `InstanceArn` – UTF-8 字串，長度不可小於 10 個位元組，也不可以超過 1224 個位元組。

  與 AWS Glue 組態相關聯之 Identity Center 執行個體的 Amazon Resource Name (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 與 IAM Identity Center AWS 之間的整合，以進行身分驗證和授權。

**請求**

請求建立新的 AWS Glue Identity Center 組態。
+ `InstanceArn` – *必要：*UTF-8 字串，長度不可小於 10 個位元組，也不可以超過 1224 個位元組。

  要與 AWS Glue 組態建立關聯之 Identity Center 執行個體的 Amazon Resource Name (ARN)。
+ `Scopes` – UTF-8 字串的陣列，不可小於 1 或超過 50 個字串。

  定義 AWS Glue 組態許可和存取層級的 Identity Center 範圍清單。

**回應**

建立新 AWS Glue Identity Center 組態的回應。
+ `ApplicationArn` – UTF-8 字串，長度不可小於 10 個位元組，也不可以超過 1224 個位元組。

  為 AWS Glue 組態建立之 Identity Center 應用程式的 Amazon Resource Name (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) 指令碼。

**欄位**
+ `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 Resource Name (ARN)。
+ `SecurityGroupIds` – UTF-8 字串陣列。

  此 `DevEndpoint` 中所使用的安全群組識識別碼清單。
+ `SubnetId` – UTF-8 字串。

  此 `DevEndpoint` 的子網路 ID。
+ `YarnEndpointAddress` – UTF-8 字串。

  此 `DevEndpoint` 所用的 YARN 端點地址。
+ `PrivateAddress` – UTF-8 字串。

  此為當 `DevEndpoint` 是在 VPC 中建立，透過 VPC 存取 `DevEndpoint` 時私有 IP 地址。`PrivateAddress` 欄位只會在您於 VPC 中建立 `DevEndpoint` 時出現。
+ `ZeppelinRemoteSparkInterpreterPort` – 數字 (整數)。

  供遠端 Apache Spark 解譯器使用的 Apache Zeppelin 通訊埠。
+ `PublicAddress` – UTF-8 字串。

  此 `DevEndpoint` 所用的公有 IP 地址。只有當您建立非虛擬私有雲端 (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=""`)。

  配置給開發端點的預先定義工作者類型。可接受值為標準、G.1X 或 G.2X
  + 用於 `Standard` 工作者類型時，每個工作者提供 4 個 vCPU、16 GB 的記憶體和 50 GB 磁碟，以及每個工作者 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` 的工作者數目。

  您可以為 `G.1X` 定義的工作者數目上限是 299，為 `G.2X` 定義的數目上限則是 149。
+ `NumberOfNodes` – 數字 (整數)。

  配置給此 的 AWS Glue 資料處理單位 (DPUs) 數量`DevEndpoint`。
+ `AvailabilityZone` – UTF-8 字串。

  此 `DevEndpoint`所在的 AWS 可用區域。
+ `VpcId` – UTF-8 字串。

  此 `DevEndpoint` 所用虛擬私有雲端 (VPC) 的 ID。
+ `ExtraPythonLibsS3Path` – UTF-8 字串。

  指向 Amazon S3 儲存貯體中一或多個 Python 程式庫的路徑，此儲存貯體應載入您的 `DevEndpoint`。多個值必須是以逗號分隔的完整路徑。
**注意**  
您只能搭配純 Python 程式庫使用 `DevEndpoint`。目前尚未支援使用 C 擴充功能的程式庫 (例如 [pandas](http://pandas.pydata.org/) Python 資料分析程式庫)。
+ `ExtraJarsS3Path` – UTF-8 字串。

  指向 S3 儲存貯體中一或多個 Java `.jar` 檔案的路徑，該 S3 儲存貯體應載入您的 `DevEndpoint`。
**注意**  
您只能搭配純 Java/Scala 程式庫使用 `DevEndpoint`。
+ `FailureReason` – UTF-8 字串。

  此 `DevEndpoint` 目前故障的原因。
+ `LastUpdateStatus` – UTF-8 字串。

  上次更新的狀態。
+ `CreatedTimestamp` – 時間戳記。

  此 DevEndpoint 建立的時間點。
+ `LastModifiedTimestamp` – 時間戳記。

  此 `DevEndpoint` 上次修改的時間點。
+ `PublicKey` – UTF-8 字串。

  此 `DevEndpoint` 用來進行身分驗證所使用的公有金鑰。由於推薦使用屬性是公用金鑰，此屬性的提供是為了回溯相容性。
+ `PublicKeys` – UTF-8 字串的陣列，不可超過 5 個字串。

  該 `DevEndpoints` 用來進行身分驗證所使用的公有金鑰清單。此屬性的使用優先於單一公有公鑰，因為公有金鑰允許您為每個用戶端使用不同的私有金鑰。
**注意**  
如果您之前是搭配公有金鑰建立端點，則您必須移除該金鑰，才能設定的公有金鑰。搭配 `deletePublicKeys` 屬性中的公用金鑰，以及 `addPublicKeys` 屬性清單中的新金鑰清單，呼叫 `UpdateDevEndpoint` API 操作。
+ `SecurityConfiguration` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  可與此 `DevEndpoint` 搭配使用的 `SecurityConfiguration` 結構名稱。
+ `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>

要載入開發端點的自訂程式庫。

**欄位**
+ `ExtraPythonLibsS3Path` – UTF-8 字串。

  至 Amazon Simple Storage Service (Amazon S3) 儲存貯體中一個或多個 Python 程式庫的路徑，該儲存貯體應載入您的 `DevEndpoint`。多個值必須是以逗號分隔的完整路徑。
**注意**  
您只能搭配純 Python 程式庫使用 `DevEndpoint`。目前尚未支援使用 C 擴充功能的程式庫 (例如 [pandas](http://pandas.pydata.org/) Python 資料分析程式庫)。
+ `ExtraJarsS3Path` – UTF-8 字串。

  指向 S3 儲存貯體中一或多個 Java `.jar` 檔案的路徑，該 S3 儲存貯體應載入您的 `DevEndpoint`。
**注意**  
您只能搭配純 Java/Scala 程式庫使用 `DevEndpoint`。

## 作業
<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 字串陣列。

  安全群組的安全群組 ID，這些安全群組是要給新的 `DevEndpoint` 使用。
+ `SubnetId` – UTF-8 字串。

  新 `DevEndpoint` 要使用的子網路 ID。
+ `PublicKey` – UTF-8 字串。

  此 `DevEndpoint` 用來進行身分驗證所使用的公有金鑰。由於推薦使用屬性是公用金鑰，此屬性的提供是為了回溯相容性。
+ `PublicKeys` – UTF-8 字串的陣列，不可超過 5 個字串。

  該開發端點用來進行身分驗證所使用的公有金鑰清單。此屬性的使用優先於單一公有公鑰，因為公有金鑰允許您為每個用戶端使用不同的私有金鑰。
**注意**  
如果您之前是搭配公有金鑰建立端點，則您必須移除該金鑰，才能設定的公有金鑰。搭配 `deletePublicKeys` 屬性中的公用金鑰，以及 `addPublicKeys` 屬性清單中的新金鑰清單，呼叫 `UpdateDevEndpoint` API。
+ `NumberOfNodes` – 數字 (整數)。

  要配置給此 的 AWS Glue 資料處理單位 (DPUs) 數量`DevEndpoint`。
+ `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
  + 用於 `Standard` 工作者類型時，每個工作者提供 4 個 vCPU、16 GB 的記憶體和 50 GB 磁碟，以及每個工作者 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` 的工作者數目。

  您可以為 `G.1X` 定義的工作者數目上限是 299，為 `G.2X` 定義的數目上限則是 149。
+ `ExtraPythonLibsS3Path` – UTF-8 字串。

  指向 Amazon S3 儲存貯體中一或多個 Python 程式庫的路徑，此儲存貯體應載入您的 `DevEndpoint`。多個值必須是以逗號分隔的完整路徑。
**注意**  
您只能搭配純 Python 程式庫使用 `DevEndpoint`。目前尚未支援使用 C 延伸模組的程式庫 (例如 [pandas](http://pandas.pydata.org/) Python 資料分析程式庫)。
+ `ExtraJarsS3Path` – UTF-8 字串。

  指向 S3 儲存貯體中一或多個 Java `.jar` 檔案的路徑，該 S3 儲存貯體應載入您的 `DevEndpoint`。
+ `SecurityConfiguration` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  可與此 `DevEndpoint` 搭配使用的 `SecurityConfiguration` 結構名稱。
+ `Tags` – 金鑰值對的對應陣列，不超過 50 對。

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

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

  要搭配此 DevEndpoint 使用的標籤。您可以使用標籤來限制對於 DevEndpoint 的存取情況。如需 中標籤的詳細資訊 AWS Glue，請參閱《 開發人員指南》中的 [AWS 中的標籤 AWS Glue](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 資料處理單位 (DPUs) 數量。
+ `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 的值。
+ `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` 所用虛擬私有雲端 (VPC) 的 ID。
+ `ExtraPythonLibsS3Path` – UTF-8 字串。

  至 S3 儲存貯體中一個或多個 Python 程式庫的路徑，該 S3 儲存貯體將載入您的 `DevEndpoint`。
+ `ExtraJarsS3Path` – UTF-8 字串。

  至 S3 儲存貯體中一個或多個 Java `.jar` 檔案的路徑，該 S3 儲存貯體將載入您的 `DevEndpoint`。
+ `FailureReason` – UTF-8 字串。

  此 `DevEndpoint` 目前故障的原因。
+ `SecurityConfiguration` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  可與此 `DevEndpoint` 搭配使用的 `SecurityConfiguration` 結構名稱。
+ `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>

擷取關於所指定開發端點的資訊。

**注意**  
當您在虛擬私有雲端 (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 帳戶中的所有開發端點。

**注意**  
當您在虛擬私有雲端 (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 說明與使用結構描述相關的資料類型和 API AWS Glue。

## 資料類型
<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)。

**欄位**
+ `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>

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

**欄位**
+ `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>

包含結構描述版本之中繼資料資訊的結構。

**欄位**
+ `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>

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

**欄位**
+ `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>

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

**欄位**
+ `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>

包含結構描述版本詳細資訊的物件。

**欄位**
+ `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>

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

**欄位**
+ `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>

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

**欄位**
+ `VersionNumber` – 數字 (長整數)，不可小於 1，也不可以大於 100000。

  結構描述的版本編號。
+ `ErrorDetails` – [ErrorDetails](#aws-glue-api-schema-registry-api-ErrorDetails) 物件。

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

## ErrorDetails 結構
<a name="aws-glue-api-schema-registry-api-ErrorDetails"></a>

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

**欄位**
+ `ErrorCode` – UTF-8 字串。

  錯誤的錯誤碼。
+ `ErrorMessage` – UTF-8 字串。

  錯誤的錯誤訊息。

## SchemaVersionNumber 結構
<a name="aws-glue-api-schema-registry-api-SchemaVersionNumber"></a>

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

**欄位**
+ `LatestVersion` – 布林值。

  可用於結構描述的最新版本。
+ `VersionNumber` – 數字 (長整數)，不可小於 1，也不可以大於 100000。

  結構描述的版本編號。

## SchemaId 結構
<a name="aws-glue-api-schema-registry-api-SchemaId"></a>

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

**欄位**
+ `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\$1versions)](#aws-glue-api-schema-registry-api-ListSchemaVersions)
+ [GetSchemaVersion 動作 (Python: get\$1schema\$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\$1schemas)](#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\$1schema\$1versions)](#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)。

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

**回應**
+ `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\$1versions)
<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\$1schema\$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)。

  以 JSON Patch 格式作為字串的結構描述之間的區別。

**錯誤**
+ `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\$1schemas)
<a name="aws-glue-api-schema-registry-api-ListSchemas"></a>

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

未提供 `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 將儲存結構描述版本並立即傳回。否則，由於相容性模式，此呼叫可能會比其他操作執行更長的時間。您可以呼叫 `GetSchemaVersion` API 搭配 `SchemaVersionId` 來檢查相容性模式。

如果相同的結構描述定義已儲存在結構描述登錄檔作為版本，現有結構描述的結構描述 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)。

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

**回應**
+ `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\$1schema\$1versions)
<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>

 Workflows API 說明與在其中建立、更新或檢視工作流程相關的資料類型和 API AWS Glue。您可以存取工作流程和任務執行的 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>

工作流程中顯示的 Job 節點詳細資訊。

**欄位**
+ `JobRuns` – 一個 [JobRun](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-JobRun) 物件陣列。

  job 節點代表的任務資訊。

## CrawlerNodeDetails 結構
<a name="aws-glue-api-workflow-CrawlerNodeDetails"></a>

工作流程中顯示的 Crawler 節點詳細資訊。

**欄位**
+ `Crawls` – 一個 [編目](#aws-glue-api-workflow-Crawl) 物件陣列。

  crawl 節點代表的編目清單。

## TriggerNodeDetails 結構
<a name="aws-glue-api-workflow-TriggerNodeDetails"></a>

工作流程中顯示的 Trigger 節點詳細資訊。

**欄位**
+ `Trigger` – [觸發條件](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-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) 物件。

  當節點代表 Trigger 時的觸發詳細資訊。
+ `JobDetails` – [JobNodeDetails](#aws-glue-api-workflow-JobNodeDetails) 物件。

  當節點代表 Job 時的任務詳細資訊。
+ `CrawlerDetails` – [CrawlerNodeDetails](#aws-glue-api-workflow-CrawlerNodeDetails) 物件。

  當節點代表 Crawler 時的爬蟲程式詳細資訊。

## 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)。

  節點開始所在工作流程的唯一節點。
+ `DestinationId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  節點結束所在工作流程的唯一節點。

## Workflow 結構
<a name="aws-glue-api-workflow-Workflow"></a>

工作流程是多個相依 AWS Glue 任務和爬蟲程式的集合，這些任務和爬蟲程式會執行來完成複雜的 ETL 任務。每項工作流程都管理其所有任務和爬蟲程式的執行和監控。

**欄位**
+ `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 字串。

  在 Amazon S3 中指定一個路徑，當您呼叫 `CreateBlueprint/UpdateBlueprint` 以將藍圖註冊到 AWS Glue時要複製藍圖的路徑。
+ `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 字串。

  指定 AWS Glue 開發人員在 Amazon S3 中發佈藍圖的路徑。
+ `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\$1blueprints)](#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 字串，長度不可超過 120000 個位元組。

  工作流程的描述。
+ `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 字串，長度不可超過 120000 個位元組。

  工作流程的描述。
+ `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\$1blueprints)
<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` – 一個 [藍圖](#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 說明與在其中建立、更新或檢視用量描述檔相關的資料類型和 API AWS Glue。

## 資料類型
<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\$1profiles)](#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\$1profiles)
<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>

與機器學習轉換相關聯的演算法特定參數。

**欄位**
+ `TransformType` – *必要：*UTF-8 字串 (有效值：`FIND_MATCHES`)。

  機器學習轉換的類型。

  如需機器學習轉換類型的資訊，請參閱[建立機器學習轉換](https://docs.aws.amazon.com/glue/latest/dg/add-job-machine-learning-transform.html)。
+ `FindMatchesParameters` – [FindMatchesParameters](#aws-glue-api-machine-learning-api-FindMatchesParameters) 物件。

  find matches 演算法的參數。

## EvaluationMetrics 結構
<a name="aws-glue-api-machine-learning-api-EvaluationMetrics"></a>

評估指標會提供機器學習轉換品質的預估值。

**欄位**
+ `TransformType` – *必要：*UTF-8 字串 (有效值：`FIND_MATCHES`)。

  機器學習轉換的類型。
+ `FindMatchesMetrics` – [FindMatchesMetrics](#aws-glue-api-machine-learning-api-FindMatchesMetrics) 物件。

  find matches 演算法的評估指標。

## MLTransform 結構
<a name="aws-glue-api-machine-learning-api-MLTransform"></a>

機器學習轉換的結構。

**欄位**
+ `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` – 數字 (雙位數)。

  分配給此轉換之任務執行的 AWS Glue 資料處理單位 (DPUs) 數量。您可以分配從 2 到 100 個 DPU，預設值為 10。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [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=""`)。

  此轉換執行任務時所配置的預先定義工作者類型。可接受值為標準、G.1X 或 G.2X
  + 用於 `Standard` 工作者類型時，每個工作者提供 4 個 vCPU、16 GB 的記憶體和 50 GB 磁碟，以及每個工作者 2 個執行器。
  + 用於 `G.1X` 工作者類型時，每個工作者提供 4 個 vCPU、16 GB 的記憶體和 64 GB 磁碟，以及每個工作者 1 個執行器。
  + 用於 `G.2X` 工作者類型時，每個工作者提供 8 個 vCPU、32 GB 的記憶體和 128 GB 磁碟，以及每個工作者 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) 物件。

  適用於存取使用者資料的轉換的靜態加密設定。機器學習轉換可以使用 KMS 存取 Amazon S3 中加密的使用者資料。

## FindMatchesParameters 結構
<a name="aws-glue-api-machine-learning-api-FindMatchesParameters"></a>

設定 find matches 轉換的參數。

**欄位**
+ `PrimaryKeyColumnName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 1024 個位元組，需符合 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  唯一識別來源資料表中資料列的欄名。用於協助識別相符的記錄。
+ `PrecisionRecallTradeoff` – 數字 (double)，不可大於 1.0。

  調校轉換以取得精確率與回收率平衡時所選取的值。值為 0.5 表示無偏好；值為 1.0 表示專門針對精確率的偏差；值為 0.0 表示針對回收率的偏差。因為這是一種權衡，選擇接近 1.0 的值表示非常低的回收率，選擇接近 0.0 的值則會得到非常低的精確率。

  精確率指標指出模型預測相符項目時的正確頻率。

  回收率指標表示針對實際比對，模型預測相符項目的頻率。
+ `AccuracyCostTradeoff` – 數字 (double)，不可大於 1.0。

  調校轉換以取得準確性與成本平衡時所選取的值。值為 0.5 表示系統持平考量準確性與成本。值為 1.0 表示專門針對準確性的偏差，這通常會導致較高的成本，有時會非常高。值為 0.0 表示專門針對成本的偏差，這會導致低準確性的 `FindMatches` 轉換，有時是無法接受的準確性。

  Accuracy (準確性) 會測量轉換找到真肯定和真否定的效果有多好。提高正確性需要更多的機器資源和成本。但也會增加回收率。

  成本會測量執行轉換要消耗多少運算資源上，以此計算出金額。
+ `EnforceProvidedLabels` – 布林值。

  值，開啟或關閉以強制輸出符合使用者提供的標籤。如果此值為 `True`，則 `find matches` 轉換會強制輸出符合提供的標籤。結果會覆寫正常的合併結果。如果此值為 `False`，則 `find matches` 轉換不確保遵守所有提供的標籤，結果會倚賴訓練過的模型。

  請注意，將此值設定為 true 可能會增加合併執行的時間。

## FindMatchesMetrics 結構
<a name="aws-glue-api-machine-learning-api-FindMatchesMetrics"></a>

find matches 演算法的評估指標。測量機器學習轉換品質的方式，是讓您的轉換預測一些相符項目，並比較此結果與相同資料集的已知相符項目。品質指標是以您的部分資料為基礎，所以不精確。

**欄位**
+ `AreaUnderPRCurve` – 數字 (double)，不可大於 1.0。

  在精確率/回收率曲線 (AUPRC) 下的區域是測量轉換整體品質的單一數字，與精確率與回收率的選擇無關。較高的值表示您有較具吸引力的精確率與回收率權衡。

  如需詳細資訊，請參閱 Wikipedia 中的 [Precision and recall](https://en.wikipedia.org/wiki/Precision_and_recall)。
+ `Precision` – 數字 (double)，不可大於 1.0。

  精確率指標指出轉換預測相符項目的正確頻率。尤其，它會測量轉換從真陽性總可能性中找出真陽性的效果有多好。

  如需詳細資訊，請參閱 Wikipedia 中的 [Precision and recall](https://en.wikipedia.org/wiki/Precision_and_recall)。
+ `Recall` – 數字 (double)，不可大於 1.0。

  回收率指標表示針對實際比對，轉換預測相符項目的頻率。尤其，它會測量轉換從來源資料總記錄中找出真陽性的效果有多好。

  如需詳細資訊，請參閱 Wikipedia 中的 [Precision and recall](https://en.wikipedia.org/wiki/Precision_and_recall)。
+ `F1` – 數字 (double)，不可大於 1.0。

  F1 指標上限指出轉換的準確性介於 0 和 1 之間，其中 1 為最佳準確性。

  如需詳細資訊，請參閱 Wikipedia 中的 [F1 score](https://en.wikipedia.org/wiki/F1_score)。
+ `ConfusionMatrix` – [ConfusionMatrix](#aws-glue-api-machine-learning-api-ConfusionMatrix) 物件。

  混淆矩陣會顯示轉換準確預測的內容及其產生的錯誤類型。

  如需詳細資訊，請參閱 Wikipedia 的 [Confusion matrix](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 的 [Confusion matrix](https://en.wikipedia.org/wiki/Confusion_matrix)。

**欄位**
+ `NumTruePositives` – 數字 (long)。

  在您轉換的混淆矩陣中，轉換在資料中正確找到的相符項目數量。
+ `NumFalsePositives` – 數字 (long)。

  在您轉換的混淆矩陣中，轉換在資料中誤分類為相符項目的非相符項目數量。
+ `NumTrueNegatives` – 數字 (long)。

  在您轉換的混淆矩陣中，轉換在資料中正確拒絕的非相符項目數量。
+ `NumFalseNegatives` – 數字 (long)。

  在您轉換的混淆矩陣中，轉換在資料中沒找到的相符項目數量。

## GlueTable 結構
<a name="aws-glue-api-machine-learning-api-GlueTable"></a>

中 AWS Glue Data Catalog 用於輸入或輸出資料的資料庫和資料表。

**欄位**
+ `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>

與機器學習轉換相關聯的取樣參數。

**欄位**
+ `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>

用來篩選機器學習轉換的條件。

**欄位**
+ `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>

與機器學習轉換相關聯的排序條件。

**欄位**
+ `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>

用來篩選機器學習轉換任務回合的條件。

**欄位**
+ `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>

用來排序機器學習轉換任務回合清單的排序條件。

**欄位**
+ `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>

任務回合的組態屬性。

**欄位**
+ `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) 物件。

  Find Matches 任務回合的組態屬性。

## FindMatchesTaskRunProperties 結構
<a name="aws-glue-api-machine-learning-api-FindMatchesTaskRunProperties"></a>

指定 Find Matches 任務回合的組態屬性。

**欄位**
+ `JobId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  Find Matches 任務回合的任務 ID。
+ `JobName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  指派給 Find Matches 任務回合任務的名稱。
+ `JobRunId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  Find Matches 任務回合的任務回合 ID。

## ImportLabelsTaskRunProperties 結構
<a name="aws-glue-api-machine-learning-api-ImportLabelsTaskRunProperties"></a>

指定匯入標籤任務回合的組態屬性。

**欄位**
+ `InputS3Path` – UTF-8 字串。

  Amazon Simple Storage Service (Amazon S3) 路徑，您會由此匯入標籤。
+ `Replace` – 布林值。

  指出是否覆寫現有的標籤。

## ExportLabelsTaskRunProperties 結構
<a name="aws-glue-api-machine-learning-api-ExportLabelsTaskRunProperties"></a>

指定匯出標籤任務回合的組態屬性。

**欄位**
+ `OutputS3Path` – UTF-8 字串。

  Amazon Simple Storage Service (Amazon S3) 路徑，您會由此匯出標籤。

## LabelingSetGenerationTaskRunProperties 結構
<a name="aws-glue-api-machine-learning-api-LabelingSetGenerationTaskRunProperties"></a>

指定標籤集產生任務回合的組態屬性。

**欄位**
+ `OutputS3Path` – UTF-8 字串。

  Amazon Simple Storage Service (Amazon S3) 路徑，您會在此產生標籤集。

## SchemaColumn 結構
<a name="aws-glue-api-machine-learning-api-SchemaColumn"></a>

鍵/值對，代表要執行此轉換的欄和資料類型。`MLTransform` 的 `Schema` 參數最多可包含 100 個這些結構。

**欄位**
+ `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>

適用於存取使用者資料的轉換的靜態加密設定。機器學習轉換可以使用 KMS 存取 Amazon S3 中加密的使用者資料。

此外，匯入的標籤和經過訓練的轉換現在可以使用客戶提供的 KMS 金鑰加密。

**欄位**
+ `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>

適用於存取使用者資料的轉換的靜態加密設定。

**欄位**
+ `MlUserDataEncryptionMode` – *必要：*UTF-8 字串 (有效值：`DISABLED` \$1 `SSE-KMS="SSEKMS"`)。

  套用至使用者資料的加密模式。有效的值如下：
  + DISABLED：已停用加密
  + SSEKMS：對存放在 Amazon S3 中的使用者資料使用伺服器端加密搭配 AWS Key Management Service (SSE-KMS)。
+ `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>

包含欄名稱和欄重要性分數的結構。

欄重要性可協助您了解欄對模型的貢獻方式，藉由識別記錄中的哪些欄比其他欄更重要。

**欄位**
+ `ColumnName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  欄的名稱。
+ `Importance` – 數字 (double)，不可大於 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\$1transforms)](#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` – 數字 (雙位數)。

  分配給此轉換之任務執行的 AWS Glue 資料處理單位 (DPUs) 數量。您可以分配從 2 到 100 個 DPU，預設值為 10。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [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=""`)。

  執行此任務時所配置的預先定義工作者類型。可接受值為標準、G.1X 或 G.2X
  + 用於 `Standard` 工作者類型時，每個工作者提供 4 個 vCPU、16 GB 的記憶體和 50 GB 磁碟，以及每個工作者 2 個執行器。
  + 用於 `G.1X` 工作者類型時，每個工作者提供 4 個 vCPU、16 GB 的記憶體和 64 GB 磁碟，以及每個工作者 1 個執行器。
  + 用於 `G.2X` 工作者類型時，每個工作者提供 8 個 vCPU、32 GB 的記憶體和 128 GB 磁碟，以及每個工作者 1 個執行器。

  `MaxCapacity` 是 `NumberOfWorkers` 和 `WorkerType` 的互斥選項。
  + 如果設定 `NumberOfWorkers` 或 `WorkerType`，則無法設定 `MaxCapacity`。
  + 如果設定 `MaxCapacity`，則無法設定 `NumberOfWorkers` 或 `WorkerType`。
  + 如果設定 `WorkerType`，則 `NumberOfWorkers` 為必要 (反之亦然)。
  + `MaxCapacity` 和 `NumberOfWorkers` 都必須至少為 1。
+ `NumberOfWorkers` – 數字 (整數)。

  執行此任務時所配置的已定義 `workerType` 工作者數目。

  如果設定 `WorkerType`，則 `NumberOfWorkers` 為必要 (反之亦然)。
+ `Timeout` – 數字 (整數)，至少為 1。

  此轉換任務回合的逾時，以分鐘計。這是此轉換任務回合在終止並進入 `TIMEOUT` 狀態前，可取用資源的最長時間。預設值為 2,880 分鐘 (48 小時)。
+ `MaxRetries` – 數字 (整數)。

  任務回合失敗後，此轉換任務可重試的次數上限。
+ `Tags` – 金鑰值對的對應陣列，不超過 50 對。

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

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

  與此機器學習轉換搭配使用的標籤。您可以使用標籤來限制對機器學習轉換的存取情況。如需 中標籤的詳細資訊 AWS Glue，請參閱《 開發人員指南》[AWS 中的 中的標籤 AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html)。
+ `TransformEncryption` – [TransformEncryption](#aws-glue-api-machine-learning-api-TransformEncryption) 物件。

  適用於存取使用者資料的轉換的靜態加密設定。機器學習轉換可以使用 KMS 存取 Amazon S3 中加密的使用者資料。

**回應**
+ `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` – 數字 (雙位數)。

  分配給此轉換之任務執行的 AWS Glue 資料處理單位 (DPUs) 數量。您可以分配從 2 到 100 個 DPU，預設值為 10。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [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=""`)。

  執行此任務時所配置的預先定義工作者類型。可接受值為標準、G.1X 或 G.2X
  + 用於 `Standard` 工作者類型時，每個工作者提供 4 個 vCPU、16 GB 的記憶體和 50 GB 磁碟，以及每個工作者 2 個執行器。
  + 用於 `G.1X` 工作者類型時，每個工作者提供 4 個 vCPU、16 GB 的記憶體和 64 GB 磁碟，以及每個工作者 1 個執行器。
  + 用於 `G.2X` 工作者類型時，每個工作者提供 8 個 vCPU、32 GB 的記憶體和 128 GB 磁碟，以及每個工作者 1 個執行器。
+ `NumberOfWorkers` – 數字 (整數)。

  執行此任務時所配置的已定義 `workerType` 工作者數目。
+ `Timeout` – 數字 (整數)，至少為 1。

  此轉換任務回合的逾時，以分鐘計。這是此轉換任務回合在終止並進入 `TIMEOUT` 狀態前，可取用資源的最長時間。預設值為 2,880 分鐘 (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` – 數字 (雙位數)。

  分配給此轉換之任務執行的 AWS Glue 資料處理單位 (DPUs) 數量。您可以分配從 2 到 100 個 DPU，預設值為 10。DPU 是處理能力的相對測量，包含 4 個 vCPUs的運算容量和 16 GB 的記憶體。如需詳細資訊，請參閱 [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=""`)。

  執行此任務時所配置的預先定義工作者類型。可接受值為標準、G.1X 或 G.2X
  + 用於 `Standard` 工作者類型時，每個工作者提供 4 個 vCPU、16 GB 的記憶體和 50 GB 磁碟，以及每個工作者 2 個執行器。
  + 用於 `G.1X` 工作者類型時，每個工作者提供 4 個 vCPU、16 GB 的記憶體和 64 GB 磁碟，以及每個工作者 1 個執行器。
  + 用於 `G.2X` 工作者類型時，每個工作者提供 8 個 vCPU、32 GB 的記憶體和 128 GB 磁碟，以及每個工作者 1 個執行器。
+ `NumberOfWorkers` – 數字 (整數)。

  執行此任務時所配置的已定義 `workerType` 工作者數目。
+ `Timeout` – 數字 (整數)，至少為 1。

  此轉換任務回合的逾時，以分鐘計。這是此轉換任務回合在終止並進入 `TIMEOUT` 狀態前，可取用資源的最長時間。預設值為 2,880 分鐘 (48 小時)。
+ `MaxRetries` – 數字 (整數)。

  任務回合失敗後，此轉換任務可重試的次數上限。
+ `TransformEncryption` – [TransformEncryption](#aws-glue-api-machine-learning-api-TransformEncryption) 物件。

  適用於存取使用者資料的轉換的靜態加密設定。機器學習轉換可以使用 KMS 存取 Amazon S3 中加密的使用者資料。

**錯誤**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`

## GetMLTransforms 動作 (Python: get\$1ml\$1transforms)
<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 執行。您可以呼叫具有 `GetMLTaskRun` 的 `TaskRunID` 及其父轉換的 `TransformID`，檢查任何任務回合的統計資料。

**請求**
+ `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` 的 `CancelMLTaskRun` 以及任務回合的 `TaskRunId`，隨時取消機器學習任務回合。

**請求**
+ `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` 後，機器學習轉換未來的所有回合都會使用新的改善標籤，並執行更高品質的轉換。

依預設，除非您將 `Replace` 設為 true，否則 `StartMLLabelingSetGenerationTaskRun` 會持續學習及合併您上傳的所有標籤。如果您將 `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`

# Data Quality API
<a name="aws-glue-api-data-quality-api"></a>

Data Quality API 描述資料品質類型，包含建立、刪除或更新資料品質規則集、執行和評估的 API。

## 資料類型
<a name="aws-glue-api-data-quality-api-objects"></a>
+ [DataSource 結構](#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)
+ [AnnotationError 結構](#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)

## DataSource 結構
<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` – [資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  與執行相關聯的資料來源 ( AWS Glue 資料表）。

## DataQualityRulesetEvaluationRunFilter 結構
<a name="aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunFilter"></a>

篩選條件。

**欄位**
+ `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` – [資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  與建議執行相關聯的資料來源 (AWS Glue 資料表）。

## DataQualityRuleRecommendationRunFilter 結構
<a name="aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunFilter"></a>

列出資料品質建議執行的篩選條件。

**欄位**
+ `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` – 數字 (double)，不可大於 1.0。

  彙總資料品質分數。表示通過的規則數目與規則總數的比率。
+ `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)。

  每個值都是一個數字 (double)。

  與分析器評估關聯的指標映射。

## 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` – 數字 (雙位數)。

  資料品質指標的實際值。
+ `ExpectedValue` – 數字 (雙位數)。

  根據歷史資料分析的資料品質指標的預期值。
+ `LowerLimit` – 數字 (雙位數)。

  根據歷史資料分析的資料品質指標值下限。
+ `UpperLimit` – 數字 (雙位數)。

  根據歷史資料分析的資料品質指標值上限。

## 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)。

  每個值都是一個數字 (double)。

  與規則評估相關聯的指標映射。
+ `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)。

  每個值都是一個數字 (double)。

  包含與根據資料列層級結果評估規則關聯的指標的映射。

## 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` – [資料來源](#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` – [資料來源](#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` – 數字 (雙位數)。

  在資料品質評估期間處理的資料列總數。
+ `TotalRowsPassed` – 數字 (雙位數)。

  傳遞所有適用資料品質規則的資料列總數。
+ `TotalRowsFailed` – 數字 (雙位數)。

  使一個或多個資料品質規則失敗的資料列總數。
+ `TotalRulesProcessed` – 數字 (雙位數)。

  已評估的資料品質規則總數。
+ `TotalRulesPassed` – 數字 (雙位數)。

  通過評估條件的資料品質規則總數。
+ `TotalRulesFailed` – 數字 (雙位數)。

  未通過評估條件的資料品質規則總數。

## 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` – 時間戳記。

  上次修改包含註釋時的時間戳記。

## AnnotationError 結構
<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` – 數字 (雙位數)。

  統計資料的值。
+ `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` – 數字 (雙位數)。

  下限。
+ `UpperBound` – 數字 (雙位數)。

  上限。
+ `PredictedValue` – 數字 (雙位數)。

  預測值。
+ `ActualValue` – 數字 (雙位數)。

  實際值。
+ `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)。

  SQL Query of SparkSQL 格式，可用於在執行資料品質操作 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` – *必要：*[資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  與此執行相關聯的資料來源 (AWS Glue 資料表）。
+ `Role` – *必要：*UTF-8 字串。

   IAM 提供用來加密執行結果的角色。
+ `NumberOfWorkers` – 數字 (整數)。

  在執行中使用的 `G.1X` 工作者數目。預設值為 5。
+ `Timeout` – 數字 (整數)，至少為 1。

  執行逾時 (以分鐘為單位)。此為執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。預設值為 2,880 分鐘 (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)。

  每個值都是 [資料來源](#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` – [資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  與此評估執行相關聯的資料來源 ( AWS Glue 資料表）。
+ `Role` – UTF-8 字串。

   IAM 提供用來加密執行結果的角色。
+ `NumberOfWorkers` – 數字 (整數)。

  在執行中使用的 `G.1X` 工作者數目。預設值為 5。
+ `Timeout` – 數字 (整數)，至少為 1。

  執行逾時 (以分鐘為單位)。此為執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。預設值為 2,880 分鐘 (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)。

  每個值都是 [資料來源](#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 Glue Data Quality 會分析資料，並提出潛在規則集的建議。然後，您可以對規則集進行分類，並根據自己的喜好修改生成的規則集。

系統會在 90 天後自動刪除建議執行。

**請求**

Data Quality 規則建議請求的請求。
+ `DataSource` – *必要：*[資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  與此執行相關聯的資料來源 (AWS Glue 資料表）。
+ `Role` – *必要：*UTF-8 字串。

   IAM 提供用來加密執行結果的角色。
+ `NumberOfWorkers` – 數字 (整數)。

  在執行中使用的 `G.1X` 工作者數目。預設值為 5。
+ `Timeout` – 數字 (整數)，至少為 1。

  執行逾時 (以分鐘為單位)。此為執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。預設值為 2,880 分鐘 (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)。

  與此回合相關聯的唯一回合識別符。

**回應**

Data Quality 規則建議執行的回應。
+ `RunId` – 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) 物件。

  與此執行相關聯的資料來源 ( AWS Glue 資料表）。
+ `Role` – UTF-8 字串。

   IAM 提供用來加密執行結果的角色。
+ `NumberOfWorkers` – 數字 (整數)。

  在執行中使用的 `G.1X` 工作者數目。預設值為 5。
+ `Timeout` – 數字 (整數)，至少為 1。

  執行逾時 (以分鐘為單位)。此為執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。預設值為 2,880 分鐘 (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` – 數字 (double)，不可大於 1.0。

  彙總資料品質分數。表示通過的規則數目與規則總數的比率。
+ `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>

使用套用至指定 AWS Glue 資料表的 DQDL 規則建立資料品質規則集。

您可以使用資料品質定義語言 (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` – 數字 (double)，不可大於 1.0。

  彙總資料品質分數。表示通過的規則數目與規則總數的比率。
+ `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>

Data Quality 規則建議請求的請求。

**欄位**
+ `DataSource` – *必要：*[資料來源](#aws-glue-api-data-quality-api-DataSource) 物件。

  與此執行相關聯的資料來源 (AWS Glue 資料表）。
+ `Role` – *必要：*UTF-8 字串。

   IAM 提供用來加密執行結果的角色。
+ `NumberOfWorkers` – 數字 (整數)。

  在執行中使用的 `G.1X` 工作者數目。預設值為 5。
+ `Timeout` – 數字 (整數)，至少為 1。

  執行逾時 (以分鐘為單位)。此為執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。預設值為 2,880 分鐘 (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>

Data Quality 規則建議執行的回應。

**欄位**
+ `RunId` – 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) 物件。

  與此執行相關聯的資料來源 ( AWS Glue 資料表）。
+ `Role` – UTF-8 字串。

   IAM 提供用來加密執行結果的角色。
+ `NumberOfWorkers` – 數字 (整數)。

  在執行中使用的 `G.1X` 工作者數目。預設值為 5。
+ `Timeout` – 數字 (整數)，至少為 1。

  執行逾時 (以分鐘為單位)。此為執行在停止並進入 `TIMEOUT` 狀態前可以消耗資源的最大時間。預設值為 2,880 分鐘 (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 同時需要 profileID 和 statisticID 作為 InclusionAnnotation 輸入的一部分。API 僅適用於跨多個設定檔的單一 statisticId。

**請求**
+ `InclusionAnnotations` – *必要：*一個 [DatapointInclusionAnnotation](#aws-glue-api-data-quality-api-DatapointInclusionAnnotation) 物件。

  `DatapointInclusionAnnotation` 的清單。InclusionAnnotations 必須包含 profileId 和 statisticId。如果有多個 InclusionAnnotations，則清單必須參考跨多個 profileIds 的單一 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\$1custom\$1entity\$1types)](#aws-glue-api-sensitive-data-api-BatchGetCustomEntityTypes)
+ [ListCustomEntityTypes 動作 (Python: list\$1custom\$1entity\$1types)](#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\$1custom\$1entity\$1types)
<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\$1types)
<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`

# 在 中標記 APIs AWS Glue
<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 中的標籤 AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html)和[指定 AWS Glue 資源 ARNs](https://docs.aws.amazon.com/glue/latest/dg/glue-specifying-resource-arns.html)。

**欄位**
+ `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 資源 ARNs 的詳細資訊，請參閱 [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 Resource Name (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 中的標籤 AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html)和[指定 AWS Glue 資源 ARNs](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 個位元組，也不可以超過 1,024 個位元組。

  屬性的金鑰。
+ `Value` – 值字串，長度不可小於 1 個位元組，也不可以超過 1,024 個位元組。

  屬性的值。
+ `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` – *必要：*數字 (long)，不可大於 None (無)。

  欄中的 true 值數目。
+ `NumberOfFalses` – *必要：*數字 (long)，不可大於 None (無)。

  欄中的 false 值數目。
+ `NumberOfNulls` – *必要：*數字 (long)，不可大於 None (無)。

  欄中的 null 值數目。

## DateColumnStatisticsData 結構
<a name="aws-glue-api-common-DateColumnStatisticsData"></a>

定義時間戳記資料欄支援的欄統計資料。

**欄位**
+ `MinimumValue` – 時間戳記。

  欄中的最低值。
+ `MaximumValue` – 時間戳記。

  欄中的最高值。
+ `NumberOfNulls` – *必要：*數字 (long)，不可大於 None (無)。

  欄中的 null 值數目。
+ `NumberOfDistinctValues` – *必要：*數字 (long)，不可大於 None (無)。

  欄中相異值的數目。

## DecimalColumnStatisticsData 結構
<a name="aws-glue-api-common-DecimalColumnStatisticsData"></a>

定義固定點數目資料欄支援的欄統計資料。

**欄位**
+ `MinimumValue` – [DecimalNumber](#aws-glue-api-common-DecimalNumber) 物件。

  欄中的最低值。
+ `MaximumValue` – [DecimalNumber](#aws-glue-api-common-DecimalNumber) 物件。

  欄中的最高值。
+ `NumberOfNulls` – *必要：*數字 (long)，不可大於 None (無)。

  欄中的 null 值數目。
+ `NumberOfDistinctValues` – *必要：*數字 (long)，不可大於 None (無)。

  欄中相異值的數目。

## DoubleColumnStatisticsData 結構
<a name="aws-glue-api-common-DoubleColumnStatisticsData"></a>

定義浮點數資料欄支援的欄統計資料。

**欄位**
+ `MinimumValue` – 數字 (雙位數)。

  欄中的最低值。
+ `MaximumValue` – 數字 (雙位數)。

  欄中的最高值。
+ `NumberOfNulls` – *必要：*數字 (long)，不可大於 None (無)。

  欄中的 null 值數目。
+ `NumberOfDistinctValues` – *必要：*數字 (long)，不可大於 None (無)。

  欄中相異值的數目。

## LongColumnStatisticsData 結構
<a name="aws-glue-api-common-LongColumnStatisticsData"></a>

定義整數資料欄支援的欄統計資料。

**欄位**
+ `MinimumValue` – 數字 (long)。

  欄中的最低值。
+ `MaximumValue` – 數字 (long)。

  欄中的最高值。
+ `NumberOfNulls` – *必要：*數字 (long)，不可大於 None (無)。

  欄中的 null 值數目。
+ `NumberOfDistinctValues` – *必要：*數字 (long)，不可大於 None (無)。

  欄中相異值的數目。

## StringColumnStatisticsData 料結構
<a name="aws-glue-api-common-StringColumnStatisticsData"></a>

定義字元序列資料值支援的欄統計資料。

**欄位**
+ `MaximumLength` – *必要：*數字 (long)，不可大於 None (無)。

  欄中最長字串的大小。
+ `AverageLength` – *必要：*數字 (double)，不可大於 None (無)。

  欄中的平均字串長度。
+ `NumberOfNulls` – *必要：*數字 (long)，不可大於 None (無)。

  欄中的 null 值數目。
+ `NumberOfDistinctValues` – *必要：*數字 (long)，不可大於 None (無)。

  欄中相異值的數目。

## BinaryColumnStatisticsData 結構
<a name="aws-glue-api-common-BinaryColumnStatisticsData"></a>

定義位元序列資料值支援的欄統計資料。

**欄位**
+ `MaximumLength` – *必要：*數字 (long)，不可大於 None (無)。

  欄中最長位元序列的大小。
+ `AverageLength` – *必要：*數字 (double)，不可大於 None (無)。

  欄中的平均位元序列長度。
+ `NumberOfNulls` – *必要：*數字 (long)，不可大於 None (無)。

  欄中的 null 值數目。

## 字串模式
<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_.-]+`"
+ 自訂字串模式 \$136 – "`^arn:aws(-(cn|us-gov|eusc|iso(-[bef])?))?:secretsmanager:.*$`"
+ 自訂字串模式 \$137 – "`\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 字串。

  說明問題的訊息。