Class: Aws::Snowball::Types::CreateJobRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-snowball/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#address_id ⇒ String

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

Returns:

  • (String) 


754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_id ⇒ String

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.

Returns:

  • (String) 


754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

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

Returns:

  • (String) 


754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end

#device_configuration ⇒ Types::DeviceConfiguration

Defines the device configuration for an Snowcone job.

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

Returns:



754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end

#forwarding_address_id ⇒ String

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

Returns:

  • (String) 


754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end

#impact_level ⇒ String

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

Returns:

  • (String) 


754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end

#job_type ⇒ String

Defines the type of job that you’re creating.

Returns:

  • (String) 


754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ String

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

[1]: docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html

Returns:

  • (String) 


754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end

#long_term_pricing_id ⇒ String

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

Returns:

  • (String) 


754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end

#notification ⇒ Types::Notification

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

Returns:



754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end

#on_device_service_configuration ⇒ Types::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.

Returns:



754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end

#pickup_details ⇒ Types::PickupDetails

Information identifying the person picking up the device.

Returns:



754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end

#remote_management ⇒ String

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.

Returns:

  • (String) 


754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end

#resources ⇒ Types::JobResource

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.

Returns:



754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The ‘RoleARN` that you want to associate with this job. `RoleArn`s are created using the [CreateRole] Identity and Access Management (IAM) API action.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html

Returns:

  • (String) 


754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end

#shipping_option ⇒ String

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.

Returns:

  • (String) 


754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end

#snowball_capacity_preference ⇒ String

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 “docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the *Snowcone User Guide* or “docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the *Snowcone User Guide*.

Returns:

  • (String) 


754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end

#snowball_type ⇒ String

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

<note markdown=“1”> For cluster jobs, Amazon Web Services Snow Family currently supports only the ‘EDGE` device type.

</note>

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 “docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the *Snowcone User Guide* or “docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the *Snowcone User Guide*.

[1]: docs.aws.amazon.com/snowball/latest/developer-guide/device-differences.html

Returns:

  • (String) 


754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end

#tax_documents ⇒ Types::TaxDocuments

The tax documents required in your Amazon Web Services Region.

Returns:



754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-snowball/types.rb', line 754

class CreateJobRequest < Struct.new(
  :job_type,
  :resources,
  :on_device_service_configuration,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_capacity_preference,
  :shipping_option,
  :notification,
  :cluster_id,
  :snowball_type,
  :forwarding_address_id,
  :tax_documents,
  :device_configuration,
  :remote_management,
  :long_term_pricing_id,
  :impact_level,
  :pickup_details)
  SENSITIVE = []
  include Aws::Structure
end