本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
CreateJob
注意
AWS Snowball 邊緣 不再提供給新客戶。新客戶應探索AWS DataSync
建立可在 Amazon S3 和現場部署資料中心之間匯入或匯出資料的任務。您的 AWS 帳戶 必須擁有適當的信任政策和許可,才能為 Snow 裝置建立任務。如果您要為叢集中的節點建立任務,您只需提供 clusterId值;其他任務屬性會從叢集繼承。
注意
Snow Family 裝置及其容量。
-
裝置類型:V3_5C
-
容量:T32
-
描述:Snowball Edge Compute Optimized
-
-
裝置類型:V3_5S
-
容量:T240
-
描述:Snowball Edge 儲存最佳化 210TB
-
請求語法
{
"AddressId": "string",
"ClusterId": "string",
"Description": "string",
"DeviceConfiguration": {
"SnowconeDeviceConfiguration": {
"WirelessConnection": {
"IsWifiEnabled": boolean
}
}
},
"ForwardingAddressId": "string",
"ImpactLevel": "string",
"JobType": "string",
"KmsKeyARN": "string",
"LongTermPricingId": "string",
"Notification": {
"DevicePickupSnsTopicARN": "string",
"JobStatesToNotify": [ "string" ],
"NotifyAll": boolean,
"SnsTopicARN": "string"
},
"OnDeviceServiceConfiguration": {
"EKSOnDeviceService": {
"EKSAnywhereVersion": "string",
"KubernetesVersion": "string"
},
"NFSOnDeviceService": {
"StorageLimit": number,
"StorageUnit": "string"
},
"S3OnDeviceService": {
"FaultTolerance": number,
"ServiceSize": number,
"StorageLimit": number,
"StorageUnit": "string"
},
"TGWOnDeviceService": {
"StorageLimit": number,
"StorageUnit": "string"
}
},
"PickupDetails": {
"DevicePickupId": "string",
"Email": "string",
"IdentificationExpirationDate": number,
"IdentificationIssuingOrg": "string",
"IdentificationNumber": "string",
"Name": "string",
"PhoneNumber": "string"
},
"RemoteManagement": "string",
"Resources": {
"Ec2AmiResources": [
{
"AmiId": "string",
"SnowballAmiId": "string"
}
],
"LambdaResources": [
{
"EventTriggers": [
{
"EventResourceARN": "string"
}
],
"LambdaArn": "string"
}
],
"S3Resources": [
{
"BucketArn": "string",
"KeyRange": {
"BeginMarker": "string",
"EndMarker": "string"
},
"TargetOnDeviceServices": [
{
"ServiceName": "string",
"TransferOption": "string"
}
]
}
]
},
"RoleARN": "string",
"ShippingOption": "string",
"SnowballCapacityPreference": "string",
"SnowballType": "string",
"TaxDocuments": {
"IND": {
"GSTIN": "string"
}
}
}
請求參數
如需所有動作的一般參數資訊,請參閱《Common Parameters》。
請求接受採用 JSON 格式的下列資料。
- AddressId
-
您希望 Snow 裝置運送目的地之地址的 ID。
類型:字串
長度限制:固定長度為 40。
模式:
ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}必要:否
- ClusterId
-
叢集的 ID。如果您要為叢集中的節點建立任務,則只需要提供此
clusterId值。其他任務屬性會從叢集繼承。類型:字串
長度限制:固定長度為 39。
模式:
CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}必要:否
- Description
-
定義此特定任務的選用描述,例如
Important Photos 2016-08-11。類型:字串
長度限制:長度下限為 1。長度上限為 1024。
模式:
^[a-zA-Z0-9\s\-\_\.\:]+$必要:否
- DeviceConfiguration
-
定義 AWS Snowball Edge 任務的裝置組態。
如需有關 Snowball Edge 裝置類型的資訊,請參閱《Snowball Edge 開發人員指南》中的裝置硬體資訊。
類型:DeviceConfiguration 物件
必要:否
- ForwardingAddressId
-
您的區域不支援此欄位。
類型:字串
長度限制:固定長度為 40。
模式:
ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}必要:否
- ImpactLevel
-
將在裝置上儲存或處理的最高影響層級資料,在建立任務時提供。
類型:字串
有效值:
IL2 | IL4 | IL5 | IL6 | IL99必要:否
- JobType
-
定義您要建立的任務類型。
類型:字串
有效值:
IMPORT | EXPORT | LOCAL_USE必要:否
- KmsKeyARN
-
KmsKeyARN您要與此任務建立關聯的 。KmsKeyARN是使用 CreateKey AWS Key Management Service (KMS) API 動作建立的。類型:字串
長度限制:長度上限為 255。
模式:
arn:aws.*:kms:.*:[0-9]{12}:key/.*必要:否
- LongTermPricingId
-
裝置長期定價類型的 ID。
類型:字串
長度限制:固定長度為 41。
模式:
LTPID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}必要:否
- Notification
-
定義此任務的 Amazon Simple Notification Service (Amazon SNS) 通知設定。
類型:Notification 物件
必要:否
- OnDeviceServiceConfiguration
-
指定 Snow Family 裝置上的 服務或 服務,您的傳輸資料將從其中匯出或匯入至其中。 AWS Snow Family 支援 Amazon S3 和 NFS (網路檔案系統)。
類型:OnDeviceServiceConfiguration 物件
必要:否
- PickupDetails
-
識別收取裝置之人員的資訊。
類型:PickupDetails 物件
必要:否
- RemoteManagement
-
可讓您從內部網路外部安全地從遠端操作和管理 Snowcone 裝置。設定為 時
INSTALLED_AUTOSTART,當裝置到達您的位置時,將會自動提供遠端管理。否則,您需要使用 Snowball Edge 用戶端來管理裝置。設定為 時NOT_INSTALLED,遠端管理將無法在裝置上使用。類型:字串
有效值:
INSTALLED_ONLY | INSTALLED_AUTOSTART | NOT_INSTALLED必要:否
- Resources
-
定義與此任務相關聯的 Amazon S3 儲存貯體。
使用
IMPORT任務,您可以指定要匯入傳輸資料的儲存貯體或儲存貯體。使用
EXPORT任務,您可以指定要從中匯出傳輸資料的儲存貯體或儲存貯體。您也可以選擇性地指定KeyRange值。如果您選擇匯出範圍,您可以透過提供包含BeginMarker值、包含EndMarker值或兩者來定義範圍的長度。範圍是依 UTF-8 二進位排序。類型:JobResource 物件
必要:否
- RoleARN
-
RoleARN您要與此任務建立關聯的 。RoleArn會使用 CreateRole AWS Identity and Access Management (IAM) API 動作建立。類型:字串
長度限制:長度上限為 255。
模式:
arn:aws.*:iam::[0-9]{12}:role/.*必要:否
- ShippingOption
-
此任務的運送速度。此速度不會決定您會多快取得 Snow 裝置,而是代表 Snow 裝置在傳輸時移動到目的地的速度。區域運送速度如下:
-
在澳洲,您可以存取快速運送。一般而言,Snow 裝置運送快遞大約會在一天內送達。
-
在歐盟 (EU),您可以存取快速運送。一般而言,Snow 裝置運送快遞大約會在一天內送達。此外,歐盟內的大部分國家採用標準運送方式,通常不需一週即可送達。
-
在印度,Snow 裝置會在一到七天內交付。
-
在美國,您可以使用 1 天運送和 2 天運送。
類型:字串
有效值:
SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD必要:否
-
- SnowballCapacityPreference
-
如果您的任務是在其中一個美國區域建立,您可以選擇指定此任務所需的 Snow 裝置大小。在所有其他區域中,Snowball 隨附 80 TB 的儲存容量。
如需有關 Snowball Edge 裝置類型的資訊,請參閱《Snowball Edge 開發人員指南》中的裝置硬體資訊。
類型:字串
有效值:
T50 | T80 | T100 | T42 | T98 | T8 | T14 | T32 | NoPreference | T240 | T13必要:否
- SnowballType
-
用於此任務的 Snow Family 裝置類型。
注意
對於叢集任務, AWS Snowball Edge 目前僅支援
EDGE裝置類型。用於此任務的 AWS Snow 裝置類型。目前,叢集任務唯一支援的裝置類型為
EDGE。如需詳細資訊,請參閱《Snowball Edge 開發人員指南》中的裝置硬體資訊。
類型:字串
有效值:
STANDARD | EDGE | EDGE_C | EDGE_CG | EDGE_S | SNC1_HDD | SNC1_SSD | V3_5C | V3_5S | RACK_5U_C必要:否
- TaxDocuments
-
您的 中所需的稅務文件 AWS 區域。
類型:TaxDocuments 物件
必要:否
回應語法
{
"JobId": "string"
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- JobId
-
自動產生的任務 ID,例如
JID123e4567-e89b-12d3-a456-426655440000。類型:字串
長度限制:固定長度為 39。
模式:
(M|J)ID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- ClusterLimitExceededException
-
任務建立失敗。目前,叢集支援五個節點。如果您的叢集節點少於五個,而且要為此叢集建立更多節點,請再試一次並建立任務,直到叢集剛好有五個節點為止。
HTTP 狀態碼:400
- Ec2RequestFailedException
-
您的使用者缺少執行嘗試動作所需的 Amazon EC2 許可。
HTTP 狀態碼:400
- InvalidInputCombinationException
-
任務或叢集建立失敗。一或多個輸入無效。確認 CreateCluster:SnowballType 值支援您的 CreateJob:JobType,然後再試一次。
HTTP 狀態碼:400
- InvalidResourceException
-
找不到指定的資源。請檢查您在上次請求中提供的資訊,然後再試一次。
- ResourceType
-
提供的資源值無效。
HTTP 狀態碼:400
- KMSRequestFailedException
-
提供的 AWS Key Management Service 金鑰缺少執行指定 CreateJob或 UpdateJob動作的許可。
HTTP 狀態碼:400
另請參閱
如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊,請參閱下列內容: