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

Class: Aws::MachineLearning::Types::DescribeMLModelsInput

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 DescribeMLModelsInput data as a hash:

{
  filter_variable: "CreatedAt", # accepts CreatedAt, LastUpdatedAt, Status, Name, IAMUser, TrainingDataSourceId, RealtimeEndpointStatus, MLModelType, Algorithm, TrainingDataURI
  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 MLModel results will have FilterVariable values that exactly match the value specified with EQ.

Returns:

  • (String)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1658

class DescribeMLModelsInput < 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 MLModel:

  • CreatedAt - Sets the search criteria to MLModel creation date.
  • Status - Sets the search criteria to MLModel status.
  • Name - Sets the search criteria to the contents of MLModel Name.
  • IAMUser - Sets the search criteria to the user account that invoked the MLModel creation.
  • TrainingDataSourceId - Sets the search criteria to the DataSource used to train one or more MLModel.
  • RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time endpoint status.
  • MLModelType - Sets the search criteria to MLModel type: binary, regression, or multi-class.
  • Algorithm - Sets the search criteria to the algorithm that the MLModel uses.
  • TrainingDataURI - Sets the search criteria to the data file(s) used in training a MLModel. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.

Returns:

  • (String)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1658

class DescribeMLModelsInput < 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 MLModel results will have FilterVariable values that are greater than or equal to the value specified with GE.

Returns:

  • (String)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1658

class DescribeMLModelsInput < 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 MLModel results will have FilterVariable values that are greater than the value specified with GT.

Returns:

  • (String)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1658

class DescribeMLModelsInput < 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 MLModel results will have FilterVariable values that are less than or equal to the value specified with LE.

Returns:

  • (String)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1658

class DescribeMLModelsInput < 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)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1658

class DescribeMLModelsInput < 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 MLModel results will have FilterVariable values that are less than the value specified with LT.

Returns:

  • (String)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1658

class DescribeMLModelsInput < 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 MLModel results will have FilterVariable values not equal to the value specified with NE.

Returns:

  • (String)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1658

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

#next_tokenString

The ID of the page in the paginated results.

Returns:

  • (String)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1658

class DescribeMLModelsInput < 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, an MLModel could have the Name 2014-09-09-HolidayGiftMailer. To search for this MLModel, 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)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1658

class DescribeMLModelsInput < 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 MLModel.

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


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 1658

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