翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
CreateCluster
空のクラスターを作成します。各クラスターは 5 つのノードをサポートしています。これらのノードごとにジョブを作成するために、個別に CreateJob アクションを実行します。クラスターは、これらの 5 つのノードジョブが作成されるまで出荷されません。
リクエストの構文
{
"AddressId": "string",
"Description": "string",
"ForceCreateJobs": boolean,
"ForwardingAddressId": "string",
"InitialClusterSize": number,
"JobType": "string",
"KmsKeyARN": "string",
"LongTermPricingIds": [ "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"
}
},
"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
-
クラスターの送付先住所の ID。
型: 文字列
長さの制限: 固定長は 40 です。
Pattern:
ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}必須：はい
- Description
-
この特定のクラスターの説明（任意）。たとえば
Environmental Data Cluster-01など。型: 文字列
長さの制限: 最小長は 1 です。最大長は 1,024 です。
パターン:
.*必須: いいえ
- ForceCreateJobs
-
ユーザーがクラスターをオーバープロビジョニングまたはアンダープロビジョニングしようとしたときに、クラスターを強制的に作成します。クラスターの初期サイズが、
OnDeviceServiceConfigurationで指定された容量要件を満たすために必要なサイズよりも大きい (オーバープロビジョニング) か、小さい (アンダープロビジョニング) 場合、クラスターはオーバープロビジョニングまたはアンダープロビジョニングされます。型: ブール値
必須：いいえ
- ForwardingAddressId
-
このフィールドは、お住まいのリージョンではサポートされていません。
型: 文字列
長さの制限: 固定長は 40 です。
パターン:
ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}必須: いいえ
- InitialClusterSize
-
指定した場合、各ジョブは自動的に作成され、新しいクラスターに関連付けられます。指定しない場合は 0 として扱われます。
型: 整数
有効な範囲: 最小値 は 0 です。最大値は 16 です。
必須：いいえ
- JobType
-
このクラスターのジョブのタイプ。現在、クラスターでサポートされているジョブタイプは、
LOCAL_USEのみです。Snow ファミリーデバイスの種類については、Snowcone ユーザーガイドのSnow ファミリーのデバイスと容量またはSnowball Edge ユーザーガイドのSnow ファミリーのデバイスと容量を参照してください。
型: 文字列
有効な値:
IMPORT | EXPORT | LOCAL_USE必須：はい
- KmsKeyARN
-
このクラスターに関連付ける
KmsKeyARN値。KmsKeyARN値は AWS Key Management Service () の CreateKeyAPIアクションを使用して作成されますAWS KMS。型: 文字列
長さの制限：最大長は 255 です。
パターン:
arn:aws.*:kms:.*:[0-9]{12}:key/.*必須: いいえ
- LongTermPricingIds
-
新しいクラスター用に自動的に作成されたジョブに関連付けるために使用される長期価格 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 オブジェクト
必須：いいえ
- RemoteManagement
-
クラスター内の Snow デバイスを内部ネットワークの外部からリモートで安全に運用および管理できます。
INSTALLED_AUTOSTARTに設定した場合では、デバイスがお客様の場所に到着すると、リモート管理が自動的に利用できるようになります。それ以外の場合は、Snowball Client を使用してデバイスを管理する必要があります。型: 文字列
有効な値:
INSTALLED_ONLY | INSTALLED_AUTOSTART | NOT_INSTALLED必須：いいえ
- Resources
-
クラスタージョブに関連付けられているリソース。これらのリソースには、Amazon S3 バケットと Python 言語で記述されたオプションの AWS Lambda 関数が含まれます。
型: JobResource オブジェクト
必須：いいえ
- RoleARN
-
このクラスター
RoleARNに関連付ける 。RoleArn値は AWS Identity and Access Management () の CreateRoleAPIアクションを使用して作成されますIAM。型: 文字列
長さの制限：最大長は 255 です。
パターン:
arn:aws.*:iam::[0-9]{12}:role/.*必須: いいえ
- ShippingOption
-
このクラスターの各ノードの配送速度。この速度は、各 Snowball Edge デバイスをどれくらい早く入手できるかではなく、転送中に各デバイスが目的地に移動する速さを表します。リージョンの配送速度は次のとおりです。
-
オーストラリアでは、至急便を利用できます。通常、至急便で発送された Snow デバイスは約 1 日で配送されます。
-
欧州連合 (EU) では、至急便を利用できます。通常、至急便で発送された Snow デバイスは約 1 日で配送されます。また、EU のほとんどの国で通常便も利用できます。こちらは通常片道 1 週間以内です。
-
インドでは、Snow デバイスが 1～7 日で配送されます。
-
アメリカ合衆国 (米国) では、翌日配送と翌々日配送を利用できます。
-
オーストラリアでは、至急便を利用できます。通常、至急便で発送されたデバイスは約 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デバイスタイプのみをサポートしています。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 オブジェクト
必須: いいえ
レスポンスの構文
{
"ClusterId": "string",
"JobListEntries": [
{
"CreationDate": number,
"Description": "string",
"IsMaster": boolean,
"JobId": "string",
"JobState": "string",
"JobType": "string",
"SnowballType": "string"
}
]
}レスポンス要素
アクションが成功すると、サービスは 200 HTTP レスポンスを送り返します。
次のデータは、 サービスによって JSON 形式で返されます。
- ClusterId
-
クラスター用に自動生成された ID です。
型: 文字列
長さの制限: 固定長は 39 です。
パターン:
CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12} - JobListEntries
-
このクラスター用に作成されたジョブのリスト。構文については、このガイドのListJobsResult「$JobListEntries
」を参照してください。 型: JobListEntry オブジェクトの配列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- 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
以下の資料も参照してください。
言語固有の のいずれかAPIでこれを使用する方法の詳細については AWS SDKs、以下を参照してください。
