本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
用量設定檔
使用情況設定檔 API 說明在 AWS Glue 中與建立、更新或檢視使用情況設定檔相關的資料類型和 API。
資料類型
ProfileConfiguration 結構
指定管理員在 AWS Glue 使用情況設定檔中設定的任務和工作階段值。
欄位
-
SessionConfiguration– 金鑰值對的映射陣列。每個金鑰都是 UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合Single-line string pattern。
每個值都是 ConfigurationObject 物件。
AWS Glue 工作階段組態參數的金鑰值映射。
-
JobConfiguration– 金鑰值對的映射陣列。每個金鑰都是 UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合Single-line string pattern。
每個值都是 ConfigurationObject 物件。
AWS Glue 任務組態參數的金鑰值映射。
ConfigurationObject 結構
指定管理員為 AWS Glue 使用情況設定檔中設定的每個任務或工作階段參數設定的值。
欄位
-
DefaultValue– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 128 個位元組,且需符合 Custom string pattern #35。參數的預設值。
-
AllowedValues– UTF-8 字串陣列。參數的允許值清單。
-
MinValue– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 128 個位元組,且需符合 Custom string pattern #35。參數允許的最小值。
-
MaxValue– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 128 個位元組,且需符合 Custom string pattern #35。參數允許的最大值。
UsageProfileDefinition 結構
描述 AWS Glue 使用情況設定檔。
欄位
-
Name– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合Single-line string pattern。使用情況設定檔的名稱。
-
Description– 描述字串,長度不可超過 2048 個位元組,需符合URI address multi-line string pattern。使用情況設定檔的描述。
-
CreatedOn– 時間戳記。建立使用情況設定檔的日期和時間。
-
LastModifiedOn– 時間戳記。上次修改使用情況設定檔的日期和時間。
作業
CreateUsageProfile 動作 (Python:create_usage_profile)
建立 AWS Glue 使用情況設定檔。
請求
-
Name– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合Single-line string pattern。使用情況設定檔的名稱。
-
Description– 描述字串,長度不可超過 2048 個位元組,需符合URI address multi-line string pattern。使用情況設定檔的描述。
-
Configuration– 必要:ProfileConfiguration 物件。指定設定檔的任務和工作階段值的
ProfileConfiguration物件。 -
Tags– 金鑰值對的映射陣列,不超過 50 對。每個金鑰均為 UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 128 個位元組。
每個值都是 UTF-8 字串,長度不可超過 256 個位元組。
套用至使用情況設定檔的標籤清單。
回應
-
Name– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合Single-line string pattern。已建立的使用情況設定檔名稱。
錯誤
InvalidInputExceptionInternalServiceExceptionAlreadyExistsExceptionOperationTimeoutExceptionResourceNumberLimitExceededExceptionOperationNotSupportedException
GetUsageProfile 動作 (Python:get_usage_profile)
擷取所指定 AWS Glue 使用情況設定檔的相關資訊。
請求
-
Name– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合Single-line string pattern。要擷取的使用情況設定檔名稱。
回應
-
Name– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合Single-line string pattern。使用情況設定檔的名稱。
-
Description– 描述字串,長度不可超過 2048 個位元組,需符合URI address multi-line string pattern。使用情況設定檔的描述。
-
Configuration– ProfileConfiguration 物件。指定設定檔的任務和工作階段值的
ProfileConfiguration物件。 -
CreatedOn– 時間戳記。建立使用情況設定檔的日期和時間。
-
LastModifiedOn– 時間戳記。上次修改使用情況設定檔的日期和時間。
錯誤
InvalidInputExceptionInternalServiceExceptionEntityNotFoundExceptionOperationTimeoutExceptionOperationNotSupportedException
UpdateUsageProfile 動作 (Python:update_usage_profile)
建立 AWS Glue 使用情況設定檔。
請求
-
Name– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合Single-line string pattern。使用情況設定檔的名稱。
-
Description– 描述字串,長度不可超過 2048 個位元組,需符合URI address multi-line string pattern。使用情況設定檔的描述。
-
Configuration– 必要:ProfileConfiguration 物件。指定設定檔的任務和工作階段值的
ProfileConfiguration物件。
回應
-
Name– UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合Single-line string pattern。已更新的使用情況設定檔的名稱。
錯誤
InvalidInputExceptionInternalServiceExceptionEntityNotFoundExceptionOperationTimeoutExceptionOperationNotSupportedExceptionConcurrentModificationException
DeleteUsageProfile 動作 (Python:Delete_usage_profile)
刪除 AWS Glue 指定的使用情況設定檔。
請求
-
Name– 必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合Single-line string pattern。要刪除的使用情況設定檔的名稱。
回應
無回應參數。
錯誤
InvalidInputExceptionInternalServiceExceptionOperationTimeoutExceptionOperationNotSupportedException
ListUsageProfiles 動作 (Python:list_usage_profiles)
列出所有 AWS Glue 使用情況設定檔。
請求
-
NextToken– UTF-8 字串,長度不可超過 400000 個位元組。接續符記,如果這是接續呼叫,將會包含在內。
-
MaxResults– 數字 (整數),不可小於 1,也不可以大於 200。在單一回應中可傳回的最大使用情況設定檔數目。
回應
-
Profiles– 一個 UsageProfileDefinition 物件陣列。使用情況設定檔 (
UsageProfileDefinition) 物件的清單。 -
NextToken– UTF-8 字串,長度不可超過 400000 個位元組。接續字元,如果目前清單區段不是最後一個,將會出現此接續字元。
錯誤
InternalServiceExceptionOperationTimeoutExceptionInvalidInputExceptionOperationNotSupportedException