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

Inherits:

Struct

Object
Struct
Aws::Snowball::Types::CreateJobRequest

show all

Defined in:: gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb

Overview

Note:

When making an API call, you may pass CreateJobRequest data as a hash:

{
  job_type: "IMPORT", # accepts IMPORT, EXPORT, LOCAL_USE
  resources: {
    s3_resources: [
      {
        bucket_arn: "ResourceARN",
        key_range: {
          begin_marker: "String",
          end_marker: "String",
        },
        target_on_device_services: [
          {
            service_name: "NFS_ON_DEVICE_SERVICE", # accepts NFS_ON_DEVICE_SERVICE, S3_ON_DEVICE_SERVICE
            transfer_option: "IMPORT", # accepts IMPORT, EXPORT, LOCAL_USE
          },
        ],
      },
    ],
    lambda_resources: [
      {
        lambda_arn: "ResourceARN",
        event_triggers: [
          {
            event_resource_arn: "ResourceARN",
          },
        ],
      },
    ],
    ec2_ami_resources: [
      {
        ami_id: "AmiId", # required
        snowball_ami_id: "String",
      },
    ],
  },
  on_device_service_configuration: {
    nfs_on_device_service: {
      storage_limit: 1,
      storage_unit: "TB", # accepts TB
    },
    tgw_on_device_service: {
      storage_limit: 1,
      storage_unit: "TB", # accepts TB
    },
  },
  description: "String",
  address_id: "AddressId",
  kms_key_arn: "KmsKeyARN",
  role_arn: "RoleARN",
  snowball_capacity_preference: "T50", # accepts T50, T80, T100, T42, T98, T8, T14, NoPreference
  shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
  notification: {
    sns_topic_arn: "SnsTopicARN",
    job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWSSortingFacility, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
    notify_all: false,
  },
  cluster_id: "ClusterId",
  snowball_type: "STANDARD", # accepts STANDARD, EDGE, EDGE_C, EDGE_CG, EDGE_S, SNC1_HDD, SNC1_SSD
  forwarding_address_id: "AddressId",
  tax_documents: {
    ind: {
      gstin: "GSTIN",
    },
  },
  device_configuration: {
    snowcone_device_configuration: {
      wireless_connection: {
        is_wifi_enabled: false,
      },
    },
  },
  remote_management: "INSTALLED_ONLY", # accepts INSTALLED_ONLY, INSTALLED_AUTOSTART
  long_term_pricing_id: "LongTermPricingId",
}

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#address_id ⇒ String
The ID for the address that you want the Snow device shipped to.
#cluster_id ⇒ String
The ID of a cluster.
#description ⇒ String
Defines an optional description of this specific job, for example Important Photos 2016-08-11.
#device_configuration ⇒ Types::DeviceConfiguration
Defines the device configuration for an Snowcone job.
#forwarding_address_id ⇒ String
The forwarding address ID for a job.
#job_type ⇒ String
Defines the type of job that you're creating.
#kms_key_arn ⇒ String
The KmsKeyARN that you want to associate with this job.
#long_term_pricing_id ⇒ String
The ID of the long-term pricing type for the device.
#notification ⇒ Types::Notification
Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.
#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.
#remote_management ⇒ String
Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network.
#resources ⇒ Types::JobResource
Defines the Amazon S3 buckets associated with this job.
#role_arn ⇒ String
The RoleARN that you want to associate with this job.
#shipping_option ⇒ String
The shipping speed for this job.
#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.
#snowball_type ⇒ String
The type of Snow Family Devices to use for this job.
#tax_documents ⇒ Types::TaxDocuments
The tax documents required in your Amazon Web Services Region.

Instance Attribute Details

#address_id ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 894

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)
  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)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 894

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)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 894

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)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(Types::DeviceConfiguration)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 894

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)
  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)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 894

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)
  SENSITIVE = []
  include Aws::Structure
end

#job_type ⇒ `String`

Defines the type of job that you're creating.

Returns:

(String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 894

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)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 894

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)
  SENSITIVE = []
  include Aws::Structure
end

#long_term_pricing_id ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 894

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)
  SENSITIVE = []
  include Aws::Structure
end

#notification ⇒ `Types::Notification`

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

Returns:

(Types::Notification)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 894

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)
  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:

(Types::OnDeviceServiceConfiguration)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 894

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

Returns:

(String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 894

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)
  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:

(Types::JobResource)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 894

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)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 894

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)
  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)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 894

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

Returns:

(String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 894

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)
  SENSITIVE = []
  include Aws::Structure
end

#snowball_type ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 894

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)
  SENSITIVE = []
  include Aws::Structure
end

#tax_documents ⇒ `Types::TaxDocuments`

The tax documents required in your Amazon Web Services Region.

Returns:

(Types::TaxDocuments)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 894

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)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#address_id ⇒ String

#cluster_id ⇒ String

#description ⇒ String

#device_configuration ⇒ Types::DeviceConfiguration

#forwarding_address_id ⇒ String

#job_type ⇒ String

#kms_key_arn ⇒ String

#long_term_pricing_id ⇒ String

#notification ⇒ Types::Notification

#on_device_service_configuration ⇒ Types::OnDeviceServiceConfiguration

#remote_management ⇒ String

#resources ⇒ Types::JobResource

#role_arn ⇒ String

#shipping_option ⇒ String

#snowball_capacity_preference ⇒ String

#snowball_type ⇒ String

#tax_documents ⇒ Types::TaxDocuments

#address_id ⇒ `String`

#cluster_id ⇒ `String`

#description ⇒ `String`

#device_configuration ⇒ `Types::DeviceConfiguration`

#forwarding_address_id ⇒ `String`

#job_type ⇒ `String`

#kms_key_arn ⇒ `String`

#long_term_pricing_id ⇒ `String`

#notification ⇒ `Types::Notification`

#on_device_service_configuration ⇒ `Types::OnDeviceServiceConfiguration`

#remote_management ⇒ `String`

#resources ⇒ `Types::JobResource`

#role_arn ⇒ `String`

#shipping_option ⇒ `String`

#snowball_capacity_preference ⇒ `String`

#snowball_type ⇒ `String`

#tax_documents ⇒ `Types::TaxDocuments`