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

package Paws::MachineLearning::DescribeMLModels;
  use Moose;
  has EQ => (is => 'ro', isa => 'Str');
  has FilterVariable => (is => 'ro', isa => 'Str');
  has GE => (is => 'ro', isa => 'Str');
  has GT => (is => 'ro', isa => 'Str');
  has LE => (is => 'ro', isa => 'Str');
  has Limit => (is => 'ro', isa => 'Int');
  has LT => (is => 'ro', isa => 'Str');
  has NE => (is => 'ro', isa => 'Str');
  has NextToken => (is => 'ro', isa => 'Str');
  has Prefix => (is => 'ro', isa => 'Str');
  has SortOrder => (is => 'ro', isa => 'Str');

  use MooseX::ClassAttribute;

  class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeMLModels');
  class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MachineLearning::DescribeMLModelsOutput');
  class_has _result_key => (isa => 'Str', is => 'ro');
1;

### main pod documentation begin ###

=head1 NAME

Paws::MachineLearning::DescribeMLModels - Arguments for method DescribeMLModels on Paws::MachineLearning

=head1 DESCRIPTION

This class represents the parameters used for calling the method DescribeMLModels on the
Amazon Machine Learning service. Use the attributes of this class
as arguments to method DescribeMLModels.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeMLModels.

As an example:

  $service_obj->DescribeMLModels(Att1 => $value1, Att2 => $value2, ...);

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.

=head1 ATTRIBUTES


=head2 EQ => Str

The equal to operator. The C<MLModel> results will have
C<FilterVariable> values that exactly match the value specified with
C<EQ>.



=head2 FilterVariable => Str

Use one of the following variables to filter a list of C<MLModel>:

=over

=item * C<CreatedAt> - Sets the search criteria to C<MLModel> creation
date.

=item * C<Status> - Sets the search criteria to C<MLModel> status.

=item * C<Name> - Sets the search criteria to the contents of
C<MLModel>B< > C<Name>.

=item * C<IAMUser> - Sets the search criteria to the user account that
invoked the C<MLModel> creation.

=item * C<TrainingDataSourceId> - Sets the search criteria to the
C<DataSource> used to train one or more C<MLModel>.

=item * C<RealtimeEndpointStatus> - Sets the search criteria to the
C<MLModel> real-time endpoint status.

=item * C<MLModelType> - Sets the search criteria to C<MLModel> type:
binary, regression, or multi-class.

=item * C<Algorithm> - Sets the search criteria to the algorithm that
the C<MLModel> uses.

=item * C<TrainingDataURI> - Sets the search criteria to the data
file(s) used in training a C<MLModel>. The URL can identify either a
file or an Amazon Simple Storage Service (Amazon S3) bucket or
directory.

=back


Valid values are: C<"CreatedAt">, C<"LastUpdatedAt">, C<"Status">, C<"Name">, C<"IAMUser">, C<"TrainingDataSourceId">, C<"RealtimeEndpointStatus">, C<"MLModelType">, C<"Algorithm">, C<"TrainingDataURI">

=head2 GE => Str

The greater than or equal to operator. The C<MLModel> results will have
C<FilterVariable> values that are greater than or equal to the value
specified with C<GE>.



=head2 GT => Str

The greater than operator. The C<MLModel> results will have
C<FilterVariable> values that are greater than the value specified with
C<GT>.



=head2 LE => Str

The less than or equal to operator. The C<MLModel> results will have
C<FilterVariable> values that are less than or equal to the value
specified with C<LE>.



=head2 Limit => Int

The number of pages of information to include in the result. The range
of acceptable values is C<1> through C<100>. The default value is
C<100>.



=head2 LT => Str

The less than operator. The C<MLModel> results will have
C<FilterVariable> values that are less than the value specified with
C<LT>.



=head2 NE => Str

The not equal to operator. The C<MLModel> results will have
C<FilterVariable> values not equal to the value specified with C<NE>.



=head2 NextToken => Str

The ID of the page in the paginated results.



=head2 Prefix => Str

A string that is found at the beginning of a variable, such as C<Name>
or C<Id>.

For example, an C<MLModel> could have the C<Name>
C<2014-09-09-HolidayGiftMailer>. To search for this C<MLModel>, select
C<Name> for the C<FilterVariable> and any of the following strings for
the C<Prefix>:

=over

=item *

2014-09

=item *

2014-09-09

=item *

2014-09-09-Holiday

=back




=head2 SortOrder => Str

A two-value parameter that determines the sequence of the resulting
list of C<MLModel>.

=over

=item * C<asc> - Arranges the list in ascending order (A-Z, 0-9).

=item * C<dsc> - Arranges the list in descending order (Z-A, 9-0).

=back

Results are sorted by C<FilterVariable>.

Valid values are: C<"asc">, C<"dsc">


=head1 SEE ALSO

This class forms part of L<Paws>, documenting arguments for method DescribeMLModels in L<Paws::MachineLearning>

=head1 BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

=cut