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 です。

パターン: 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(AWS KMS)のCreateKey API アクションによって作成されました。

型: 文字列

長さの制限：最大長は 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 ファミリーデバイス上のサービス (複数可) を指定します。AWSSnow ファミリーのデバイスクラスターは 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(IAM)のCreateRole API アクションによって作成されました。

型: 文字列

長さの制限：最大長は 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 ファミリーは現在、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"
      }
   ]
}

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが 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

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• 「AWS コマンドラインインターフェイス」

• 「AWS SDK for .NET」

• 「AWS SDK for C++」

• 「AWS SDK for Go」

• 「AWS SDK for Java V2」

• AWS SDK for JavaScript V3

• 「AWS SDK for PHP V3」

• 「AWS SDK for Python」

• AWS SDK for Ruby V3