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

Inherits:

Struct

• Object
• Struct
• Aws::MachineLearning::Types::DescribeBatchPredictionsInput

Includes:

Structure

Defined in:

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

• #eq ⇒ String

  The equal to operator.

• #filter_variable ⇒ String

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

• #ge ⇒ String

  The greater than or equal to operator.

• #gt ⇒ String

  The greater than operator.

• #le ⇒ String

  The less than or equal to operator.

• #limit ⇒ Integer

  The number of pages of information to include in the result.

• #lt ⇒ String

  The less than operator.

• #ne ⇒ String

  The not equal to operator.

• #next_token ⇒ String

  An ID of the page in the paginated results.

• #prefix ⇒ String

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

• #sort_order ⇒ String

  A two-value parameter that determines the sequence of the resulting list of ‘MLModel`s.

Instance Attribute Details

#eq ⇒ String

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

Returns:

• (String)

# File '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_variable ⇒ String

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)

# File '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

#ge ⇒ String

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)

# File '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

#gt ⇒ String

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

Returns:

• (String)

# File '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

#le ⇒ String

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)

# File '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

#limit ⇒ Integer

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)

# File '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

#lt ⇒ String

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

Returns:

• (String)

# File '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

#ne ⇒ String

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

Returns:

• (String)

# File '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_token ⇒ String

An ID of the page in the paginated results.

Returns:

• (String)

# File '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

#prefix ⇒ String

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)

# File '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_order ⇒ String

A two-value parameter that determines the sequence of the resulting list of ‘MLModel`s.

• ‘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)

# File '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