CreateJob
Amazon S3 とオンプレミスデータセンターとの間でデータをインポートまたはエクスポートするためのジョブを作成します。Snow デバイスのジョブを作成するには、AWS アカウント に適切な信頼ポリシーと許可が設定されている必要があります。クラスター内のノードのジョブを作成する場合は、clusterId
値を指定するだけです。その他のジョブ属性は、クラスターから継承されます。
注記
クラスター化されたジョブを注文する場合は、Snowball; Edge デバイスタイプのみがサポートされます。
デバイスの容量は任意です。
デバイスタイプの可用性は、AWS リージョン によって異なります。各リージョンでご利用いただけるサービスの詳細については、AWS リージョン別のサービス
Snow ファミリーのデバイスとその容量。
-
デバイスタイプ: SNC1_SSD
-
容量: T14
-
説明: Snowcone
-
-
デバイスタイプ: SNC1_HDD
-
容量: T8
-
説明: Snowcone
-
-
デバイスタイプ: EDGE_S
-
容量: T98
-
説明: Snowball Edge Storage Optimized (データ転送用)
-
-
デバイスタイプ: EDGE_CG
-
容量: T42
-
説明: Snowball Edge Compute Optimized(GPU搭載)
-
-
デバイスタイプ: EDGE_C
-
容量: T42
-
説明: Snowball Edge Compute Optimized(GPU非搭載)
-
-
デバイスタイプ: EDGE
-
容量: T100
-
説明: Snowball Edge Storage Optimized (EC2 コンピューティング機能搭載)
注記
このデバイスは T98 に置き換えられました。
-
-
デバイスタイプ: STANDARD
-
容量: T50
-
説明: 元の Snowball デバイス
注記
このデバイスは、寧夏回族自治区、北京、シンガポールでのみご利用いただけます AWS リージョン
-
-
デバイスタイプ: STANDARD
-
容量: T80
-
説明: 元の Snowball デバイス
注記
このデバイスは、寧夏回族自治区、北京、シンガポールでのみご利用いただけます AWS リージョン。
-
-
Snow ファミリーのデバイスタイプ: RACK_5U_C
-
容量: T13
-
説明: Snowblade。
-
-
デバイスタイプ: V3_5S
-
容量: T240
-
説明: Snowball Edge Storage Optimized 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
"
}
}
}
リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の 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 です。最大長は 1,024 です。
パターン:
.*
必須: いいえ
- DeviceConfiguration
-
AWS Snowcone ジョブのデバイス設定を定義します。
Snow ファミリーデバイスの種類については、Snowcone ユーザーガイドのSnow ファミリーのデバイスと容量またはSnowball Edge ユーザーガイドのSnow ファミリーのデバイスと容量を参照してください。
型: 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 ファミリーデバイス上のサービス (複数可) を指定します。AWSSnow ファミリーは Amazon S3 と NFS (ネットワークファイルシステム) と AWS Storage Gateway サービスのテープゲートウェイタイプをサポートしています。
型: 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 デバイスは約 1 日で配送されます。
-
欧州連合 (EU) では、至急便を利用できます。通常、至急便で発送された Snow デバイスは約 1 日で配送されます。また、EU のほとんどの国で通常便も利用できます。こちらは通常片道 1 週間以内です。
-
インドでは、Snow デバイスが 1~7 日で配送されます。
-
米国では、翌日配送と 翌々日配送を利用できます。
型: 文字列
有効な値:
SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD
必須:いいえ
-
- SnowballCapacityPreference
-
米国リージョンのいずれかでジョブを作成する場合は、このジョブに必要な Snow デバイスのサイズを指定できます。他のすべての地域では、Snowball のストレージ容量は 80 TB です。
Snow ファミリーデバイスの種類については、Snowcone ユーザーガイドのSnow ファミリーのデバイスと容量またはSnowball Edge ユーザーガイドのSnow ファミリーのデバイスと容量を参照してください。
型: 文字列
有効な値:
T50 | T80 | T100 | T42 | T98 | T8 | T14 | T32 | NoPreference | T240 | T13
必須:いいえ
- SnowballType
-
このジョブに使用する Snow ファミリーデバイスのタイプ。
注記
クラスタージョブの場合、AWS Snow Familyは現在、
EDGE
デバイスタイプのみをサポートしています。このジョブに使用する AWS Snowデバイスのタイプ。現在、クラスタージョブでサポートされているデバイスタイプは
EDGE
のみです。詳細については、Snowball Edge デベロッパーガイドの「Snowball Edge デバイスオプション」を参照してください。
Snow ファミリーデバイスの種類については、Snowcone ユーザーガイドのSnow ファミリーのデバイスと容量またはSnowball Edge ユーザーガイドのSnow ファミリーのデバイスと容量を参照してください。
型: 文字列
有効な値:
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
-
ジョブ作成に失敗しました。現在、クラスターは 5 つのノードをサポートしています。クラスターのノードが 5 つ未満で、このクラスター用に作成するノードの数がそれより多い場合は、クラスターのノードがちょうど 5 つになるまでジョブを作成し直してください。
HTTP ステータスコード:400
- Ec2RequestFailedException
-
ユーザーには、試行されたアクションを実行するために必要な Amazon EC2 アクセス許可がありません。
HTTP ステータスコード:400
- InvalidInputCombinationException
-
ジョブまたはクラスターの作成に失敗しました。1 つ以上の入力が無効です。CreateCluster:SnowballType 値がCreateJob:JobTypeをサポートしていることを確認し、再度お試しください。
HTTP ステータスコード:400
- InvalidResourceException
-
指定されたリソースが見つかりません。前回のリクエストで入力した情報をチェックし、もう一度お試しください。
HTTP ステータスコード:400
- KMSRequestFailedException
-
提供された AWS Key Management Service キーには、指定された CreateJob または UpdateJob アクションの実行許可がありません。
HTTP ステータスコード:400
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。