blib/lib/Paws/Forecast/CreateDatasetImportJob.pm untested

filter: Statementstmt 0.0% 0 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 19 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Forecast::CreateDatasetImportJob;
3 use Moose;
4 has DatasetArn => (is => 'ro', isa => 'Str', required => 1);
5 has DatasetImportJobName => (is => 'ro', isa => 'Str', required => 1);
6 has DataSource => (is => 'ro', isa => 'Paws::Forecast::DataSource', required => 1);
7 has GeolocationFormat => (is => 'ro', isa => 'Str');
8 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Forecast::Tag]');
9 has TimestampFormat => (is => 'ro', isa => 'Str');
10 has TimeZone => (is => 'ro', isa => 'Str');
11 has UseGeolocationForTimeZone => (is => 'ro', isa => 'Bool');
12  
13 use MooseX::ClassAttribute;
14  
15 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDatasetImportJob');
16 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Forecast::CreateDatasetImportJobResponse');
17 class_has _result_key => (isa => 'Str', is => 'ro');
18 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::Forecast::CreateDatasetImportJob - Arguments for method CreateDatasetImportJob on L<Paws::Forecast>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method CreateDatasetImportJob on the
29 L<Amazon Forecast Service|Paws::Forecast> service. Use the attributes of this class
30 as arguments to method CreateDatasetImportJob.
31  
32 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDatasetImportJob.
33  
34 =head1 SYNOPSIS
35  
36 my $forecast = Paws->service('Forecast');
37 my $CreateDatasetImportJobResponse = $forecast->CreateDatasetImportJob(
38 DataSource => {
39 S3Config => {
40 Path => 'MyS3Path',
41 RoleArn => 'MyArn', # max: 256
42 KMSKeyArn => 'MyKMSKeyArn', # max: 256; OPTIONAL
43 },
44  
45 },
46 DatasetArn => 'MyArn',
47 DatasetImportJobName => 'MyName',
48 GeolocationFormat => 'MyGeolocationFormat', # OPTIONAL
49 Tags => [
50 {
51 Key => 'MyTagKey', # min: 1, max: 128
52 Value => 'MyTagValue', # max: 256
53  
54 },
55 ...
56 ], # OPTIONAL
57 TimeZone => 'MyTimeZone', # OPTIONAL
58 TimestampFormat => 'MyTimestampFormat', # OPTIONAL
59 UseGeolocationForTimeZone => 1, # OPTIONAL
60 );
61  
62 # Results:
63 my $DatasetImportJobArn =
64 $CreateDatasetImportJobResponse->DatasetImportJobArn;
65  
66 # Returns a L<Paws::Forecast::CreateDatasetImportJobResponse> object.
67  
68 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.
69 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/forecast/CreateDatasetImportJob>
70  
71 =head1 ATTRIBUTES
72  
73  
74 =head2 B<REQUIRED> DatasetArn => Str
75  
76 The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you
77 want to import data to.
78  
79  
80  
81 =head2 B<REQUIRED> DatasetImportJobName => Str
82  
83 The name for the dataset import job. We recommend including the current
84 timestamp in the name, for example, C<20190721DatasetImport>. This can
85 help you avoid getting a C<ResourceAlreadyExistsException> exception.
86  
87  
88  
89 =head2 B<REQUIRED> DataSource => L<Paws::Forecast::DataSource>
90  
91 The location of the training data to import and an AWS Identity and
92 Access Management (IAM) role that Amazon Forecast can assume to access
93 the data. The training data must be stored in an Amazon S3 bucket.
94  
95 If encryption is used, C<DataSource> must include an AWS Key Management
96 Service (KMS) key and the IAM role must allow Amazon Forecast
97 permission to access the key. The KMS key and IAM role must match those
98 specified in the C<EncryptionConfig> parameter of the CreateDataset
99 operation.
100  
101  
102  
103 =head2 GeolocationFormat => Str
104  
105 The format of the geolocation attribute. The geolocation attribute can
106 be formatted in one of two ways:
107  
108 =over
109  
110 =item *
111  
112 C<LAT_LONG> - the latitude and longitude in decimal format (Example:
113 47.61_-122.33).
114  
115 =item *
116  
117 C<CC_POSTALCODE> (US Only) - the country code (US), followed by the
118 5-digit ZIP code (Example: US_98121).
119  
120 =back
121  
122  
123  
124  
125 =head2 Tags => ArrayRef[L<Paws::Forecast::Tag>]
126  
127 The optional metadata that you apply to the dataset import job to help
128 you categorize and organize them. Each tag consists of a key and an
129 optional value, both of which you define.
130  
131 The following basic restrictions apply to tags:
132  
133 =over
134  
135 =item *
136  
137 Maximum number of tags per resource - 50.
138  
139 =item *
140  
141 For each resource, each tag key must be unique, and each tag key can
142 have only one value.
143  
144 =item *
145  
146 Maximum key length - 128 Unicode characters in UTF-8.
147  
148 =item *
149  
150 Maximum value length - 256 Unicode characters in UTF-8.
151  
152 =item *
153  
154 If your tagging schema is used across multiple services and resources,
155 remember that other services may have restrictions on allowed
156 characters. Generally allowed characters are: letters, numbers, and
157 spaces representable in UTF-8, and the following characters: + - = . _
158 : / @.
159  
160 =item *
161  
162 Tag keys and values are case sensitive.
163  
164 =item *
165  
166 Do not use C<aws:>, C<AWS:>, or any upper or lowercase combination of
167 such as a prefix for keys as it is reserved for AWS use. You cannot
168 edit or delete tag keys with this prefix. Values can have this prefix.
169 If a tag value has C<aws> as its prefix but the key does not, then
170 Forecast considers it to be a user tag and will count against the limit
171 of 50 tags. Tags with only the key prefix of C<aws> do not count
172 against your tags per resource limit.
173  
174 =back
175  
176  
177  
178  
179 =head2 TimestampFormat => Str
180  
181 The format of timestamps in the dataset. The format that you specify
182 depends on the C<DataFrequency> specified when the dataset was created.
183 The following formats are supported
184  
185 =over
186  
187 =item *
188  
189 "yyyy-MM-dd"
190  
191 For the following data frequencies: Y, M, W, and D
192  
193 =item *
194  
195 "yyyy-MM-dd HH:mm:ss"
196  
197 For the following data frequencies: H, 30min, 15min, and 1min; and
198 optionally, for: Y, M, W, and D
199  
200 =back
201  
202 If the format isn't specified, Amazon Forecast expects the format to be
203 "yyyy-MM-dd HH:mm:ss".
204  
205  
206  
207 =head2 TimeZone => Str
208  
209 A single time zone for every item in your dataset. This option is ideal
210 for datasets with all timestamps within a single time zone, or if all
211 timestamps are normalized to a single time zone.
212  
213 Refer to the Joda-Time API
214 (http://joda-time.sourceforge.net/timezones.html) for a complete list
215 of valid time zone names.
216  
217  
218  
219 =head2 UseGeolocationForTimeZone => Bool
220  
221 Automatically derive time zone information from the geolocation
222 attribute. This option is ideal for datasets that contain timestamps in
223 multiple time zones and those timestamps are expressed in local time.
224  
225  
226  
227  
228 =head1 SEE ALSO
229  
230 This class forms part of L<Paws>, documenting arguments for method CreateDatasetImportJob in L<Paws::Forecast>
231  
232 =head1 BUGS and CONTRIBUTIONS
233  
234 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
235  
236 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
237  
238 =cut
239