Amazonka.MachineLearning.DescribeEvaluations

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

This operation returns paginated results.

Creating a Request

data DescribeEvaluations

See: newDescribeEvaluations smart constructor.

Constructors

DescribeEvaluations'

Fields

• eq :: Maybe Text

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

• filterVariable :: Maybe EvaluationFilterVariable

  Use one of the following variable to filter a list of Evaluation objects:

  • CreatedAt - Sets the search criteria to the Evaluation creation date.
  • Status - Sets the search criteria to the Evaluation status.
  • Name - Sets the search criteria to the contents of Evaluation ____ Name.
  • IAMUser - Sets the search criteria to the user account that invoked an Evaluation.
  • MLModelId - Sets the search criteria to the MLModel that was evaluated.
  • DataSourceId - Sets the search criteria to the DataSource used in Evaluation.
  • DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.
• ge :: Maybe Text

  The greater than or equal to operator. The Evaluation results will have FilterVariable values that are greater than or equal to the value specified with GE.

• gt :: Maybe Text

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

• le :: Maybe Text

  The less than or equal to operator. The Evaluation results will have FilterVariable values that are less than or equal to the value specified with LE.

• lt :: Maybe Text

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

• limit :: Maybe Natural

  The maximum number of Evaluation to include in the result.

• ne :: Maybe Text

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

• nextToken :: Maybe Text

  The ID of the page in the paginated results.

• prefix :: Maybe Text

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

  For example, an Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for this Evaluation, select Name for the FilterVariable and any of the following strings for the Prefix:

  • 2014-09
  • 2014-09-09
  • 2014-09-09-Holiday
• sortOrder :: Maybe 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.

Instances

ToJSON DescribeEvaluations

Defined in Amazonka.MachineLearning.DescribeEvaluations

Methods

toJSON :: DescribeEvaluations -> Value

toEncoding :: DescribeEvaluations -> Encoding

toJSONList :: [DescribeEvaluations] -> Value

toEncodingList :: [DescribeEvaluations] -> Encoding

ToHeaders DescribeEvaluations

Defined in Amazonka.MachineLearning.DescribeEvaluations

Methods

toHeaders :: DescribeEvaluations -> [Header]

ToPath DescribeEvaluations

Defined in Amazonka.MachineLearning.DescribeEvaluations

Methods

toPath :: DescribeEvaluations -> ByteString

ToQuery DescribeEvaluations

Defined in Amazonka.MachineLearning.DescribeEvaluations

Methods

toQuery :: DescribeEvaluations -> QueryString

AWSPager DescribeEvaluations

Defined in Amazonka.MachineLearning.DescribeEvaluations

Methods

page :: DescribeEvaluations -> AWSResponse DescribeEvaluations -> Maybe DescribeEvaluations

AWSRequest DescribeEvaluations

Defined in Amazonka.MachineLearning.DescribeEvaluations

Associated Types

type AWSResponse DescribeEvaluations

Methods

request :: (Service -> Service) -> DescribeEvaluations -> Request DescribeEvaluations

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEvaluations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEvaluations)))

Generic DescribeEvaluations

Defined in Amazonka.MachineLearning.DescribeEvaluations

Associated Types

type Rep DescribeEvaluations :: Type -> Type

Methods

from :: DescribeEvaluations -> Rep DescribeEvaluations x

to :: Rep DescribeEvaluations x -> DescribeEvaluations

Read DescribeEvaluations

Defined in Amazonka.MachineLearning.DescribeEvaluations

Methods

readsPrec :: Int -> ReadS DescribeEvaluations

readList :: ReadS [DescribeEvaluations]

readPrec :: ReadPrec DescribeEvaluations

readListPrec :: ReadPrec [DescribeEvaluations]

Show DescribeEvaluations

Defined in Amazonka.MachineLearning.DescribeEvaluations

Methods

showsPrec :: Int -> DescribeEvaluations -> ShowS

show :: DescribeEvaluations -> String

showList :: [DescribeEvaluations] -> ShowS

NFData DescribeEvaluations

Defined in Amazonka.MachineLearning.DescribeEvaluations

Methods

rnf :: DescribeEvaluations -> ()

Eq DescribeEvaluations

Defined in Amazonka.MachineLearning.DescribeEvaluations

Methods

(==) :: DescribeEvaluations -> DescribeEvaluations -> Bool

(/=) :: DescribeEvaluations -> DescribeEvaluations -> Bool

