You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MachineLearning::Types::DescribeBatchPredictionsInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb

Overview

Note:

When making an API call, you may pass DescribeBatchPredictionsInput data as a hash:

{
  filter_variable: "CreatedAt", # accepts CreatedAt, LastUpdatedAt, Status, Name, IAMUser, MLModelId, DataSourceId, DataURI
  eq: "ComparatorValue",
  gt: "ComparatorValue",
  lt: "ComparatorValue",
  ge: "ComparatorValue",
  le: "ComparatorValue",
  ne: "ComparatorValue",
  prefix: "ComparatorValue",
  sort_order: "asc", # accepts asc, dsc
  next_token: "StringType",
  limit: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#eqString

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

Returns:

  • (String)


1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1240

class DescribeBatchPredictionsInput < Struct.new(
  :filter_variable,
  :eq,
  :gt,
  :lt,
  :ge,
  :le,
  :ne,
  :prefix,
  :sort_order,
  :next_token,
  :limit)
  include Aws::Structure
end

#filter_variableString

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.

Returns:

  • (String)


1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1240

class DescribeBatchPredictionsInput < Struct.new(
  :filter_variable,
  :eq,
  :gt,
  :lt,
  :ge,
  :le,
  :ne,
  :prefix,
  :sort_order,
  :next_token,
  :limit)
  include Aws::Structure
end

#geString

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.

Returns:

  • (String)


1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1240

class DescribeBatchPredictionsInput < Struct.new(
  :filter_variable,
  :eq,
  :gt,
  :lt,
  :ge,
  :le,
  :ne,
  :prefix,
  :sort_order,
  :next_token,
  :limit)
  include Aws::Structure
end

#gtString

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

Returns:

  • (String)


1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1240

class DescribeBatchPredictionsInput < Struct.new(
  :filter_variable,
  :eq,
  :gt,
  :lt,
  :ge,
  :le,
  :ne,
  :prefix,
  :sort_order,
  :next_token,
  :limit)
  include Aws::Structure
end

#leString

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.

Returns:

  • (String)


1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1240

class DescribeBatchPredictionsInput < Struct.new(
  :filter_variable,
  :eq,
  :gt,
  :lt,
  :ge,
  :le,
  :ne,
  :prefix,
  :sort_order,
  :next_token,
  :limit)
  include Aws::Structure
end

#limitInteger

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.

Returns:

  • (Integer)


1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1240

class DescribeBatchPredictionsInput < Struct.new(
  :filter_variable,
  :eq,
  :gt,
  :lt,
  :ge,
  :le,
  :ne,
  :prefix,
  :sort_order,
  :next_token,
  :limit)
  include Aws::Structure
end

#ltString

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

Returns:

  • (String)


1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1240

class DescribeBatchPredictionsInput < Struct.new(
  :filter_variable,
  :eq,
  :gt,
  :lt,
  :ge,
  :le,
  :ne,
  :prefix,
  :sort_order,
  :next_token,
  :limit)
  include Aws::Structure
end

#neString

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

Returns:

  • (String)


1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1240

class DescribeBatchPredictionsInput < Struct.new(
  :filter_variable,
  :eq,
  :gt,
  :lt,
  :ge,
  :le,
  :ne,
  :prefix,
  :sort_order,
  :next_token,
  :limit)
  include Aws::Structure
end

#next_tokenString

An ID of the page in the paginated results.

Returns:

  • (String)


1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1240

class DescribeBatchPredictionsInput < Struct.new(
  :filter_variable,
  :eq,
  :gt,
  :lt,
  :ge,
  :le,
  :ne,
  :prefix,
  :sort_order,
  :next_token,
  :limit)
  include Aws::Structure
end

#prefixString

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

Returns:

  • (String)


1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1240

class DescribeBatchPredictionsInput < Struct.new(
  :filter_variable,
  :eq,
  :gt,
  :lt,
  :ge,
  :le,
  :ne,
  :prefix,
  :sort_order,
  :next_token,
  :limit)
  include Aws::Structure
end

#sort_orderString

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.

Returns:

  • (String)


1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1240

class DescribeBatchPredictionsInput < Struct.new(
  :filter_variable,
  :eq,
  :gt,
  :lt,
  :ge,
  :le,
  :ne,
  :prefix,
  :sort_order,
  :next_token,
  :limit)
  include Aws::Structure
end