File Coverage

blib/lib/Paws/MachineLearning/DescribeMLModels.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::MachineLearning::DescribeMLModels;
3 1     1   475 use Moose;
  1     1   4  
  1         8  
  1         566  
  1         3  
  1         6  
4             has EQ => (is => 'ro', isa => 'Str');
5             has FilterVariable => (is => 'ro', isa => 'Str');
6             has GE => (is => 'ro', isa => 'Str');
7             has GT => (is => 'ro', isa => 'Str');
8             has LE => (is => 'ro', isa => 'Str');
9             has Limit => (is => 'ro', isa => 'Int');
10             has LT => (is => 'ro', isa => 'Str');
11             has NE => (is => 'ro', isa => 'Str');
12             has NextToken => (is => 'ro', isa => 'Str');
13             has Prefix => (is => 'ro', isa => 'Str');
14             has SortOrder => (is => 'ro', isa => 'Str');
15              
16 1     1   8605 use MooseX::ClassAttribute;
  1     1   4  
  1         12  
  1         6482  
  1         2  
  1         7  
17              
18             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeMLModels');
19             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MachineLearning::DescribeMLModelsOutput');
20             class_has _result_key => (isa => 'Str', is => 'ro');
21             1;
22              
23             ### main pod documentation begin ###
24              
25             =head1 NAME
26              
27             Paws::MachineLearning::DescribeMLModels - Arguments for method DescribeMLModels on Paws::MachineLearning
28              
29             =head1 DESCRIPTION
30              
31             This class represents the parameters used for calling the method DescribeMLModels on the
32             Amazon Machine Learning service. Use the attributes of this class
33             as arguments to method DescribeMLModels.
34              
35             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeMLModels.
36              
37             As an example:
38              
39             $service_obj->DescribeMLModels(Att1 => $value1, Att2 => $value2, ...);
40              
41             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.
42              
43             =head1 ATTRIBUTES
44              
45              
46             =head2 EQ => Str
47              
48             The equal to operator. The C<MLModel> results will have
49             C<FilterVariable> values that exactly match the value specified with
50             C<EQ>.
51              
52              
53              
54             =head2 FilterVariable => Str
55              
56             Use one of the following variables to filter a list of C<MLModel>:
57              
58             =over
59              
60             =item * C<CreatedAt> - Sets the search criteria to C<MLModel> creation
61             date.
62              
63             =item * C<Status> - Sets the search criteria to C<MLModel> status.
64              
65             =item * C<Name> - Sets the search criteria to the contents of
66             C<MLModel>B< > C<Name>.
67              
68             =item * C<IAMUser> - Sets the search criteria to the user account that
69             invoked the C<MLModel> creation.
70              
71             =item * C<TrainingDataSourceId> - Sets the search criteria to the
72             C<DataSource> used to train one or more C<MLModel>.
73              
74             =item * C<RealtimeEndpointStatus> - Sets the search criteria to the
75             C<MLModel> real-time endpoint status.
76              
77             =item * C<MLModelType> - Sets the search criteria to C<MLModel> type:
78             binary, regression, or multi-class.
79              
80             =item * C<Algorithm> - Sets the search criteria to the algorithm that
81             the C<MLModel> uses.
82              
83             =item * C<TrainingDataURI> - Sets the search criteria to the data
84             file(s) used in training a C<MLModel>. The URL can identify either a
85             file or an Amazon Simple Storage Service (Amazon S3) bucket or
86             directory.
87              
88             =back
89              
90              
91             Valid values are: C<"CreatedAt">, C<"LastUpdatedAt">, C<"Status">, C<"Name">, C<"IAMUser">, C<"TrainingDataSourceId">, C<"RealtimeEndpointStatus">, C<"MLModelType">, C<"Algorithm">, C<"TrainingDataURI">
92              
93             =head2 GE => Str
94              
95             The greater than or equal to operator. The C<MLModel> results will have
96             C<FilterVariable> values that are greater than or equal to the value
97             specified with C<GE>.
98              
99              
100              
101             =head2 GT => Str
102              
103             The greater than operator. The C<MLModel> results will have
104             C<FilterVariable> values that are greater than the value specified with
105             C<GT>.
106              
107              
108              
109             =head2 LE => Str
110              
111             The less than or equal to operator. The C<MLModel> results will have
112             C<FilterVariable> values that are less than or equal to the value
113             specified with C<LE>.
114              
115              
116              
117             =head2 Limit => Int
118              
119             The number of pages of information to include in the result. The range
120             of acceptable values is C<1> through C<100>. The default value is
121             C<100>.
122              
123              
124              
125             =head2 LT => Str
126              
127             The less than operator. The C<MLModel> results will have
128             C<FilterVariable> values that are less than the value specified with
129             C<LT>.
130              
131              
132              
133             =head2 NE => Str
134              
135             The not equal to operator. The C<MLModel> results will have
136             C<FilterVariable> values not equal to the value specified with C<NE>.
137              
138              
139              
140             =head2 NextToken => Str
141              
142             The ID of the page in the paginated results.
143              
144              
145              
146             =head2 Prefix => Str
147              
148             A string that is found at the beginning of a variable, such as C<Name>
149             or C<Id>.
150              
151             For example, an C<MLModel> could have the C<Name>
152             C<2014-09-09-HolidayGiftMailer>. To search for this C<MLModel>, select
153             C<Name> for the C<FilterVariable> and any of the following strings for
154             the C<Prefix>:
155              
156             =over
157              
158             =item *
159              
160             2014-09
161              
162             =item *
163              
164             2014-09-09
165              
166             =item *
167              
168             2014-09-09-Holiday
169              
170             =back
171              
172              
173              
174              
175             =head2 SortOrder => Str
176              
177             A two-value parameter that determines the sequence of the resulting
178             list of C<MLModel>.
179              
180             =over
181              
182             =item * C<asc> - Arranges the list in ascending order (A-Z, 0-9).
183              
184             =item * C<dsc> - Arranges the list in descending order (Z-A, 9-0).
185              
186             =back
187              
188             Results are sorted by C<FilterVariable>.
189              
190             Valid values are: C<"asc">, C<"dsc">
191              
192              
193             =head1 SEE ALSO
194              
195             This class forms part of L<Paws>, documenting arguments for method DescribeMLModels in L<Paws::MachineLearning>
196              
197             =head1 BUGS and CONTRIBUTIONS
198              
199             The source code is located here: https://github.com/pplu/aws-sdk-perl
200              
201             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
202              
203             =cut
204