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

filter: Statementstmt 0.0% 0 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 15 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Forecast::CreateForecast;
3 use Moose;
4 has ForecastName => (is => 'ro', isa => 'Str', required => 1);
5 has ForecastTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
6 has PredictorArn => (is => 'ro', isa => 'Str', required => 1);
7 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Forecast::Tag]');
8  
9 use MooseX::ClassAttribute;
10  
11 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateForecast');
12 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Forecast::CreateForecastResponse');
13 class_has _result_key => (isa => 'Str', is => 'ro');
14 1;
15  
16 ### main pod documentation begin ###
17  
18 =head1 NAME
19  
20 Paws::Forecast::CreateForecast - Arguments for method CreateForecast on L<Paws::Forecast>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method CreateForecast on the
25 L<Amazon Forecast Service|Paws::Forecast> service. Use the attributes of this class
26 as arguments to method CreateForecast.
27  
28 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateForecast.
29  
30 =head1 SYNOPSIS
31  
32 my $forecast = Paws->service('Forecast');
33 my $CreateForecastResponse = $forecast->CreateForecast(
34 ForecastName => 'MyName',
35 PredictorArn => 'MyArn',
36 ForecastTypes => [ 'MyForecastType', ... ], # OPTIONAL
37 Tags => [
38 {
39 Key => 'MyTagKey', # min: 1, max: 128
40 Value => 'MyTagValue', # max: 256
41  
42 },
43 ...
44 ], # OPTIONAL
45 );
46  
47 # Results:
48 my $ForecastArn = $CreateForecastResponse->ForecastArn;
49  
50 # Returns a L<Paws::Forecast::CreateForecastResponse> object.
51  
52 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.
53 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/forecast/CreateForecast>
54  
55 =head1 ATTRIBUTES
56  
57  
58 =head2 B<REQUIRED> ForecastName => Str
59  
60 A name for the forecast.
61  
62  
63  
64 =head2 ForecastTypes => ArrayRef[Str|Undef]
65  
66 The quantiles at which probabilistic forecasts are generated. B<You can
67 currently specify up to 5 quantiles per forecast>. Accepted values
68 include C<0.01 to 0.99> (increments of .01 only) and C<mean>. The mean
69 forecast is different from the median (0.50) when the distribution is
70 not symmetric (for example, Beta and Negative Binomial). The default
71 value is C<["0.1", "0.5", "0.9"]>.
72  
73  
74  
75 =head2 B<REQUIRED> PredictorArn => Str
76  
77 The Amazon Resource Name (ARN) of the predictor to use to generate the
78 forecast.
79  
80  
81  
82 =head2 Tags => ArrayRef[L<Paws::Forecast::Tag>]
83  
84 The optional metadata that you apply to the forecast to help you
85 categorize and organize them. Each tag consists of a key and an
86 optional value, both of which you define.
87  
88 The following basic restrictions apply to tags:
89  
90 =over
91  
92 =item *
93  
94 Maximum number of tags per resource - 50.
95  
96 =item *
97  
98 For each resource, each tag key must be unique, and each tag key can
99 have only one value.
100  
101 =item *
102  
103 Maximum key length - 128 Unicode characters in UTF-8.
104  
105 =item *
106  
107 Maximum value length - 256 Unicode characters in UTF-8.
108  
109 =item *
110  
111 If your tagging schema is used across multiple services and resources,
112 remember that other services may have restrictions on allowed
113 characters. Generally allowed characters are: letters, numbers, and
114 spaces representable in UTF-8, and the following characters: + - = . _
115 : / @.
116  
117 =item *
118  
119 Tag keys and values are case sensitive.
120  
121 =item *
122  
123 Do not use C<aws:>, C<AWS:>, or any upper or lowercase combination of
124 such as a prefix for keys as it is reserved for AWS use. You cannot
125 edit or delete tag keys with this prefix. Values can have this prefix.
126 If a tag value has C<aws> as its prefix but the key does not, then
127 Forecast considers it to be a user tag and will count against the limit
128 of 50 tags. Tags with only the key prefix of C<aws> do not count
129 against your tags per resource limit.
130  
131 =back
132  
133  
134  
135  
136  
137 =head1 SEE ALSO
138  
139 This class forms part of L<Paws>, documenting arguments for method CreateForecast in L<Paws::Forecast>
140  
141 =head1 BUGS and CONTRIBUTIONS
142  
143 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
144  
145 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
146  
147 =cut
148