Describe Evaluations
machinelearning_describe_evaluations | R Documentation |
Returns a list of DescribeEvaluations that match the search criteria in the request¶
Description¶
Returns a list of describe_evaluations
that match the search criteria
in the request.
Usage¶
machinelearning_describe_evaluations(FilterVariable, EQ, GT, LT, GE, LE,
NE, Prefix, SortOrder, NextToken, Limit)
Arguments¶
FilterVariable
Use one of the following variable to filter a list of
Evaluation
objects:CreatedAt
- Sets the search criteria to theEvaluation
creation date.Status
- Sets the search criteria to theEvaluation
status.Name
- Sets the search criteria to the contents ofEvaluation
Name
.IAMUser
- Sets the search criteria to the user account that invoked anEvaluation
.MLModelId
- Sets the search criteria to theMLModel
that was evaluated.DataSourceId
- Sets the search criteria to theDataSource
used inEvaluation
.DataUri
- Sets the search criteria to the data file(s) used inEvaluation
. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.
EQ
The equal to operator. The
Evaluation
results will haveFilterVariable
values that exactly match the value specified withEQ
.GT
The greater than operator. The
Evaluation
results will haveFilterVariable
values that are greater than the value specified withGT
.LT
The less than operator. The
Evaluation
results will haveFilterVariable
values that are less than the value specified withLT
.GE
The greater than or equal to operator. The
Evaluation
results will haveFilterVariable
values that are greater than or equal to the value specified withGE
.LE
The less than or equal to operator. The
Evaluation
results will haveFilterVariable
values that are less than or equal to the value specified withLE
.NE
The not equal to operator. The
Evaluation
results will haveFilterVariable
values not equal to the value specified withNE
.Prefix
A string that is found at the beginning of a variable, such as
Name
orId
.For example, an
Evaluation
could have theName
2014-09-09-HolidayGiftMailer
. To search for thisEvaluation
, selectName
for theFilterVariable
and any of the following strings for thePrefix
:2014-09
2014-09-09
2014-09-09-Holiday
SortOrder
A two-value parameter that determines the sequence of the resulting list of
Evaluation
.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 maximum number of
Evaluation
to include in the result.
Value¶
A list with the following syntax:
list(
Results = list(
list(
EvaluationId = "string",
MLModelId = "string",
EvaluationDataSourceId = "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",
PerformanceMetrics = list(
Properties = list(
"string"
)
),
Message = "string",
ComputeTime = 123,
FinishedAt = as.POSIXct(
"2015-01-01"
),
StartedAt = as.POSIXct(
"2015-01-01"
)
)
),
NextToken = "string"
)
Request syntax¶
svc$describe_evaluations(
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
)