AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateJob operation. Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web Services 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.

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

The device capacity is optional.

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

Snow Family devices and their capacities.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Snowball.AmazonSnowballRequest
      Amazon.Snowball.Model.CreateJobRequest

Namespace: Amazon.Snowball.Model
Assembly: AWSSDK.Snowball.dll
Version: 3.x.y.z

Syntax

C#
public class CreateJobRequest : AmazonSnowballRequest
         IAmazonWebServiceRequest

The CreateJobRequest type exposes the following members

Constructors

NameDescription
Public Method CreateJobRequest()

Properties

NameTypeDescription
Public Property AddressId System.String

Gets and sets the property AddressId.

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

Public Property ClusterId System.String

Gets and sets the property 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.

Public Property Description System.String

Gets and sets the property Description.

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

Public Property DeviceConfiguration Amazon.Snowball.Model.DeviceConfiguration

Gets and sets the property DeviceConfiguration.

Defines the device configuration for an Snowcone job.

For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

Public Property ForwardingAddressId System.String

Gets and sets the property ForwardingAddressId.

The forwarding address ID for a job. This field is not supported in most Regions.

Public Property ImpactLevel Amazon.Snowball.ImpactLevel

Gets and sets the property ImpactLevel.

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

Public Property JobType Amazon.Snowball.JobType

Gets and sets the property JobType.

Defines the type of job that you're creating.

Public Property KmsKeyARN System.String

Gets and sets the property KmsKeyARN.

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

Public Property LongTermPricingId System.String

Gets and sets the property LongTermPricingId.

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

Public Property Notification Amazon.Snowball.Model.Notification

Gets and sets the property Notification.

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

Public Property OnDeviceServiceConfiguration Amazon.Snowball.Model.OnDeviceServiceConfiguration

Gets and sets the property OnDeviceServiceConfiguration.

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

Public Property PickupDetails Amazon.Snowball.Model.PickupDetails

Gets and sets the property PickupDetails.

Information identifying the person picking up the device.

Public Property RemoteManagement Amazon.Snowball.RemoteManagement

Gets and sets the property 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.

Public Property Resources Amazon.Snowball.Model.JobResource

Gets and sets the property 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.

Public Property RoleARN System.String

Gets and sets the property RoleARN.

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

Public Property ShippingOption Amazon.Snowball.ShippingOption

Gets and sets the property 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.

Public Property SnowballCapacityPreference Amazon.Snowball.SnowballCapacity

Gets and sets the property 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 more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

Public Property SnowballType Amazon.Snowball.SnowballType

Gets and sets the property SnowballType.

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

For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.

The type of Amazon Web Services 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 more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

Public Property TaxDocuments Amazon.Snowball.Model.TaxDocuments

Gets and sets the property TaxDocuments.

The tax documents required in your Amazon Web Services Region.

Examples

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 Snowball. 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.

To create a job


var client = new AmazonSnowballClient();
var response = client.CreateJob(new CreateJobRequest 
{
    AddressId = "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
    Description = "My Job",
    JobType = "IMPORT",
    KmsKeyARN = "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456",
    Notification = new Notification {
        JobStatesToNotify = new List<string> {
                        
        },
        NotifyAll = false
    },
    Resources = new JobResource { S3Resources = new List<S3Resource> {
        new S3Resource {
            BucketArn = "arn:aws:s3:::MyBucket",
            KeyRange = new KeyRange {  }
        }
    } },
    RoleARN = "arn:aws:iam::123456789012:role/snowball-import-S3-role",
    ShippingOption = "SECOND_DAY",
    SnowballCapacityPreference = "T80",
    SnowballType = "STANDARD"
});

string jobId = response.JobId;

            

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5