Hashable DescribeEvaluations

Defined in Amazonka.MachineLearning.DescribeEvaluations

Methods

hashWithSalt :: Int -> DescribeEvaluations -> Int

hash :: DescribeEvaluations -> Int

type AWSResponse DescribeEvaluations

Defined in Amazonka.MachineLearning.DescribeEvaluations

type AWSResponse DescribeEvaluations = DescribeEvaluationsResponse

type Rep DescribeEvaluations

Defined in Amazonka.MachineLearning.DescribeEvaluations

type Rep DescribeEvaluations = D1 ('MetaData "DescribeEvaluations" "Amazonka.MachineLearning.DescribeEvaluations" "amazonka-ml-2.0-A3JLJ63WvmfHxGBBIqhdRA" 'False) (C1 ('MetaCons "DescribeEvaluations'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "eq") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "filterVariable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EvaluationFilterVariable))) :*: (S1 ('MetaSel ('Just "ge") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "gt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "le") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "lt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "ne") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)))))))

newDescribeEvaluations :: DescribeEvaluations

Create a value of DescribeEvaluations with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:eq:DescribeEvaluations', describeEvaluations_eq - The equal to operator. The Evaluation results will have FilterVariable values that exactly match the value specified with EQ.

$sel:filterVariable:DescribeEvaluations', describeEvaluations_filterVariable - Use one of the following variable to filter a list of Evaluation objects:

• CreatedAt - Sets the search criteria to the Evaluation creation date.
• Status - Sets the search criteria to the Evaluation status.
• Name - Sets the search criteria to the contents of Evaluation ____ Name.
• IAMUser - Sets the search criteria to the user account that invoked an Evaluation.
• MLModelId - Sets the search criteria to the MLModel that was evaluated.
• DataSourceId - Sets the search criteria to the DataSource used in Evaluation.
• DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

$sel:ge:DescribeEvaluations', describeEvaluations_ge - The greater than or equal to operator. The Evaluation results will have FilterVariable values that are greater than or equal to the value specified with GE.

$sel:gt:DescribeEvaluations', describeEvaluations_gt - The greater than operator. The Evaluation results will have FilterVariable values that are greater than the value specified with GT.

$sel:le:DescribeEvaluations', describeEvaluations_le - The less than or equal to operator. The Evaluation results will have FilterVariable values that are less than or equal to the value specified with LE.

$sel:lt:DescribeEvaluations', describeEvaluations_lt - The less than operator. The Evaluation results will have FilterVariable values that are less than the value specified with LT.

$sel:limit:DescribeEvaluations', describeEvaluations_limit - The maximum number of Evaluation to include in the result.

$sel:ne:DescribeEvaluations', describeEvaluations_ne - The not equal to operator. The Evaluation results will have FilterVariable values not equal to the value specified with NE.

DescribeEvaluations, describeEvaluations_nextToken - The ID of the page in the paginated results.

$sel:prefix:DescribeEvaluations', describeEvaluations_prefix - A string that is found at the beginning of a variable, such as Name or Id.

For example, an Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for this Evaluation, select Name for the FilterVariable and any of the following strings for the Prefix:

• 2014-09
• 2014-09-09
• 2014-09-09-Holiday

$sel:sortOrder:DescribeEvaluations', describeEvaluations_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.

Request Lenses

describeEvaluations_eq :: Lens' DescribeEvaluations (Maybe Text)

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

describeEvaluations_filterVariable :: Lens' DescribeEvaluations (Maybe EvaluationFilterVariable)

Use one of the following variable to filter a list of Evaluation objects:

• CreatedAt - Sets the search criteria to the Evaluation creation date.
• Status - Sets the search criteria to the Evaluation status.
• Name - Sets the search criteria to the contents of Evaluation ____ Name.
• IAMUser - Sets the search criteria to the user account that invoked an Evaluation.
• MLModelId - Sets the search criteria to the MLModel that was evaluated.
• DataSourceId - Sets the search criteria to the DataSource used in Evaluation.
• DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

describeEvaluations_ge :: Lens' DescribeEvaluations (Maybe Text)

The greater than or equal to operator. The Evaluation results will have FilterVariable values that are greater than or equal to the value specified with GE.

describeEvaluations_gt :: Lens' DescribeEvaluations (Maybe Text)

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

describeEvaluations_le :: Lens' DescribeEvaluations (Maybe Text)

