CreateJob - AWS Snowball
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

CreateJob

Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.

Note

Only the Snowball; Edge device type is supported when ordering clustered jobs.

The device capacity is optional.

Availability of device types differ by AWS Region. For more information about Region availability, see AWS Regional Services.

Snow Family devices and their capacities.

  • Device type: SNC1_SSD

    • Capacity: T14

    • Description: Snowcone

  • Device type: SNC1_HDD

    • Capacity: T8

    • Description: Snowcone

  • Device type: EDGE_S

    • Capacity: T98

    • Description: Snowball Edge Storage Optimized for data transfer only

  • Device type: EDGE_CG

    • Capacity: T42

    • Description: Snowball Edge Compute Optimized with GPU

  • Device type: EDGE_C

    • Capacity: T42

    • Description: Snowball Edge Compute Optimized without GPU

  • Device type: EDGE

    • Capacity: T100

    • Description: Snowball Edge Storage Optimized with EC2 Compute

    Note

    This device is replaced with T98.

  • Device type: STANDARD

    • Capacity: T50

    • Description: Original Snowball device

      Note

      This device is only available in the Ningxia, Beijing, and Singapore AWS Region

  • Device type: STANDARD

    • Capacity: T80

    • Description: Original Snowball device

      Note

      This device is only available in the Ningxia, Beijing, and Singapore AWS Region.

  • Snow Family device type: RACK_5U_C

    • Capacity: T13

    • Description: Snowblade.

  • Device type: V3_5S

    • Capacity: T240

    • Description: Snowball Edge Storage Optimized 210TB

Request Syntax

{
   "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"
      }
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AddressId

The ID for the address that you want the Snow device shipped to.

Type: String

Length Constraints: Fixed length of 40.

Pattern: ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No

ClusterId

The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.

Type: String

Length Constraints: Fixed length of 39.

Pattern: CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No

Description

Defines an optional description of this specific job, for example Important Photos 2016-08-11.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^[a-zA-Z0-9\s\-\_\.\:]+$

Required: No

DeviceConfiguration

Defines the device configuration for an AWS Snowcone job.

For information about Snow Family device types, see Snow Family Devices and Capacity in the Snowcone User Guide or Snow Family Devices and Capacity in the Snowball Edge User Guide.

Type: DeviceConfiguration object

Required: No

ForwardingAddressId

This field is not supported in your Region.

Type: String

Length Constraints: Fixed length of 40.

Pattern: ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No

ImpactLevel

The highest impact level of data that will be stored or processed on the device, provided at job creation.

Type: String

Valid Values: IL2 | IL4 | IL5 | IL6 | IL99

Required: No

JobType

Defines the type of job that you're creating.

Type: String

Valid Values: IMPORT | EXPORT | LOCAL_USE

Required: No

KmsKeyARN

The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action.

Type: String

Length Constraints: Maximum length of 255.

Pattern: arn:aws.*:kms:.*:[0-9]{12}:key/.*

Required: No

LongTermPricingId

The ID of the long-term pricing type for the device.

Type: String

Length Constraints: Fixed length of 41.

Pattern: LTPID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No

Notification

Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.

Type: Notification object

Required: No

OnDeviceServiceConfiguration

Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System) and the AWS Storage Gateway service Tape Gateway type.

Type: OnDeviceServiceConfiguration object

Required: No

PickupDetails

Information identifying the person picking up the device.

Type: PickupDetails object

Required: No

RemoteManagement

Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Edge client to manage the device. When set to NOT_INSTALLED, remote management will not be available on the device.

Type: String

Valid Values: INSTALLED_ONLY | INSTALLED_AUTOSTART | NOT_INSTALLED

Required: No

Resources

Defines the Amazon S3 buckets associated with this job.

With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into.

With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.

Type: JobResource object

Required: No

RoleARN

The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action.

Type: String

Length Constraints: Maximum length of 255.

Pattern: arn:aws.*:iam::[0-9]{12}:role/.*

Required: No

ShippingOption

The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snow device, rather it represents how quickly the Snow device moves to its destination while in transit. Regional shipping speeds are as follows:

  • In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.

  • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

  • In India, Snow devices are delivered in one to seven days.

  • In the US, you have access to one-day shipping and two-day shipping.

Type: String

Valid Values: SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD

Required: No

SnowballCapacityPreference

If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

For information about Snow Family device types, see Snow Family Devices and Capacity in the Snowcone User Guide or Snow Family Devices and Capacity in the Snowball Edge User Guide.

Type: String

Valid Values: T50 | T80 | T100 | T42 | T98 | T8 | T14 | T32 | NoPreference | T240 | T13

Required: No

SnowballType

The type of Snow Family devices to use for this job.

Note

For cluster jobs, AWS Snow Family currently supports only the EDGE device type.

The type of AWS Snow device to use for this job. Currently, the only supported device type for cluster jobs is EDGE.

For more information, see Snowball Edge Device Options in the Snowball Edge Developer Guide.

For information about Snow Family device types, see Snow Family Devices and Capacity in the Snowcone User Guide or Snow Family Devices and Capacity in the Snowball Edge User Guide.

Type: String

Valid Values: STANDARD | EDGE | EDGE_C | EDGE_CG | EDGE_S | SNC1_HDD | SNC1_SSD | V3_5C | V3_5S | RACK_5U_C

Required: No

TaxDocuments

The tax documents required in your AWS Region.

Type: TaxDocuments object

Required: No

Response Syntax

{
   "JobId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

JobId

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Type: String

Length Constraints: Fixed length of 39.

Pattern: (M|J)ID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Errors

For information about the errors that are common to all actions, see Common Errors.

ClusterLimitExceededException

Job creation failed. Currently, clusters support five nodes. If you have fewer than five nodes for your cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster has exactly five nodes.

HTTP Status Code: 400

Ec2RequestFailedException

Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.

HTTP Status Code: 400

InvalidInputCombinationException

Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateCluster:SnowballType value supports your CreateJob:JobType, and try again.

HTTP Status Code: 400

InvalidResourceException

The specified resource can't be found. Check the information you provided in your last request, and try again.

HTTP Status Code: 400

KMSRequestFailedException

The provided AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: