NAME

Paws::Snowball::CreateJob - Arguments for method CreateJob on Paws::Snowball

DESCRIPTION

This class represents the parameters used for calling the method CreateJob on the Amazon Import/Export Snowball service. Use the attributes of this class as arguments to method CreateJob.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateJob.

SYNOPSIS

   my $snowball = Paws->service('Snowball');
# To create a job
# 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.
   my $CreateJobResult = $snowball->CreateJob(
     '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' => {
       'JobStatesToNotify' => [

       ],
       'NotifyAll' => 0
     },
     'Resources' => {
       'S3Resources' => [

         {
           'BucketArn' => 'arn:aws:s3:::MyBucket',
           'KeyRange'  => {

           }
         }
       ]
     },
     'RoleARN' => 'arn:aws:iam::123456789012:role/snowball-import-S3-role',
     'ShippingOption'             => 'SECOND_DAY',
     'SnowballCapacityPreference' => 'T80',
     'SnowballType'               => 'STANDARD'
   );

   # Results:
   my $JobId = $CreateJobResult->JobId;

   # Returns a L<Paws::Snowball::CreateJobResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/snowball/CreateJob

ATTRIBUTES

AddressId => Str

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

ClusterId => Str

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 => Str

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

DeviceConfiguration => Paws::Snowball::DeviceConfiguration

Defines the device configuration for an AWS 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 => Str

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

JobType => Str

Defines the type of job that you're creating.

Valid values are: "IMPORT", "EXPORT", "LOCAL_USE"

KmsKeyARN => Str

The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) AWS Key Management Service (KMS) API action.

LongTermPricingId => Str

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

Notification => Paws::Snowball::Notification

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

OnDeviceServiceConfiguration => Paws::Snowball::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).

RemoteManagement => Str

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.

Valid values are: "INSTALLED_ONLY", "INSTALLED_AUTOSTART"

Resources => Paws::Snowball::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.

RoleARN => Str

The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) AWS Identity and Access Management (IAM) API action.

ShippingOption => Str

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.

Valid values are: "SECOND_DAY", "NEXT_DAY", "EXPRESS", "STANDARD"

SnowballCapacityPreference => Str

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.

Valid values are: "T50", "T80", "T100", "T42", "T98", "T8", "T14", "NoPreference"

SnowballType => Str

The type of AWS Snow Family device to use for this job.

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 (https://docs.aws.amazon.com/snowball/latest/developer-guide/device-differences.html) 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.

Valid values are: "STANDARD", "EDGE", "EDGE_C", "EDGE_CG", "EDGE_S", "SNC1_HDD", "SNC1_SSD"

TaxDocuments => Paws::Snowball::TaxDocuments

The tax documents required in your AWS Region.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateJob in Paws::Snowball

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues