« blib/lib/Paws/MachineLearning/DeleteTagsOutput.pm
↑ Summary
blib/lib/Paws/MachineLearning/DescribeBatchPredictionsOutput.pm »
| 1 | |||
| 2 | package Paws::MachineLearning::DescribeBatchPredictions; | ||
| 3 | use Moose; | ||
| 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 | use MooseX::ClassAttribute; | ||
| 17 | |||
| 18 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeBatchPredictions'); | ||
| 19 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MachineLearning::DescribeBatchPredictionsOutput'); | ||
| 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::DescribeBatchPredictions - Arguments for method DescribeBatchPredictions on L<Paws::MachineLearning> | ||
| 28 | |||
| 29 | =head1 DESCRIPTION | ||
| 30 | |||
| 31 | This class represents the parameters used for calling the method DescribeBatchPredictions on the | ||
| 32 | L<Amazon Machine Learning|Paws::MachineLearning> service. Use the attributes of this class | ||
| 33 | as arguments to method DescribeBatchPredictions. | ||
| 34 | |||
| 35 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeBatchPredictions. | ||
| 36 | |||
| 37 | =head1 SYNOPSIS | ||
| 38 | |||
| 39 | my $machinelearning = Paws->service('MachineLearning'); | ||
| 40 | my $DescribeBatchPredictionsOutput = | ||
| 41 | $machinelearning->DescribeBatchPredictions( | ||
| 42 | EQ => 'MyComparatorValue', # OPTIONAL | ||
| 43 | FilterVariable => 'CreatedAt', # OPTIONAL | ||
| 44 | GE => 'MyComparatorValue', # OPTIONAL | ||
| 45 | GT => 'MyComparatorValue', # OPTIONAL | ||
| 46 | LE => 'MyComparatorValue', # OPTIONAL | ||
| 47 | LT => 'MyComparatorValue', # OPTIONAL | ||
| 48 | Limit => 1, # OPTIONAL | ||
| 49 | NE => 'MyComparatorValue', # OPTIONAL | ||
| 50 | NextToken => 'MyStringType', # OPTIONAL | ||
| 51 | Prefix => 'MyComparatorValue', # OPTIONAL | ||
| 52 | SortOrder => 'asc', # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $NextToken = $DescribeBatchPredictionsOutput->NextToken; | ||
| 57 | my $Results = $DescribeBatchPredictionsOutput->Results; | ||
| 58 | |||
| 59 | # Returns a L<Paws::MachineLearning::DescribeBatchPredictionsOutput> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/machinelearning/DescribeBatchPredictions> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 EQ => Str | ||
| 68 | |||
| 69 | The equal to operator. The C<BatchPrediction> results will have | ||
| 70 | C<FilterVariable> values that exactly match the value specified with | ||
| 71 | C<EQ>. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 FilterVariable => Str | ||
| 76 | |||
| 77 | Use one of the following variables to filter a list of | ||
| 78 | C<BatchPrediction>: | ||
| 79 | |||
| 80 | =over | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | C<CreatedAt> - Sets the search criteria to the C<BatchPrediction> | ||
| 85 | creation date. | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | C<Status> - Sets the search criteria to the C<BatchPrediction> status. | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | C<Name> - Sets the search criteria to the contents of the | ||
| 94 | C<BatchPrediction> B< > C<Name>. | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | C<IAMUser> - Sets the search criteria to the user account that invoked | ||
| 99 | the C<BatchPrediction> creation. | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | C<MLModelId> - Sets the search criteria to the C<MLModel> used in the | ||
| 104 | C<BatchPrediction>. | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | C<DataSourceId> - Sets the search criteria to the C<DataSource> used in | ||
| 109 | the C<BatchPrediction>. | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | C<DataURI> - Sets the search criteria to the data file(s) used in the | ||
| 114 | C<BatchPrediction>. The URL can identify either a file or an Amazon | ||
| 115 | Simple Storage Solution (Amazon S3) bucket or directory. | ||
| 116 | |||
| 117 | =back | ||
| 118 | |||
| 119 | |||
| 120 | Valid values are: C<"CreatedAt">, C<"LastUpdatedAt">, C<"Status">, C<"Name">, C<"IAMUser">, C<"MLModelId">, C<"DataSourceId">, C<"DataURI"> | ||
| 121 | |||
| 122 | =head2 GE => Str | ||
| 123 | |||
| 124 | The greater than or equal to operator. The C<BatchPrediction> results | ||
| 125 | will have C<FilterVariable> values that are greater than or equal to | ||
| 126 | the value specified with C<GE>. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head2 GT => Str | ||
| 131 | |||
| 132 | The greater than operator. The C<BatchPrediction> results will have | ||
| 133 | C<FilterVariable> values that are greater than the value specified with | ||
| 134 | C<GT>. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 LE => Str | ||
| 139 | |||
| 140 | The less than or equal to operator. The C<BatchPrediction> results will | ||
| 141 | have C<FilterVariable> values that are less than or equal to the value | ||
| 142 | specified with C<LE>. | ||
| 143 | |||
| 144 | |||
| 145 | |||
| 146 | =head2 Limit => Int | ||
| 147 | |||
| 148 | The number of pages of information to include in the result. The range | ||
| 149 | of acceptable values is C<1> through C<100>. The default value is | ||
| 150 | C<100>. | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =head2 LT => Str | ||
| 155 | |||
| 156 | The less than operator. The C<BatchPrediction> results will have | ||
| 157 | C<FilterVariable> values that are less than the value specified with | ||
| 158 | C<LT>. | ||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | =head2 NE => Str | ||
| 163 | |||
| 164 | The not equal to operator. The C<BatchPrediction> results will have | ||
| 165 | C<FilterVariable> values not equal to the value specified with C<NE>. | ||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | =head2 NextToken => Str | ||
| 170 | |||
| 171 | An ID of the page in the paginated results. | ||
| 172 | |||
| 173 | |||
| 174 | |||
| 175 | =head2 Prefix => Str | ||
| 176 | |||
| 177 | A string that is found at the beginning of a variable, such as C<Name> | ||
| 178 | or C<Id>. | ||
| 179 | |||
| 180 | For example, a C<Batch Prediction> operation could have the C<Name> | ||
| 181 | C<2014-09-09-HolidayGiftMailer>. To search for this C<BatchPrediction>, | ||
| 182 | select C<Name> for the C<FilterVariable> and any of the following | ||
| 183 | strings for the C<Prefix>: | ||
| 184 | |||
| 185 | =over | ||
| 186 | |||
| 187 | =item * | ||
| 188 | |||
| 189 | 2014-09 | ||
| 190 | |||
| 191 | =item * | ||
| 192 | |||
| 193 | 2014-09-09 | ||
| 194 | |||
| 195 | =item * | ||
| 196 | |||
| 197 | 2014-09-09-Holiday | ||
| 198 | |||
| 199 | =back | ||
| 200 | |||
| 201 | |||
| 202 | |||
| 203 | |||
| 204 | =head2 SortOrder => Str | ||
| 205 | |||
| 206 | A two-value parameter that determines the sequence of the resulting | ||
| 207 | list of C<MLModel>s. | ||
| 208 | |||
| 209 | =over | ||
| 210 | |||
| 211 | =item * | ||
| 212 | |||
| 213 | C<asc> - Arranges the list in ascending order (A-Z, 0-9). | ||
| 214 | |||
| 215 | =item * | ||
| 216 | |||
| 217 | C<dsc> - Arranges the list in descending order (Z-A, 9-0). | ||
| 218 | |||
| 219 | =back | ||
| 220 | |||
| 221 | Results are sorted by C<FilterVariable>. | ||
| 222 | |||
| 223 | Valid values are: C<"asc">, C<"dsc"> | ||
| 224 | |||
| 225 | |||
| 226 | =head1 SEE ALSO | ||
| 227 | |||
| 228 | This class forms part of L<Paws>, documenting arguments for method DescribeBatchPredictions in L<Paws::MachineLearning> | ||
| 229 | |||
| 230 | =head1 BUGS and CONTRIBUTIONS | ||
| 231 | |||
| 232 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 233 | |||
| 234 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 235 | |||
| 236 | =cut | ||
| 237 |