The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $machinelearning = Paws->service('MachineLearning');
    my $DescribeBatchPredictionsOutput =
      $machinelearning->DescribeBatchPredictions(
      EQ             => 'MyComparatorValue',    # OPTIONAL
      FilterVariable => 'CreatedAt',            # OPTIONAL
      GE             => 'MyComparatorValue',    # OPTIONAL
      GT             => 'MyComparatorValue',    # OPTIONAL
      LE             => 'MyComparatorValue',    # OPTIONAL
      LT             => 'MyComparatorValue',    # OPTIONAL
      Limit          => 1,                      # OPTIONAL
      NE             => 'MyComparatorValue',    # OPTIONAL
      NextToken      => 'MyStringType',         # OPTIONAL
      Prefix         => 'MyComparatorValue',    # OPTIONAL
      SortOrder      => 'asc',                  # OPTIONAL
      );

    # Results:
    my $NextToken = $DescribeBatchPredictionsOutput->NextToken;
    my $Results   = $DescribeBatchPredictionsOutput->Results;

    # Returns a L<Paws::MachineLearning::DescribeBatchPredictionsOutput> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/machinelearning/DescribeBatchPredictions

ATTRIBUTES

EQ => Str

The equal to operator. The BatchPrediction results will have FilterVariable values that exactly match the value specified with EQ.

FilterVariable => Str

Use one of the following variables to filter a list of BatchPrediction:

  • CreatedAt - Sets the search criteria to the BatchPrediction creation date.

  • Status - Sets the search criteria to the BatchPrediction status.

  • Name - Sets the search criteria to the contents of the BatchPrediction Name.

  • IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.

  • MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.

  • DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.

  • DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

Valid values are: "CreatedAt", "LastUpdatedAt", "Status", "Name", "IAMUser", "MLModelId", "DataSourceId", "DataURI"

GE => Str

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

GT => Str

The greater than operator. The BatchPrediction results will have FilterVariable values that are greater than the value specified with GT.

LE => Str

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

Limit => Int

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

LT => Str

The less than operator. The BatchPrediction results will have FilterVariable values that are less than the value specified with LT.

NE => Str

The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE.

NextToken => Str

An ID of the page in the paginated results.

Prefix => Str

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

For example, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, select Name for the FilterVariable and any of the following strings for the Prefix:

  • 2014-09

  • 2014-09-09

  • 2014-09-09-Holiday

SortOrder => Str

A two-value parameter that determines the sequence of the resulting list of MLModels.

  • asc - Arranges the list in ascending order (A-Z, 0-9).

  • dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

Valid values are: "asc", "dsc"

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeBatchPredictions in Paws::MachineLearning

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