Returns a list of MLModel that match the search criteria in the request¶

Description¶

Returns a list of MLModel that match the search criteria in the request.

Usage¶

machinelearning_describe_ml_models(FilterVariable, EQ, GT, LT, GE, LE,
  NE, Prefix, SortOrder, NextToken, Limit)

Arguments¶

• FilterVariable

  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.

• EQ

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

• GT

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

• LT

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

• GE

  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.

• LE

  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.

• NE

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

• Prefix

  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

• SortOrder

  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.

• NextToken

  The ID of the page in the paginated results.

• Limit

  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.

Value¶

A list with the following syntax:

list(
  Results = list(
    list(
      MLModelId = "string",
      TrainingDataSourceId = "string",
      CreatedByIamUser = "string",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      LastUpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      Name = "string",
      Status = "PENDING"|"INPROGRESS"|"FAILED"|"COMPLETED"|"DELETED",
      SizeInBytes = 123,
      EndpointInfo = list(
        PeakRequestsPerSecond = 123,
        CreatedAt = as.POSIXct(
          "2015-01-01"
        ),
        EndpointUrl = "string",
        EndpointStatus = "NONE"|"READY"|"UPDATING"|"FAILED"
      ),
      TrainingParameters = list(
        "string"
      ),
      InputDataLocationS3 = "string",
      Algorithm = "sgd",
      MLModelType = "REGRESSION"|"BINARY"|"MULTICLASS",
      ScoreThreshold = 123.0,
      ScoreThresholdLastUpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      Message = "string",
      ComputeTime = 123,
      FinishedAt = as.POSIXct(
        "2015-01-01"
      ),
      StartedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_ml_models(
  FilterVariable = "CreatedAt"|"LastUpdatedAt"|"Status"|"Name"|"IAMUser"|"TrainingDataSourceId"|"RealtimeEndpointStatus"|"MLModelType"|"Algorithm"|"TrainingDataURI",
  EQ = "string",
  GT = "string",
  LT = "string",
  GE = "string",
  LE = "string",
  NE = "string",
  Prefix = "string",
  SortOrder = "asc"|"dsc",
  NextToken = "string",
  Limit = 123
)