blib/lib/Paws/Forecast/CreateForecastExportJob.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::CreateForecastExportJob;
3 use Moose;
4 has Destination => (is => 'ro', isa => 'Paws::Forecast::DataDestination', required => 1);
5 has ForecastArn => (is => 'ro', isa => 'Str', required => 1);
6 has ForecastExportJobName => (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 => 'CreateForecastExportJob');
12 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Forecast::CreateForecastExportJobResponse');
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::CreateForecastExportJob - Arguments for method CreateForecastExportJob on L<Paws::Forecast>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method CreateForecastExportJob on the
25 L<Amazon Forecast Service|Paws::Forecast> service. Use the attributes of this class
26 as arguments to method CreateForecastExportJob.
27  
28 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateForecastExportJob.
29  
30 =head1 SYNOPSIS
31  
32 my $forecast = Paws->service('Forecast');
33 my $CreateForecastExportJobResponse = $forecast->CreateForecastExportJob(
34 Destination => {
35 S3Config => {
36 Path => 'MyS3Path',
37 RoleArn => 'MyArn', # max: 256
38 KMSKeyArn => 'MyKMSKeyArn', # max: 256; OPTIONAL
39 },
40  
41 },
42 ForecastArn => 'MyArn',
43 ForecastExportJobName => 'MyName',
44 Tags => [
45 {
46 Key => 'MyTagKey', # min: 1, max: 128
47 Value => 'MyTagValue', # max: 256
48  
49 },
50 ...
51 ], # OPTIONAL
52 );
53  
54 # Results:
55 my $ForecastExportJobArn =
56 $CreateForecastExportJobResponse->ForecastExportJobArn;
57  
58 # Returns a L<Paws::Forecast::CreateForecastExportJobResponse> object.
59  
60 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.
61 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/forecast/CreateForecastExportJob>
62  
63 =head1 ATTRIBUTES
64  
65  
66 =head2 B<REQUIRED> Destination => L<Paws::Forecast::DataDestination>
67  
68 The location where you want to save the forecast and an AWS Identity
69 and Access Management (IAM) role that Amazon Forecast can assume to
70 access the location. The forecast must be exported to an Amazon S3
71 bucket.
72  
73 If encryption is used, C<Destination> must include an AWS Key
74 Management Service (KMS) key. The IAM role must allow Amazon Forecast
75 permission to access the key.
76  
77  
78  
79 =head2 B<REQUIRED> ForecastArn => Str
80  
81 The Amazon Resource Name (ARN) of the forecast that you want to export.
82  
83  
84  
85 =head2 B<REQUIRED> ForecastExportJobName => Str
86  
87 The name for the forecast export job.
88  
89  
90  
91 =head2 Tags => ArrayRef[L<Paws::Forecast::Tag>]
92  
93 The optional metadata that you apply to the forecast export job to help
94 you categorize and organize them. Each tag consists of a key and an
95 optional value, both of which you define.
96  
97 The following basic restrictions apply to tags:
98  
99 =over
100  
101 =item *
102  
103 Maximum number of tags per resource - 50.
104  
105 =item *
106  
107 For each resource, each tag key must be unique, and each tag key can
108 have only one value.
109  
110 =item *
111  
112 Maximum key length - 128 Unicode characters in UTF-8.
113  
114 =item *
115  
116 Maximum value length - 256 Unicode characters in UTF-8.
117  
118 =item *
119  
120 If your tagging schema is used across multiple services and resources,
121 remember that other services may have restrictions on allowed
122 characters. Generally allowed characters are: letters, numbers, and
123 spaces representable in UTF-8, and the following characters: + - = . _
124 : / @.
125  
126 =item *
127  
128 Tag keys and values are case sensitive.
129  
130 =item *
131  
132 Do not use C<aws:>, C<AWS:>, or any upper or lowercase combination of
133 such as a prefix for keys as it is reserved for AWS use. You cannot
134 edit or delete tag keys with this prefix. Values can have this prefix.
135 If a tag value has C<aws> as its prefix but the key does not, then
136 Forecast considers it to be a user tag and will count against the limit
137 of 50 tags. Tags with only the key prefix of C<aws> do not count
138 against your tags per resource limit.
139  
140 =back
141  
142  
143  
144  
145  
146 =head1 SEE ALSO
147  
148 This class forms part of L<Paws>, documenting arguments for method CreateForecastExportJob in L<Paws::Forecast>
149  
150 =head1 BUGS and CONTRIBUTIONS
151  
152 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
153  
154 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
155  
156 =cut
157