paws.machine.learning: machinelearning_describe_batch_predictions – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

paws.machine.learning

machinelearning_describe_batch_predictions

Returns a list of BatchPrediction operations that match the search criteria in the request

Description

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

Usage

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

Arguments

`FilterVariable`	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.
`EQ`	The equal to operator. The `BatchPrediction` results will have `FilterVariable` values that exactly match the value specified with `EQ`.
`GT`	The greater than operator. The `BatchPrediction` results will have `FilterVariable` values that are greater than the value specified with `GT`.
`LT`	The less than operator. The `BatchPrediction` results will have `FilterVariable` values that are less than the value specified with `LT`.
`GE`	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`.
`LE`	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`.
`NE`	The not equal to operator. The `BatchPrediction` 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, 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`	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`.
`NextToken`	An 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(
      BatchPredictionId = "string",
      MLModelId = "string",
      BatchPredictionDataSourceId = "string",
      InputDataLocationS3 = "string",
      CreatedByIamUser = "string",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      LastUpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      Name = "string",
      Status = "PENDING"|"INPROGRESS"|"FAILED"|"COMPLETED"|"DELETED",
      OutputUri = "string",
      Message = "string",
      ComputeTime = 123,
      FinishedAt = as.POSIXct(
        "2015-01-01"
      ),
      StartedAt = as.POSIXct(
        "2015-01-01"
      ),
      TotalRecordCount = 123,
      InvalidRecordCount = 123
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_batch_predictions(
  FilterVariable = "CreatedAt"|"LastUpdatedAt"|"Status"|"Name"|"IAMUser"|"MLModelId"|"DataSourceId"|"DataURI",
  EQ = "string",
  GT = "string",
  LT = "string",
  GE = "string",
  LE = "string",
  NE = "string",
  Prefix = "string",
  SortOrder = "asc"|"dsc",
  NextToken = "string",
  Limit = 123
)

paws.machine.learning

Amazon Web Services Machine Learning Services

v0.1.11

Apache License (>= 2.0)

Authors

David Kretch [aut, cre], Adam Banker [aut], Amazon.com, Inc. [cph]

Initial release

machinelearning_describe_batch_predictions

Description

Usage

Arguments

Value

Request syntax

paws.machine.learning

We don't support your browser anymore