Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

CreateJobRequest

import type { CreateJobRequest } from "https://aws-api.deno.dev/v0.3/services/snowball.ts?docs=full";
interface CreateJobRequest {
AddressId?: string | null;
ClusterId?: string | null;
Description?: string | null;
DeviceConfiguration?: DeviceConfiguration | null;
ForwardingAddressId?: string | null;
JobType?: JobType | null;
KmsKeyARN?: string | null;
LongTermPricingId?: string | null;
Notification?: Notification | null;
OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration | null;
RemoteManagement?: RemoteManagement | null;
Resources?: JobResource | null;
RoleARN?: string | null;
ShippingOption?: ShippingOption | null;
SnowballCapacityPreference?: SnowballCapacity | null;
SnowballType?: SnowballType | null;
TaxDocuments?: TaxDocuments | null;
}

§Properties

§
AddressId?: string | null
[src]

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

§
ClusterId?: string | null
[src]

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.

§
Description?: string | null
[src]

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

§
DeviceConfiguration?: DeviceConfiguration | null
[src]

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.

§
ForwardingAddressId?: string | null
[src]

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

§
JobType?: JobType | null
[src]

Defines the type of job that you're creating.

§
KmsKeyARN?: string | null
[src]

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

§
LongTermPricingId?: string | null
[src]

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

§
Notification?: Notification | null
[src]

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

§
OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration | null
[src]

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.

§
RemoteManagement?: RemoteManagement | null
[src]

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 Client to manage the device.

§
Resources?: JobResource | null
[src]

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.

§
RoleARN?: string | null
[src]

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

§
ShippingOption?: ShippingOption | null
[src]

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.
§
SnowballCapacityPreference?: SnowballCapacity | null
[src]

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.

§
SnowballType?: SnowballType | null
[src]

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

Note: 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.

§
TaxDocuments?: TaxDocuments | null
[src]

The tax documents required in your Amazon Web Services Region.