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

filter: Statementstmt 0.0% 0 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 18 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Forecast::CreateDataset;
3 use Moose;
4 has DataFrequency => (is => 'ro', isa => 'Str');
5 has DatasetName => (is => 'ro', isa => 'Str', required => 1);
6 has DatasetType => (is => 'ro', isa => 'Str', required => 1);
7 has Domain => (is => 'ro', isa => 'Str', required => 1);
8 has EncryptionConfig => (is => 'ro', isa => 'Paws::Forecast::EncryptionConfig');
9 has Schema => (is => 'ro', isa => 'Paws::Forecast::Schema', required => 1);
10 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Forecast::Tag]');
11  
12 use MooseX::ClassAttribute;
13  
14 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDataset');
15 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Forecast::CreateDatasetResponse');
16 class_has _result_key => (isa => 'Str', is => 'ro');
17 1;
18  
19 ### main pod documentation begin ###
20  
21 =head1 NAME
22  
23 Paws::Forecast::CreateDataset - Arguments for method CreateDataset on L<Paws::Forecast>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method CreateDataset on the
28 L<Amazon Forecast Service|Paws::Forecast> service. Use the attributes of this class
29 as arguments to method CreateDataset.
30  
31 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDataset.
32  
33 =head1 SYNOPSIS
34  
35 my $forecast = Paws->service('Forecast');
36 my $CreateDatasetResponse = $forecast->CreateDataset(
37 DatasetName => 'MyName',
38 DatasetType => 'TARGET_TIME_SERIES',
39 Domain => 'RETAIL',
40 Schema => {
41 Attributes => [
42 {
43 AttributeName => 'MyName', # min: 1, max: 63
44 AttributeType => 'string'
45 , # values: string, integer, float, timestamp, geolocation; OPTIONAL
46 },
47 ...
48 ], # min: 1, max: 100; OPTIONAL
49 },
50 DataFrequency => 'MyFrequency', # OPTIONAL
51 EncryptionConfig => {
52 KMSKeyArn => 'MyKMSKeyArn', # max: 256
53 RoleArn => 'MyArn', # max: 256
54  
55 }, # OPTIONAL
56 Tags => [
57 {
58 Key => 'MyTagKey', # min: 1, max: 128
59 Value => 'MyTagValue', # max: 256
60  
61 },
62 ...
63 ], # OPTIONAL
64 );
65  
66 # Results:
67 my $DatasetArn = $CreateDatasetResponse->DatasetArn;
68  
69 # Returns a L<Paws::Forecast::CreateDatasetResponse> object.
70  
71 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.
72 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/forecast/CreateDataset>
73  
74 =head1 ATTRIBUTES
75  
76  
77 =head2 DataFrequency => Str
78  
79 The frequency of data collection. This parameter is required for
80 RELATED_TIME_SERIES datasets.
81  
82 Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour),
83 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5
84 minutes), and 1min (1 minute). For example, "D" indicates every day and
85 "15min" indicates every 15 minutes.
86  
87  
88  
89 =head2 B<REQUIRED> DatasetName => Str
90  
91 A name for the dataset.
92  
93  
94  
95 =head2 B<REQUIRED> DatasetType => Str
96  
97 The dataset type. Valid values depend on the chosen C<Domain>.
98  
99 Valid values are: C<"TARGET_TIME_SERIES">, C<"RELATED_TIME_SERIES">, C<"ITEM_METADATA">
100  
101 =head2 B<REQUIRED> Domain => Str
102  
103 The domain associated with the dataset. When you add a dataset to a
104 dataset group, this value and the value specified for the C<Domain>
105 parameter of the CreateDatasetGroup operation must match.
106  
107 The C<Domain> and C<DatasetType> that you choose determine the fields
108 that must be present in the training data that you import to the
109 dataset. For example, if you choose the C<RETAIL> domain and
110 C<TARGET_TIME_SERIES> as the C<DatasetType>, Amazon Forecast requires
111 C<item_id>, C<timestamp>, and C<demand> fields to be present in your
112 data. For more information, see howitworks-datasets-groups.
113  
114 Valid values are: C<"RETAIL">, C<"CUSTOM">, C<"INVENTORY_PLANNING">, C<"EC2_CAPACITY">, C<"WORK_FORCE">, C<"WEB_TRAFFIC">, C<"METRICS">
115  
116 =head2 EncryptionConfig => L<Paws::Forecast::EncryptionConfig>
117  
118 An AWS Key Management Service (KMS) key and the AWS Identity and Access
119 Management (IAM) role that Amazon Forecast can assume to access the
120 key.
121  
122  
123  
124 =head2 B<REQUIRED> Schema => L<Paws::Forecast::Schema>
125  
126 The schema for the dataset. The schema attributes and their order must
127 match the fields in your data. The dataset C<Domain> and C<DatasetType>
128 that you choose determine the minimum required fields in your training
129 data. For information about the required fields for a specific dataset
130 domain and type, see howitworks-domains-ds-types.
131  
132  
133  
134 =head2 Tags => ArrayRef[L<Paws::Forecast::Tag>]
135  
136 The optional metadata that you apply to the dataset to help you
137 categorize and organize them. Each tag consists of a key and an
138 optional value, both of which you define.
139  
140 The following basic restrictions apply to tags:
141  
142 =over
143  
144 =item *
145  
146 Maximum number of tags per resource - 50.
147  
148 =item *
149  
150 For each resource, each tag key must be unique, and each tag key can
151 have only one value.
152  
153 =item *
154  
155 Maximum key length - 128 Unicode characters in UTF-8.
156  
157 =item *
158  
159 Maximum value length - 256 Unicode characters in UTF-8.
160  
161 =item *
162  
163 If your tagging schema is used across multiple services and resources,
164 remember that other services may have restrictions on allowed
165 characters. Generally allowed characters are: letters, numbers, and
166 spaces representable in UTF-8, and the following characters: + - = . _
167 : / @.
168  
169 =item *
170  
171 Tag keys and values are case sensitive.
172  
173 =item *
174  
175 Do not use C<aws:>, C<AWS:>, or any upper or lowercase combination of
176 such as a prefix for keys as it is reserved for AWS use. You cannot
177 edit or delete tag keys with this prefix. Values can have this prefix.
178 If a tag value has C<aws> as its prefix but the key does not, then
179 Forecast considers it to be a user tag and will count against the limit
180 of 50 tags. Tags with only the key prefix of C<aws> do not count
181 against your tags per resource limit.
182  
183 =back
184  
185  
186  
187  
188  
189 =head1 SEE ALSO
190  
191 This class forms part of L<Paws>, documenting arguments for method CreateDataset in L<Paws::Forecast>
192  
193 =head1 BUGS and CONTRIBUTIONS
194  
195 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
196  
197 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
198  
199 =cut
200