CreateJob - AWS Snowball
请求语法请求参数响应语法响应元素错误另请参阅

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

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。

  • 设备类型：标准

    • 容量：T50

    • 描述：原装 Snowball 设备

      注意

      此设备仅在宁夏、北京和新加坡上市 AWS 区域

  • 设备类型：标准

    • 容量：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。长度上限为 1024。

模式：.*

必需：否

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 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 设备将在一到七天内送达。

  • 在美国，您可以享受次日达和隔日达。

类型：字符串

有效值：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 系列设备类型。

注意

对于集群作业，Sno AWS w Family 目前仅支持该EDGE设备类型。

用于此任务的 Sno AWS w 设备类型。目前，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

作业创建失败。当前，集群支持五个节点。如果您的集群的节点少于五个，并且要为此集群创建更多节点，请重试并创建作业，直到您的集群恰好有五个节点。

HTTP 状态代码：400

Ec2RequestFailedException

您的用户缺乏执行尝试操作所必需的 Amazon EC2 权限。

HTTP 状态代码：400

InvalidInputCombinationException

作业或集群创建失败。一个或多个输入无效。确认CreateCluster:SnowballType值支持您的CreateJob:JobType，然后重试。

HTTP 状态代码：400

InvalidResourceException

找不到指定的资源。请查看您在上次请求中提供的信息，然后重试。

HTTP 状态代码：400

KMSRequestFailedException

提供的 AWS Key Management Service 密钥缺少执行指定CreateJob或UpdateJob操作的权限。

HTTP 状态代码：400

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：