File Coverage

blib/lib/Paws/Snowball/CreateJob.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::Snowball::CreateJob;
3 1     1   439 use Moose;
  1         4  
  1         10  
4             has AddressId => (is => 'ro', isa => 'Str');
5             has ClusterId => (is => 'ro', isa => 'Str');
6             has Description => (is => 'ro', isa => 'Str');
7             has ForwardingAddressId => (is => 'ro', isa => 'Str');
8             has JobType => (is => 'ro', isa => 'Str');
9             has KmsKeyARN => (is => 'ro', isa => 'Str');
10             has Notification => (is => 'ro', isa => 'Paws::Snowball::Notification');
11             has Resources => (is => 'ro', isa => 'Paws::Snowball::JobResource');
12             has RoleARN => (is => 'ro', isa => 'Str');
13             has ShippingOption => (is => 'ro', isa => 'Str');
14             has SnowballCapacityPreference => (is => 'ro', isa => 'Str');
15             has SnowballType => (is => 'ro', isa => 'Str');
16              
17 1     1   6484 use MooseX::ClassAttribute;
  1         3  
  1         8  
18              
19             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateJob');
20             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Snowball::CreateJobResult');
21             class_has _result_key => (isa => 'Str', is => 'ro');
22             1;
23              
24             ### main pod documentation begin ###
25              
26             =head1 NAME
27              
28             Paws::Snowball::CreateJob - Arguments for method CreateJob on Paws::Snowball
29              
30             =head1 DESCRIPTION
31              
32             This class represents the parameters used for calling the method CreateJob on the
33             Amazon Import/Export Snowball service. Use the attributes of this class
34             as arguments to method CreateJob.
35              
36             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateJob.
37              
38             As an example:
39              
40             $service_obj->CreateJob(Att1 => $value1, Att2 => $value2, ...);
41              
42             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.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 AddressId => Str
48              
49             The ID for the address that you want the Snowball shipped to.
50              
51              
52              
53             =head2 ClusterId => Str
54              
55             The ID of a cluster. If you're creating a job for a node in a cluster,
56             you need to provide only this C<clusterId> value. The other job
57             attributes are inherited from the cluster.
58              
59              
60              
61             =head2 Description => Str
62              
63             Defines an optional description of this specific job, for example
64             C<Important Photos 2016-08-11>.
65              
66              
67              
68             =head2 ForwardingAddressId => Str
69              
70             The forwarding address ID for a job. This field is not supported in
71             most regions.
72              
73              
74              
75             =head2 JobType => Str
76              
77             Defines the type of job that you're creating.
78              
79             Valid values are: C<"IMPORT">, C<"EXPORT">, C<"LOCAL_USE">
80              
81             =head2 KmsKeyARN => Str
82              
83             The C<KmsKeyARN> that you want to associate with this job.
84             C<KmsKeyARN>s are created using the CreateKey AWS Key Management
85             Service (KMS) API action.
86              
87              
88              
89             =head2 Notification => L<Paws::Snowball::Notification>
90              
91             Defines the Amazon Simple Notification Service (Amazon SNS)
92             notification settings for this job.
93              
94              
95              
96             =head2 Resources => L<Paws::Snowball::JobResource>
97              
98             Defines the Amazon S3 buckets associated with this job.
99              
100             With C<IMPORT> jobs, you specify the bucket or buckets that your
101             transferred data will be imported into.
102              
103             With C<EXPORT> jobs, you specify the bucket or buckets that your
104             transferred data will be exported from. Optionally, you can also
105             specify a C<KeyRange> value. If you choose to export a range, you
106             define the length of the range by providing either an inclusive
107             C<BeginMarker> value, an inclusive C<EndMarker> value, or both. Ranges
108             are UTF-8 binary sorted.
109              
110              
111              
112             =head2 RoleARN => Str
113              
114             The C<RoleARN> that you want to associate with this job. C<RoleArn>s
115             are created using the CreateRole AWS Identity and Access Management
116             (IAM) API action.
117              
118              
119              
120             =head2 ShippingOption => Str
121              
122             The shipping speed for this job. This speed doesn't dictate how soon
123             you'll get the Snowball, rather it represents how quickly the Snowball
124             moves to its destination while in transit. Regional shipping speeds are
125             as follows:
126              
127             =over
128              
129             =item *
130              
131             In Australia, you have access to express shipping. Typically, Snowballs
132             shipped express are delivered in about a day.
133              
134             =item *
135              
136             In the European Union (EU), you have access to express shipping.
137             Typically, Snowballs shipped express are delivered in about a day. In
138             addition, most countries in the EU have access to standard shipping,
139             which typically takes less than a week, one way.
140              
141             =item *
142              
143             In India, Snowballs are delivered in one to seven days.
144              
145             =item *
146              
147             In the US, you have access to one-day shipping and two-day shipping.
148              
149             =back
150              
151              
152             Valid values are: C<"SECOND_DAY">, C<"NEXT_DAY">, C<"EXPRESS">, C<"STANDARD">
153              
154             =head2 SnowballCapacityPreference => Str
155              
156             If your job is being created in one of the US regions, you have the
157             option of specifying what size Snowball you'd like for this job. In all
158             other regions, Snowballs come with 80 TB in storage capacity.
159              
160             Valid values are: C<"T50">, C<"T80">, C<"T100">, C<"NoPreference">
161              
162             =head2 SnowballType => Str
163              
164             The type of AWS Snowball appliance to use for this job. Currently, the
165             only supported appliance type for cluster jobs is C<EDGE>.
166              
167             Valid values are: C<"STANDARD">, C<"EDGE">
168              
169              
170             =head1 SEE ALSO
171              
172             This class forms part of L<Paws>, documenting arguments for method CreateJob in L<Paws::Snowball>
173              
174             =head1 BUGS and CONTRIBUTIONS
175              
176             The source code is located here: https://github.com/pplu/aws-sdk-perl
177              
178             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
179              
180             =cut
181