amazonka-ml-2.0: Amazon Machine Learning SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MachineLearning.DescribeEvaluations

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeEvaluations Source #

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

Instances details
ToJSON DescribeEvaluations Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

ToHeaders DescribeEvaluations Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

ToPath DescribeEvaluations Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

ToQuery DescribeEvaluations Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

AWSPager DescribeEvaluations Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

AWSRequest DescribeEvaluations Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

Associated Types

type AWSResponse DescribeEvaluations #

Generic DescribeEvaluations Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

Associated Types

type Rep DescribeEvaluations :: Type -> Type #

Read DescribeEvaluations Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

Show DescribeEvaluations Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

NFData DescribeEvaluations Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

Methods

rnf :: DescribeEvaluations -> () #

Eq DescribeEvaluations Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

Hashable DescribeEvaluations Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

type AWSResponse DescribeEvaluations Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

type Rep DescribeEvaluations Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

newDescribeEvaluations :: DescribeEvaluations Source #

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) Source #

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) Source #

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) Source #

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) Source #

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) Source #

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) Source #

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) Source #

The maximum number of Evaluation to include in the result.

describeEvaluations_ne :: Lens' DescribeEvaluations (Maybe Text) Source #

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) Source #

The ID of the page in the paginated results.

describeEvaluations_prefix :: Lens' DescribeEvaluations (Maybe Text) Source #

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) Source #

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 Source #

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

See: newDescribeEvaluationsResponse smart constructor.

Constructors

DescribeEvaluationsResponse' 

Fields

Instances

Instances details
Generic DescribeEvaluationsResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

Associated Types

type Rep DescribeEvaluationsResponse :: Type -> Type #

Read DescribeEvaluationsResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

Show DescribeEvaluationsResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

NFData DescribeEvaluationsResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

Eq DescribeEvaluationsResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.DescribeEvaluations

type Rep DescribeEvaluationsResponse Source # 
Instance details

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 Source #

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) Source #

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

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

A list of Evaluation that meet the search criteria.