The less than or equal to operator. The Evaluation results will have FilterVariable values that are less than or equal to the value specified with LE.

describeEvaluations_lt :: Lens' DescribeEvaluations (Maybe Text)

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

describeEvaluations_limit :: Lens' DescribeEvaluations (Maybe Natural)

The maximum number of Evaluation to include in the result.

describeEvaluations_ne :: Lens' DescribeEvaluations (Maybe Text)

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

describeEvaluations_nextToken :: Lens' DescribeEvaluations (Maybe Text)

The ID of the page in the paginated results.

describeEvaluations_prefix :: Lens' DescribeEvaluations (Maybe Text)

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

For example, an Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for this Evaluation, select Name for the FilterVariable and any of the following strings for the Prefix:

• 2014-09
• 2014-09-09
• 2014-09-09-Holiday

describeEvaluations_sortOrder :: Lens' DescribeEvaluations (Maybe 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.

Destructuring the Response

data DescribeEvaluationsResponse

Represents the query results from a DescribeEvaluations operation. The content is essentially a list of Evaluation.

See: newDescribeEvaluationsResponse smart constructor.

Constructors

DescribeEvaluationsResponse'

Fields

• nextToken :: Maybe Text

  The ID of the next page in the paginated results that indicates at least one more page follows.

• results :: Maybe [Evaluation]

  A list of Evaluation that meet the search criteria.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeEvaluationsResponse

Defined in Amazonka.MachineLearning.DescribeEvaluations

Associated Types

type Rep DescribeEvaluationsResponse :: Type -> Type

Methods

from :: DescribeEvaluationsResponse -> Rep DescribeEvaluationsResponse x

to :: Rep DescribeEvaluationsResponse x -> DescribeEvaluationsResponse

Read DescribeEvaluationsResponse

Defined in Amazonka.MachineLearning.DescribeEvaluations

Methods

readsPrec :: Int -> ReadS DescribeEvaluationsResponse

readList :: ReadS [DescribeEvaluationsResponse]

readPrec :: ReadPrec DescribeEvaluationsResponse

readListPrec :: ReadPrec [DescribeEvaluationsResponse]

Show DescribeEvaluationsResponse

Defined in Amazonka.MachineLearning.DescribeEvaluations

Methods

showsPrec :: Int -> DescribeEvaluationsResponse -> ShowS

show :: DescribeEvaluationsResponse -> String

showList :: [DescribeEvaluationsResponse] -> ShowS

NFData DescribeEvaluationsResponse

Defined in Amazonka.MachineLearning.DescribeEvaluations

Methods

rnf :: DescribeEvaluationsResponse -> ()

Eq DescribeEvaluationsResponse

Defined in Amazonka.MachineLearning.DescribeEvaluations

Methods

(==) :: DescribeEvaluationsResponse -> DescribeEvaluationsResponse -> Bool

(/=) :: DescribeEvaluationsResponse -> DescribeEvaluationsResponse -> Bool

type Rep DescribeEvaluationsResponse

Defined in Amazonka.MachineLearning.DescribeEvaluations

type Rep DescribeEvaluationsResponse = D1 ('MetaData "DescribeEvaluationsResponse" "Amazonka.MachineLearning.DescribeEvaluations" "amazonka-ml-2.0-A3JLJ63WvmfHxGBBIqhdRA" 'False) (C1 ('MetaCons "DescribeEvaluationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Evaluation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEvaluationsResponse

Arguments

:: Int

$sel:httpStatus:DescribeEvaluationsResponse'

-> DescribeEvaluationsResponse

Create a value of DescribeEvaluationsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeEvaluations, describeEvaluationsResponse_nextToken - The ID of the next page in the paginated results that indicates at least one more page follows.

$sel:results:DescribeEvaluationsResponse', describeEvaluationsResponse_results - A list of Evaluation that meet the search criteria.

$sel:httpStatus:DescribeEvaluationsResponse', describeEvaluationsResponse_httpStatus - The response's http status code.

Response Lenses

describeEvaluationsResponse_nextToken :: Lens' DescribeEvaluationsResponse (Maybe Text)

The ID of the next page in the paginated results that indicates at least one more page follows.

describeEvaluationsResponse_results :: Lens' DescribeEvaluationsResponse (Maybe [Evaluation])

A list of Evaluation that meet the search criteria.

describeEvaluationsResponse_httpStatus :: Lens' DescribeEvaluationsResponse Int

The response's http status code.