blib/lib/Paws/Snowball.pm untested

filter: Statementstmt 0.0% 0 / 190 Branchbran 0.0% 0 / 20 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 37 Podpod 0.0% 0 / 36 totaltotal 0.0% 0 / 283 CC 11 SCAR 16.5
CC
11
Cov
0%
DescribeAllAddresses
12.0
ListAllClusterJobs
12.0
ListAllClusters
12.0
CRAP 5.2
1 package Paws::Snowball;
2 use Moose;
3 sub service { 'snowball' }
4 sub signing_name { 'snowball' }
5 sub version { '2016-06-30' }
6 sub target_prefix { 'AWSIESnowballJobManagementService' }
7 sub json_version { "1.1" }
8 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
9 has retry => (is => 'ro', isa => 'HashRef', default => sub {
10 { base => 'rand', type => 'exponential', growth_factor => 2 }
11 });
12 has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
13 ] });
14  
15 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller';
16  
17
18 sub CancelCluster {
19 my $self = shift;
20 my $call_object = $self->new_with_coercions('Paws::Snowball::CancelCluster', @_);
21 return $self->caller->do_call($self, $call_object);
22 }
23 sub CancelJob {
24 my $self = shift;
25 my $call_object = $self->new_with_coercions('Paws::Snowball::CancelJob', @_);
26 return $self->caller->do_call($self, $call_object);
27 }
28 sub CreateAddress {
29 my $self = shift;
30 my $call_object = $self->new_with_coercions('Paws::Snowball::CreateAddress', @_);
31 return $self->caller->do_call($self, $call_object);
32 }
33 sub CreateCluster {
34 my $self = shift;
35 my $call_object = $self->new_with_coercions('Paws::Snowball::CreateCluster', @_);
36 return $self->caller->do_call($self, $call_object);
37 }
38 sub CreateJob {
39 my $self = shift;
40 my $call_object = $self->new_with_coercions('Paws::Snowball::CreateJob', @_);
41 return $self->caller->do_call($self, $call_object);
42 }
43 sub CreateLongTermPricing {
44 my $self = shift;
45 my $call_object = $self->new_with_coercions('Paws::Snowball::CreateLongTermPricing', @_);
46 return $self->caller->do_call($self, $call_object);
47 }
48 sub CreateReturnShippingLabel {
49 my $self = shift;
50 my $call_object = $self->new_with_coercions('Paws::Snowball::CreateReturnShippingLabel', @_);
51 return $self->caller->do_call($self, $call_object);
52 }
53 sub DescribeAddress {
54 my $self = shift;
55 my $call_object = $self->new_with_coercions('Paws::Snowball::DescribeAddress', @_);
56 return $self->caller->do_call($self, $call_object);
57 }
58 sub DescribeAddresses {
59 my $self = shift;
60 my $call_object = $self->new_with_coercions('Paws::Snowball::DescribeAddresses', @_);
61 return $self->caller->do_call($self, $call_object);
62 }
63 sub DescribeCluster {
64 my $self = shift;
65 my $call_object = $self->new_with_coercions('Paws::Snowball::DescribeCluster', @_);
66 return $self->caller->do_call($self, $call_object);
67 }
68 sub DescribeJob {
69 my $self = shift;
70 my $call_object = $self->new_with_coercions('Paws::Snowball::DescribeJob', @_);
71 return $self->caller->do_call($self, $call_object);
72 }
73 sub DescribeReturnShippingLabel {
74 my $self = shift;
75 my $call_object = $self->new_with_coercions('Paws::Snowball::DescribeReturnShippingLabel', @_);
76 return $self->caller->do_call($self, $call_object);
77 }
78 sub GetJobManifest {
79 my $self = shift;
80 my $call_object = $self->new_with_coercions('Paws::Snowball::GetJobManifest', @_);
81 return $self->caller->do_call($self, $call_object);
82 }
83 sub GetJobUnlockCode {
84 my $self = shift;
85 my $call_object = $self->new_with_coercions('Paws::Snowball::GetJobUnlockCode', @_);
86 return $self->caller->do_call($self, $call_object);
87 }
88 sub GetSnowballUsage {
89 my $self = shift;
90 my $call_object = $self->new_with_coercions('Paws::Snowball::GetSnowballUsage', @_);
91 return $self->caller->do_call($self, $call_object);
92 }
93 sub GetSoftwareUpdates {
94 my $self = shift;
95 my $call_object = $self->new_with_coercions('Paws::Snowball::GetSoftwareUpdates', @_);
96 return $self->caller->do_call($self, $call_object);
97 }
98 sub ListClusterJobs {
99 my $self = shift;
100 my $call_object = $self->new_with_coercions('Paws::Snowball::ListClusterJobs', @_);
101 return $self->caller->do_call($self, $call_object);
102 }
103 sub ListClusters {
104 my $self = shift;
105 my $call_object = $self->new_with_coercions('Paws::Snowball::ListClusters', @_);
106 return $self->caller->do_call($self, $call_object);
107 }
108 sub ListCompatibleImages {
109 my $self = shift;
110 my $call_object = $self->new_with_coercions('Paws::Snowball::ListCompatibleImages', @_);
111 return $self->caller->do_call($self, $call_object);
112 }
113 sub ListJobs {
114 my $self = shift;
115 my $call_object = $self->new_with_coercions('Paws::Snowball::ListJobs', @_);
116 return $self->caller->do_call($self, $call_object);
117 }
118 sub ListLongTermPricing {
119 my $self = shift;
120 my $call_object = $self->new_with_coercions('Paws::Snowball::ListLongTermPricing', @_);
121 return $self->caller->do_call($self, $call_object);
122 }
123 sub UpdateCluster {
124 my $self = shift;
125 my $call_object = $self->new_with_coercions('Paws::Snowball::UpdateCluster', @_);
126 return $self->caller->do_call($self, $call_object);
127 }
128 sub UpdateJob {
129 my $self = shift;
130 my $call_object = $self->new_with_coercions('Paws::Snowball::UpdateJob', @_);
131 return $self->caller->do_call($self, $call_object);
132 }
133 sub UpdateJobShipmentState {
134 my $self = shift;
135 my $call_object = $self->new_with_coercions('Paws::Snowball::UpdateJobShipmentState', @_);
136 return $self->caller->do_call($self, $call_object);
137 }
138 sub UpdateLongTermPricing {
139 my $self = shift;
140 my $call_object = $self->new_with_coercions('Paws::Snowball::UpdateLongTermPricing', @_);
141 return $self->caller->do_call($self, $call_object);
142 }
143
144 sub DescribeAllAddresses {
145 my $self = shift;
146  
147 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
148 my $result = $self->DescribeAddresses(@_);
149 my $next_result = $result;
150  
151 if (not defined $callback) {
152 while ($next_result->NextToken) {
153 $next_result = $self->DescribeAddresses(@_, NextToken => $next_result->NextToken);
154 push @{ $result->Addresses }, @{ $next_result->Addresses };
155 }
156 return $result;
157 } else {
158 while ($result->NextToken) {
159 $callback->($_ => 'Addresses') foreach (@{ $result->Addresses });
160 $result = $self->DescribeAddresses(@_, NextToken => $result->NextToken);
161 }
162 $callback->($_ => 'Addresses') foreach (@{ $result->Addresses });
163 }
164  
165 return undef
166 }
167 sub ListAllClusterJobs {
168 my $self = shift;
169  
170 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
171 my $result = $self->ListClusterJobs(@_);
172 my $next_result = $result;
173  
174 if (not defined $callback) {
175 while ($next_result->NextToken) {
176 $next_result = $self->ListClusterJobs(@_, NextToken => $next_result->NextToken);
177 push @{ $result->JobListEntries }, @{ $next_result->JobListEntries };
178 }
179 return $result;
180 } else {
181 while ($result->NextToken) {
182 $callback->($_ => 'JobListEntries') foreach (@{ $result->JobListEntries });
183 $result = $self->ListClusterJobs(@_, NextToken => $result->NextToken);
184 }
185 $callback->($_ => 'JobListEntries') foreach (@{ $result->JobListEntries });
186 }
187  
188 return undef
189 }
190 sub ListAllClusters {
191 my $self = shift;
192  
193 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
194 my $result = $self->ListClusters(@_);
195 my $next_result = $result;
196  
197 if (not defined $callback) {
198 while ($next_result->NextToken) {
199 $next_result = $self->ListClusters(@_, NextToken => $next_result->NextToken);
200 push @{ $result->ClusterListEntries }, @{ $next_result->ClusterListEntries };
201 }
202 return $result;
203 } else {
204 while ($result->NextToken) {
205 $callback->($_ => 'ClusterListEntries') foreach (@{ $result->ClusterListEntries });
206 $result = $self->ListClusters(@_, NextToken => $result->NextToken);
207 }
208 $callback->($_ => 'ClusterListEntries') foreach (@{ $result->ClusterListEntries });
209 }
210  
211 return undef
212 }
213 sub ListAllCompatibleImages {
214 my $self = shift;
215  
216 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
217 my $result = $self->ListCompatibleImages(@_);
218 my $next_result = $result;
219  
220 if (not defined $callback) {
221 while ($next_result->NextToken) {
222 $next_result = $self->ListCompatibleImages(@_, NextToken => $next_result->NextToken);
223 push @{ $result->CompatibleImages }, @{ $next_result->CompatibleImages };
224 }
225 return $result;
226 } else {
227 while ($result->NextToken) {
228 $callback->($_ => 'CompatibleImages') foreach (@{ $result->CompatibleImages });
229 $result = $self->ListCompatibleImages(@_, NextToken => $result->NextToken);
230 }
231 $callback->($_ => 'CompatibleImages') foreach (@{ $result->CompatibleImages });
232 }
233  
234 return undef
235 }
236 sub ListAllJobs {
237 my $self = shift;
238  
239 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
240 my $result = $self->ListJobs(@_);
241 my $next_result = $result;
242  
243 if (not defined $callback) {
244 while ($next_result->NextToken) {
245 $next_result = $self->ListJobs(@_, NextToken => $next_result->NextToken);
246 push @{ $result->JobListEntries }, @{ $next_result->JobListEntries };
247 }
248 return $result;
249 } else {
250 while ($result->NextToken) {
251 $callback->($_ => 'JobListEntries') foreach (@{ $result->JobListEntries });
252 $result = $self->ListJobs(@_, NextToken => $result->NextToken);
253 }
254 $callback->($_ => 'JobListEntries') foreach (@{ $result->JobListEntries });
255 }
256  
257 return undef
258 }
259  
260  
261 sub operations { qw/CancelCluster CancelJob CreateAddress CreateCluster CreateJob CreateLongTermPricing CreateReturnShippingLabel DescribeAddress DescribeAddresses DescribeCluster DescribeJob DescribeReturnShippingLabel GetJobManifest GetJobUnlockCode GetSnowballUsage GetSoftwareUpdates ListClusterJobs ListClusters ListCompatibleImages ListJobs ListLongTermPricing UpdateCluster UpdateJob UpdateJobShipmentState UpdateLongTermPricing / }
262  
263 1;
264  
265 ### main pod documentation begin ###
266  
267 =head1 NAME
268  
269 Paws::Snowball - Perl Interface to AWS Amazon Import/Export Snowball
270  
271 =head1 SYNOPSIS
272  
273 use Paws;
274  
275 my $obj = Paws->service('Snowball');
276 my $res = $obj->Method(
277 Arg1 => $val1,
278 Arg2 => [ 'V1', 'V2' ],
279 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
280 # of the arguments type
281 Arg3 => { Att1 => 'Val1' },
282 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
283 # the constructor of the arguments type
284 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
285 );
286  
287 =head1 DESCRIPTION
288  
289 AWS Snow Family is a petabyte-scale data transport solution that uses
290 secure devices to transfer large amounts of data between your
291 on-premises data centers and Amazon Simple Storage Service (Amazon S3).
292 The Snow commands described here provide access to the same
293 functionality that is available in the AWS Snow Family Management
294 Console, which enables you to create and manage jobs for a Snow device.
295 To transfer data locally with a Snow device, you'll need to use the
296 Snowball Edge client or the Amazon S3 API Interface for Snowball or AWS
297 OpsHub for Snow Family. For more information, see the User Guide
298 (https://docs.aws.amazon.com/AWSImportExport/latest/ug/api-reference.html).
299  
300 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30>
301  
302  
303 =head1 METHODS
304  
305 =head2 CancelCluster
306  
307 =over
308  
309 =item ClusterId => Str
310  
311  
312 =back
313  
314 Each argument is described in detail in: L<Paws::Snowball::CancelCluster>
315  
316 Returns: a L<Paws::Snowball::CancelClusterResult> instance
317  
318 Cancels a cluster job. You can only cancel a cluster job while it's in
319 the C<AwaitingQuorum> status. You'll have at least an hour after
320 creating a cluster job to cancel it.
321  
322  
323 =head2 CancelJob
324  
325 =over
326  
327 =item JobId => Str
328  
329  
330 =back
331  
332 Each argument is described in detail in: L<Paws::Snowball::CancelJob>
333  
334 Returns: a L<Paws::Snowball::CancelJobResult> instance
335  
336 Cancels the specified job. You can only cancel a job before its
337 C<JobState> value changes to C<PreparingAppliance>. Requesting the
338 C<ListJobs> or C<DescribeJob> action returns a job's C<JobState> as
339 part of the response element data returned.
340  
341  
342 =head2 CreateAddress
343  
344 =over
345  
346 =item Address => L<Paws::Snowball::Address>
347  
348  
349 =back
350  
351 Each argument is described in detail in: L<Paws::Snowball::CreateAddress>
352  
353 Returns: a L<Paws::Snowball::CreateAddressResult> instance
354  
355 Creates an address for a Snow device to be shipped to. In most regions,
356 addresses are validated at the time of creation. The address you
357 provide must be located within the serviceable area of your region. If
358 the address is invalid or unsupported, then an exception is thrown.
359  
360  
361 =head2 CreateCluster
362  
363 =over
364  
365 =item AddressId => Str
366  
367 =item JobType => Str
368  
369 =item Resources => L<Paws::Snowball::JobResource>
370  
371 =item RoleARN => Str
372  
373 =item ShippingOption => Str
374  
375 =item SnowballType => Str
376  
377 =item [Description => Str]
378  
379 =item [ForwardingAddressId => Str]
380  
381 =item [KmsKeyARN => Str]
382  
383 =item [Notification => L<Paws::Snowball::Notification>]
384  
385 =item [OnDeviceServiceConfiguration => L<Paws::Snowball::OnDeviceServiceConfiguration>]
386  
387 =item [RemoteManagement => Str]
388  
389 =item [TaxDocuments => L<Paws::Snowball::TaxDocuments>]
390  
391  
392 =back
393  
394 Each argument is described in detail in: L<Paws::Snowball::CreateCluster>
395  
396 Returns: a L<Paws::Snowball::CreateClusterResult> instance
397  
398 Creates an empty cluster. Each cluster supports five nodes. You use the
399 CreateJob action separately to create the jobs for each of these nodes.
400 The cluster does not ship until these five node jobs have been created.
401  
402  
403 =head2 CreateJob
404  
405 =over
406  
407 =item [AddressId => Str]
408  
409 =item [ClusterId => Str]
410  
411 =item [Description => Str]
412  
413 =item [DeviceConfiguration => L<Paws::Snowball::DeviceConfiguration>]
414  
415 =item [ForwardingAddressId => Str]
416  
417 =item [JobType => Str]
418  
419 =item [KmsKeyARN => Str]
420  
421 =item [LongTermPricingId => Str]
422  
423 =item [Notification => L<Paws::Snowball::Notification>]
424  
425 =item [OnDeviceServiceConfiguration => L<Paws::Snowball::OnDeviceServiceConfiguration>]
426  
427 =item [RemoteManagement => Str]
428  
429 =item [Resources => L<Paws::Snowball::JobResource>]
430  
431 =item [RoleARN => Str]
432  
433 =item [ShippingOption => Str]
434  
435 =item [SnowballCapacityPreference => Str]
436  
437 =item [SnowballType => Str]
438  
439 =item [TaxDocuments => L<Paws::Snowball::TaxDocuments>]
440  
441  
442 =back
443  
444 Each argument is described in detail in: L<Paws::Snowball::CreateJob>
445  
446 Returns: a L<Paws::Snowball::CreateJobResult> instance
447  
448 Creates a job to import or export data between Amazon S3 and your
449 on-premises data center. Your AWS account must have the right trust
450 policies and permissions in place to create a job for a Snow device. If
451 you're creating a job for a node in a cluster, you only need to provide
452 the C<clusterId> value; the other job attributes are inherited from the
453 cluster.
454  
455 Only the Snowball; Edge device type is supported when ordering
456 clustered jobs.
457  
458 The device capacity is optional.
459  
460 Availability of device types differ by AWS Region. For more information
461 about Region availability, see AWS Regional Services
462 (https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/?p=ngi&loc=4).
463  
464 B<AWS Snow Family device types and their capacities.>
465  
466 =over
467  
468 =item *
469  
470 Snow Family device type: B<SNC1_SSD>
471  
472 =over
473  
474 =item *
475  
476 Capacity: T14
477  
478 =item *
479  
480 Description: Snowcone
481  
482 =back
483  
484 =item *
485  
486 Snow Family device type: B<SNC1_HDD>
487  
488 =over
489  
490 =item *
491  
492 Capacity: T8
493  
494 =item *
495  
496 Description: Snowcone
497  
498 =back
499  
500 =item *
501  
502 Device type: B<EDGE_S>
503  
504 =over
505  
506 =item *
507  
508 Capacity: T98
509  
510 =item *
511  
512 Description: Snowball Edge Storage Optimized for data transfer only
513  
514 =back
515  
516 =item *
517  
518 Device type: B<EDGE_CG>
519  
520 =over
521  
522 =item *
523  
524 Capacity: T42
525  
526 =item *
527  
528 Description: Snowball Edge Compute Optimized with GPU
529  
530 =back
531  
532 =item *
533  
534 Device type: B<EDGE_C>
535  
536 =over
537  
538 =item *
539  
540 Capacity: T42
541  
542 =item *
543  
544 Description: Snowball Edge Compute Optimized without GPU
545  
546 =back
547  
548 =item *
549  
550 Device type: B<EDGE>
551  
552 =over
553  
554 =item *
555  
556 Capacity: T100
557  
558 =item *
559  
560 Description: Snowball Edge Storage Optimized with EC2 Compute
561  
562 =back
563  
564 =item *
565  
566 Device type: B<STANDARD>
567  
568 =over
569  
570 =item *
571  
572 Capacity: T50
573  
574 =item *
575  
576 Description: Original Snowball device
577  
578 This device is only available in the Ningxia, Beijing, and Singapore
579 AWS Regions.
580  
581 =back
582  
583 =item *
584  
585 Device type: B<STANDARD>
586  
587 =over
588  
589 =item *
590  
591 Capacity: T80
592  
593 =item *
594  
595 Description: Original Snowball device
596  
597 This device is only available in the Ningxia, Beijing, and Singapore
598 AWS Regions.
599  
600 =back
601  
602 =back
603  
604  
605  
606 =head2 CreateLongTermPricing
607  
608 =over
609  
610 =item LongTermPricingType => Str
611  
612 =item [IsLongTermPricingAutoRenew => Bool]
613  
614 =item [SnowballType => Str]
615  
616  
617 =back
618  
619 Each argument is described in detail in: L<Paws::Snowball::CreateLongTermPricing>
620  
621 Returns: a L<Paws::Snowball::CreateLongTermPricingResult> instance
622  
623 Creates a job with the long-term usage option for a device. The
624 long-term usage is a 1-year or 3-year long-term pricing type for the
625 device. You are billed upfront, and AWS provides discounts for
626 long-term pricing.
627  
628  
629 =head2 CreateReturnShippingLabel
630  
631 =over
632  
633 =item JobId => Str
634  
635 =item [ShippingOption => Str]
636  
637  
638 =back
639  
640 Each argument is described in detail in: L<Paws::Snowball::CreateReturnShippingLabel>
641  
642 Returns: a L<Paws::Snowball::CreateReturnShippingLabelResult> instance
643  
644 Creates a shipping label that will be used to return the Snow device to
645 AWS.
646  
647  
648 =head2 DescribeAddress
649  
650 =over
651  
652 =item AddressId => Str
653  
654  
655 =back
656  
657 Each argument is described in detail in: L<Paws::Snowball::DescribeAddress>
658  
659 Returns: a L<Paws::Snowball::DescribeAddressResult> instance
660  
661 Takes an C<AddressId> and returns specific details about that address
662 in the form of an C<Address> object.
663  
664  
665 =head2 DescribeAddresses
666  
667 =over
668  
669 =item [MaxResults => Int]
670  
671 =item [NextToken => Str]
672  
673  
674 =back
675  
676 Each argument is described in detail in: L<Paws::Snowball::DescribeAddresses>
677  
678 Returns: a L<Paws::Snowball::DescribeAddressesResult> instance
679  
680 Returns a specified number of C<ADDRESS> objects. Calling this API in
681 one of the US regions will return addresses from the list of all
682 addresses associated with this account in all US regions.
683  
684  
685 =head2 DescribeCluster
686  
687 =over
688  
689 =item ClusterId => Str
690  
691  
692 =back
693  
694 Each argument is described in detail in: L<Paws::Snowball::DescribeCluster>
695  
696 Returns: a L<Paws::Snowball::DescribeClusterResult> instance
697  
698 Returns information about a specific cluster including shipping
699 information, cluster status, and other important metadata.
700  
701  
702 =head2 DescribeJob
703  
704 =over
705  
706 =item JobId => Str
707  
708  
709 =back
710  
711 Each argument is described in detail in: L<Paws::Snowball::DescribeJob>
712  
713 Returns: a L<Paws::Snowball::DescribeJobResult> instance
714  
715 Returns information about a specific job including shipping
716 information, job status, and other important metadata.
717  
718  
719 =head2 DescribeReturnShippingLabel
720  
721 =over
722  
723 =item JobId => Str
724  
725  
726 =back
727  
728 Each argument is described in detail in: L<Paws::Snowball::DescribeReturnShippingLabel>
729  
730 Returns: a L<Paws::Snowball::DescribeReturnShippingLabelResult> instance
731  
732 Information on the shipping label of a Snow device that is being
733 returned to AWS.
734  
735  
736 =head2 GetJobManifest
737  
738 =over
739  
740 =item JobId => Str
741  
742  
743 =back
744  
745 Each argument is described in detail in: L<Paws::Snowball::GetJobManifest>
746  
747 Returns: a L<Paws::Snowball::GetJobManifestResult> instance
748  
749 Returns a link to an Amazon S3 presigned URL for the manifest file
750 associated with the specified C<JobId> value. You can access the
751 manifest file for up to 60 minutes after this request has been made. To
752 access the manifest file after 60 minutes have passed, you'll have to
753 make another call to the C<GetJobManifest> action.
754  
755 The manifest is an encrypted file that you can download after your job
756 enters the C<WithCustomer> status. The manifest is decrypted by using
757 the C<UnlockCode> code value, when you pass both values to the Snow
758 device through the Snowball client when the client is started for the
759 first time.
760  
761 As a best practice, we recommend that you don't save a copy of an
762 C<UnlockCode> value in the same location as the manifest file for that
763 job. Saving these separately helps prevent unauthorized parties from
764 gaining access to the Snow device associated with that job.
765  
766 The credentials of a given job, including its manifest file and unlock
767 code, expire 360 days after the job is created.
768  
769  
770 =head2 GetJobUnlockCode
771  
772 =over
773  
774 =item JobId => Str
775  
776  
777 =back
778  
779 Each argument is described in detail in: L<Paws::Snowball::GetJobUnlockCode>
780  
781 Returns: a L<Paws::Snowball::GetJobUnlockCodeResult> instance
782  
783 Returns the C<UnlockCode> code value for the specified job. A
784 particular C<UnlockCode> value can be accessed for up to 360 days after
785 the associated job has been created.
786  
787 The C<UnlockCode> value is a 29-character code with 25 alphanumeric
788 characters and 4 hyphens. This code is used to decrypt the manifest
789 file when it is passed along with the manifest to the Snow device
790 through the Snowball client when the client is started for the first
791 time.
792  
793 As a best practice, we recommend that you don't save a copy of the
794 C<UnlockCode> in the same location as the manifest file for that job.
795 Saving these separately helps prevent unauthorized parties from gaining
796 access to the Snow device associated with that job.
797  
798  
799 =head2 GetSnowballUsage
800  
801  
802  
803  
804  
805  
806 Each argument is described in detail in: L<Paws::Snowball::GetSnowballUsage>
807  
808 Returns: a L<Paws::Snowball::GetSnowballUsageResult> instance
809  
810 Returns information about the Snow Family service limit for your
811 account, and also the number of Snow devices your account has in use.
812  
813 The default service limit for the number of Snow devices that you can
814 have at one time is 1. If you want to increase your service limit,
815 contact AWS Support.
816  
817  
818 =head2 GetSoftwareUpdates
819  
820 =over
821  
822 =item JobId => Str
823  
824  
825 =back
826  
827 Each argument is described in detail in: L<Paws::Snowball::GetSoftwareUpdates>
828  
829 Returns: a L<Paws::Snowball::GetSoftwareUpdatesResult> instance
830  
831 Returns an Amazon S3 presigned URL for an update file associated with a
832 specified C<JobId>.
833  
834  
835 =head2 ListClusterJobs
836  
837 =over
838  
839 =item ClusterId => Str
840  
841 =item [MaxResults => Int]
842  
843 =item [NextToken => Str]
844  
845  
846 =back
847  
848 Each argument is described in detail in: L<Paws::Snowball::ListClusterJobs>
849  
850 Returns: a L<Paws::Snowball::ListClusterJobsResult> instance
851  
852 Returns an array of C<JobListEntry> objects of the specified length.
853 Each C<JobListEntry> object is for a job in the specified cluster and
854 contains a job's state, a job's ID, and other information.
855  
856  
857 =head2 ListClusters
858  
859 =over
860  
861 =item [MaxResults => Int]
862  
863 =item [NextToken => Str]
864  
865  
866 =back
867  
868 Each argument is described in detail in: L<Paws::Snowball::ListClusters>
869  
870 Returns: a L<Paws::Snowball::ListClustersResult> instance
871  
872 Returns an array of C<ClusterListEntry> objects of the specified
873 length. Each C<ClusterListEntry> object contains a cluster's state, a
874 cluster's ID, and other important status information.
875  
876  
877 =head2 ListCompatibleImages
878  
879 =over
880  
881 =item [MaxResults => Int]
882  
883 =item [NextToken => Str]
884  
885  
886 =back
887  
888 Each argument is described in detail in: L<Paws::Snowball::ListCompatibleImages>
889  
890 Returns: a L<Paws::Snowball::ListCompatibleImagesResult> instance
891  
892 This action returns a list of the different Amazon EC2 Amazon Machine
893 Images (AMIs) that are owned by your AWS account that would be
894 supported for use on a Snow device. Currently, supported AMIs are based
895 on the CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server 14.04 LTS
896 (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the AWS
897 Marketplace.
898  
899  
900 =head2 ListJobs
901  
902 =over
903  
904 =item [MaxResults => Int]
905  
906 =item [NextToken => Str]
907  
908  
909 =back
910  
911 Each argument is described in detail in: L<Paws::Snowball::ListJobs>
912  
913 Returns: a L<Paws::Snowball::ListJobsResult> instance
914  
915 Returns an array of C<JobListEntry> objects of the specified length.
916 Each C<JobListEntry> object contains a job's state, a job's ID, and a
917 value that indicates whether the job is a job part, in the case of
918 export jobs. Calling this API action in one of the US regions will
919 return jobs from the list of all jobs associated with this account in
920 all US regions.
921  
922  
923 =head2 ListLongTermPricing
924  
925 =over
926  
927 =item [MaxResults => Int]
928  
929 =item [NextToken => Str]
930  
931  
932 =back
933  
934 Each argument is described in detail in: L<Paws::Snowball::ListLongTermPricing>
935  
936 Returns: a L<Paws::Snowball::ListLongTermPricingResult> instance
937  
938 Lists all long-term pricing types.
939  
940  
941 =head2 UpdateCluster
942  
943 =over
944  
945 =item ClusterId => Str
946  
947 =item [AddressId => Str]
948  
949 =item [Description => Str]
950  
951 =item [ForwardingAddressId => Str]
952  
953 =item [Notification => L<Paws::Snowball::Notification>]
954  
955 =item [OnDeviceServiceConfiguration => L<Paws::Snowball::OnDeviceServiceConfiguration>]
956  
957 =item [Resources => L<Paws::Snowball::JobResource>]
958  
959 =item [RoleARN => Str]
960  
961 =item [ShippingOption => Str]
962  
963  
964 =back
965  
966 Each argument is described in detail in: L<Paws::Snowball::UpdateCluster>
967  
968 Returns: a L<Paws::Snowball::UpdateClusterResult> instance
969  
970 While a cluster's C<ClusterState> value is in the C<AwaitingQuorum>
971 state, you can update some of the information associated with a
972 cluster. Once the cluster changes to a different job state, usually 60
973 minutes after the cluster being created, this action is no longer
974 available.
975  
976  
977 =head2 UpdateJob
978  
979 =over
980  
981 =item JobId => Str
982  
983 =item [AddressId => Str]
984  
985 =item [Description => Str]
986  
987 =item [ForwardingAddressId => Str]
988  
989 =item [Notification => L<Paws::Snowball::Notification>]
990  
991 =item [OnDeviceServiceConfiguration => L<Paws::Snowball::OnDeviceServiceConfiguration>]
992  
993 =item [Resources => L<Paws::Snowball::JobResource>]
994  
995 =item [RoleARN => Str]
996  
997 =item [ShippingOption => Str]
998  
999 =item [SnowballCapacityPreference => Str]
1000  
1001  
1002 =back
1003  
1004 Each argument is described in detail in: L<Paws::Snowball::UpdateJob>
1005  
1006 Returns: a L<Paws::Snowball::UpdateJobResult> instance
1007  
1008 While a job's C<JobState> value is C<New>, you can update some of the
1009 information associated with a job. Once the job changes to a different
1010 job state, usually within 60 minutes of the job being created, this
1011 action is no longer available.
1012  
1013  
1014 =head2 UpdateJobShipmentState
1015  
1016 =over
1017  
1018 =item JobId => Str
1019  
1020 =item ShipmentState => Str
1021  
1022  
1023 =back
1024  
1025 Each argument is described in detail in: L<Paws::Snowball::UpdateJobShipmentState>
1026  
1027 Returns: a L<Paws::Snowball::UpdateJobShipmentStateResult> instance
1028  
1029 Updates the state when a shipment state changes to a different state.
1030  
1031  
1032 =head2 UpdateLongTermPricing
1033  
1034 =over
1035  
1036 =item LongTermPricingId => Str
1037  
1038 =item [IsLongTermPricingAutoRenew => Bool]
1039  
1040 =item [ReplacementJob => Str]
1041  
1042  
1043 =back
1044  
1045 Each argument is described in detail in: L<Paws::Snowball::UpdateLongTermPricing>
1046  
1047 Returns: a L<Paws::Snowball::UpdateLongTermPricingResult> instance
1048  
1049 Updates the long-term pricing type.
1050  
1051  
1052  
1053  
1054 =head1 PAGINATORS
1055  
1056 Paginator methods are helpers that repetively call methods that return partial results
1057  
1058 =head2 DescribeAllAddresses(sub { },[MaxResults => Int, NextToken => Str])
1059  
1060 =head2 DescribeAllAddresses([MaxResults => Int, NextToken => Str])
1061  
1062  
1063 If passed a sub as first parameter, it will call the sub for each element found in :
1064  
1065 - Addresses, passing the object as the first parameter, and the string 'Addresses' as the second parameter
1066  
1067 If not, it will return a a L<Paws::Snowball::DescribeAddressesResult> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1068  
1069  
1070 =head2 ListAllClusterJobs(sub { },ClusterId => Str, [MaxResults => Int, NextToken => Str])
1071  
1072 =head2 ListAllClusterJobs(ClusterId => Str, [MaxResults => Int, NextToken => Str])
1073  
1074  
1075 If passed a sub as first parameter, it will call the sub for each element found in :
1076  
1077 - JobListEntries, passing the object as the first parameter, and the string 'JobListEntries' as the second parameter
1078  
1079 If not, it will return a a L<Paws::Snowball::ListClusterJobsResult> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1080  
1081  
1082 =head2 ListAllClusters(sub { },[MaxResults => Int, NextToken => Str])
1083  
1084 =head2 ListAllClusters([MaxResults => Int, NextToken => Str])
1085  
1086  
1087 If passed a sub as first parameter, it will call the sub for each element found in :
1088  
1089 - ClusterListEntries, passing the object as the first parameter, and the string 'ClusterListEntries' as the second parameter
1090  
1091 If not, it will return a a L<Paws::Snowball::ListClustersResult> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1092  
1093  
1094 =head2 ListAllCompatibleImages(sub { },[MaxResults => Int, NextToken => Str])
1095  
1096 =head2 ListAllCompatibleImages([MaxResults => Int, NextToken => Str])
1097  
1098  
1099 If passed a sub as first parameter, it will call the sub for each element found in :
1100  
1101 - CompatibleImages, passing the object as the first parameter, and the string 'CompatibleImages' as the second parameter
1102  
1103 If not, it will return a a L<Paws::Snowball::ListCompatibleImagesResult> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1104  
1105  
1106 =head2 ListAllJobs(sub { },[MaxResults => Int, NextToken => Str])
1107  
1108 =head2 ListAllJobs([MaxResults => Int, NextToken => Str])
1109  
1110  
1111 If passed a sub as first parameter, it will call the sub for each element found in :
1112  
1113 - JobListEntries, passing the object as the first parameter, and the string 'JobListEntries' as the second parameter
1114  
1115 If not, it will return a a L<Paws::Snowball::ListJobsResult> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1116  
1117  
1118  
1119  
1120  
1121 =head1 SEE ALSO
1122  
1123 This service class forms part of L<Paws>
1124  
1125 =head1 BUGS and CONTRIBUTIONS
1126  
1127 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
1128  
1129 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
1130  
1131 =cut
1132