Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.MachineLearning.DescribeBatchPredictions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

This operation returns paginated results.

Synopsis

data DescribeBatchPredictions = DescribeBatchPredictions' {
- eq :: Maybe Text
- filterVariable :: Maybe BatchPredictionFilterVariable
- ge :: Maybe Text
- gt :: Maybe Text
- le :: Maybe Text
- lt :: Maybe Text
- limit :: Maybe Natural
- ne :: Maybe Text
- nextToken :: Maybe Text
- prefix :: Maybe Text
- sortOrder :: Maybe SortOrder
}
newDescribeBatchPredictions :: DescribeBatchPredictions
describeBatchPredictions_eq :: Lens' DescribeBatchPredictions (Maybe Text)
describeBatchPredictions_filterVariable :: Lens' DescribeBatchPredictions (Maybe BatchPredictionFilterVariable)
describeBatchPredictions_ge :: Lens' DescribeBatchPredictions (Maybe Text)
describeBatchPredictions_gt :: Lens' DescribeBatchPredictions (Maybe Text)
describeBatchPredictions_le :: Lens' DescribeBatchPredictions (Maybe Text)
describeBatchPredictions_lt :: Lens' DescribeBatchPredictions (Maybe Text)
describeBatchPredictions_limit :: Lens' DescribeBatchPredictions (Maybe Natural)
describeBatchPredictions_ne :: Lens' DescribeBatchPredictions (Maybe Text)
describeBatchPredictions_nextToken :: Lens' DescribeBatchPredictions (Maybe Text)
describeBatchPredictions_prefix :: Lens' DescribeBatchPredictions (Maybe Text)
describeBatchPredictions_sortOrder :: Lens' DescribeBatchPredictions (Maybe SortOrder)
data DescribeBatchPredictionsResponse = DescribeBatchPredictionsResponse' {
- nextToken :: Maybe Text
- results :: Maybe [BatchPrediction]
- httpStatus :: Int
}
newDescribeBatchPredictionsResponse :: Int -> DescribeBatchPredictionsResponse
describeBatchPredictionsResponse_nextToken :: Lens' DescribeBatchPredictionsResponse (Maybe Text)
describeBatchPredictionsResponse_results :: Lens' DescribeBatchPredictionsResponse (Maybe [BatchPrediction])
describeBatchPredictionsResponse_httpStatus :: Lens' DescribeBatchPredictionsResponse Int

Creating a Request

data DescribeBatchPredictions Source #

See: newDescribeBatchPredictions smart constructor.

Constructors

DescribeBatchPredictions'

Fields

eq :: Maybe Text
The equal to operator. The BatchPrediction results will have FilterVariable values that exactly match the value specified with EQ.
filterVariable :: Maybe BatchPredictionFilterVariable
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.
ge :: Maybe Text
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.
gt :: Maybe Text
The greater than operator. The BatchPrediction 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 BatchPrediction 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 BatchPrediction results will have FilterVariable values that are less than the value specified with LT.
limit :: Maybe Natural
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.
ne :: Maybe Text
The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE.
nextToken :: Maybe Text
An 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, 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 :: Maybe SortOrder
A two-value parameter that determines the sequence of the resulting list of MLModels.
- 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 DescribeBatchPredictions Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions Methods toJSON :: DescribeBatchPredictions -> Value # toEncoding :: DescribeBatchPredictions -> Encoding # toJSONList :: [DescribeBatchPredictions] -> Value # toEncodingList :: [DescribeBatchPredictions] -> Encoding #
ToHeaders DescribeBatchPredictions Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions Methods toHeaders :: DescribeBatchPredictions -> [Header] #
ToPath DescribeBatchPredictions Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions Methods toPath :: DescribeBatchPredictions -> ByteString #
ToQuery DescribeBatchPredictions Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions Methods toQuery :: DescribeBatchPredictions -> QueryString #
AWSPager DescribeBatchPredictions Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions Methods page :: DescribeBatchPredictions -> AWSResponse DescribeBatchPredictions -> Maybe DescribeBatchPredictions #
AWSRequest DescribeBatchPredictions Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions Associated Types type AWSResponse DescribeBatchPredictions # Methods request :: (Service -> Service) -> DescribeBatchPredictions -> Request DescribeBatchPredictions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeBatchPredictions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeBatchPredictions))) #
Generic DescribeBatchPredictions Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions Associated Types type Rep DescribeBatchPredictions :: Type -> Type # Methods from :: DescribeBatchPredictions -> Rep DescribeBatchPredictions x # to :: Rep DescribeBatchPredictions x -> DescribeBatchPredictions #
Read DescribeBatchPredictions Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions Methods readsPrec :: Int -> ReadS DescribeBatchPredictions # readList :: ReadS [DescribeBatchPredictions] # readPrec :: ReadPrec DescribeBatchPredictions # readListPrec :: ReadPrec [DescribeBatchPredictions] #
Show DescribeBatchPredictions Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions Methods showsPrec :: Int -> DescribeBatchPredictions -> ShowS # show :: DescribeBatchPredictions -> String # showList :: [DescribeBatchPredictions] -> ShowS #
NFData DescribeBatchPredictions Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions Methods rnf :: DescribeBatchPredictions -> () #
Eq DescribeBatchPredictions Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions Methods (==) :: DescribeBatchPredictions -> DescribeBatchPredictions -> Bool # (/=) :: DescribeBatchPredictions -> DescribeBatchPredictions -> Bool #
Hashable DescribeBatchPredictions Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions Methods hashWithSalt :: Int -> DescribeBatchPredictions -> Int # hash :: DescribeBatchPredictions -> Int #
type AWSResponse DescribeBatchPredictions Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions type AWSResponse DescribeBatchPredictions = DescribeBatchPredictionsResponse
type Rep DescribeBatchPredictions Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions type Rep DescribeBatchPredictions = D1 ('MetaData "DescribeBatchPredictions" "Amazonka.MachineLearning.DescribeBatchPredictions" "amazonka-ml-2.0-A3JLJ63WvmfHxGBBIqhdRA" 'False) (C1 ('MetaCons "DescribeBatchPredictions'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "eq") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "filterVariable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchPredictionFilterVariable))) :: (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)))))))

newDescribeBatchPredictions :: DescribeBatchPredictions Source #

Create a value of DescribeBatchPredictions 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:DescribeBatchPredictions', describeBatchPredictions_eq - The equal to operator. The BatchPrediction results will have FilterVariable values that exactly match the value specified with EQ.

$sel:filterVariable:DescribeBatchPredictions', describeBatchPredictions_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.

$sel:ge:DescribeBatchPredictions', describeBatchPredictions_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.

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

$sel:le:DescribeBatchPredictions', describeBatchPredictions_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.

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

$sel:limit:DescribeBatchPredictions', describeBatchPredictions_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.

$sel:ne:DescribeBatchPredictions', describeBatchPredictions_ne - The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE.

DescribeBatchPredictions, describeBatchPredictions_nextToken - An ID of the page in the paginated results.

$sel:prefix:DescribeBatchPredictions', describeBatchPredictions_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

$sel:sortOrder:DescribeBatchPredictions', describeBatchPredictions_sortOrder - A two-value parameter that determines the sequence of the resulting list of MLModels.

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

describeBatchPredictions_eq :: Lens' DescribeBatchPredictions (Maybe Text) Source #

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

describeBatchPredictions_filterVariable :: Lens' DescribeBatchPredictions (Maybe BatchPredictionFilterVariable) Source #

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.

describeBatchPredictions_ge :: Lens' DescribeBatchPredictions (Maybe Text) Source #

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.

describeBatchPredictions_gt :: Lens' DescribeBatchPredictions (Maybe Text) Source #

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

describeBatchPredictions_le :: Lens' DescribeBatchPredictions (Maybe Text) Source #

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.

describeBatchPredictions_lt :: Lens' DescribeBatchPredictions (Maybe Text) Source #

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

describeBatchPredictions_limit :: Lens' DescribeBatchPredictions (Maybe Natural) Source #

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.

describeBatchPredictions_ne :: Lens' DescribeBatchPredictions (Maybe Text) Source #

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

describeBatchPredictions_nextToken :: Lens' DescribeBatchPredictions (Maybe Text) Source #

An ID of the page in the paginated results.

describeBatchPredictions_prefix :: Lens' DescribeBatchPredictions (Maybe Text) Source #

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

describeBatchPredictions_sortOrder :: Lens' DescribeBatchPredictions (Maybe SortOrder) Source #

A two-value parameter that determines the sequence of the resulting list of MLModels.

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

Represents the output of a DescribeBatchPredictions operation. The content is essentially a list of BatchPredictions.

See: newDescribeBatchPredictionsResponse smart constructor.

Constructors

DescribeBatchPredictionsResponse'
Fields nextToken :: Maybe Text The ID of the next page in the paginated results that indicates at least one more page follows. results :: Maybe [BatchPrediction] A list of `BatchPrediction` objects that meet the search criteria. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeBatchPredictionsResponse Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions Associated Types type Rep DescribeBatchPredictionsResponse :: Type -> Type # Methods from :: DescribeBatchPredictionsResponse -> Rep DescribeBatchPredictionsResponse x # to :: Rep DescribeBatchPredictionsResponse x -> DescribeBatchPredictionsResponse #
Read DescribeBatchPredictionsResponse Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions Methods readsPrec :: Int -> ReadS DescribeBatchPredictionsResponse # readList :: ReadS [DescribeBatchPredictionsResponse] # readPrec :: ReadPrec DescribeBatchPredictionsResponse # readListPrec :: ReadPrec [DescribeBatchPredictionsResponse] #
Show DescribeBatchPredictionsResponse Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions Methods showsPrec :: Int -> DescribeBatchPredictionsResponse -> ShowS # show :: DescribeBatchPredictionsResponse -> String # showList :: [DescribeBatchPredictionsResponse] -> ShowS #
NFData DescribeBatchPredictionsResponse Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions Methods rnf :: DescribeBatchPredictionsResponse -> () #
Eq DescribeBatchPredictionsResponse Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions Methods (==) :: DescribeBatchPredictionsResponse -> DescribeBatchPredictionsResponse -> Bool # (/=) :: DescribeBatchPredictionsResponse -> DescribeBatchPredictionsResponse -> Bool #
type Rep DescribeBatchPredictionsResponse Source #
Instance details Defined in Amazonka.MachineLearning.DescribeBatchPredictions type Rep DescribeBatchPredictionsResponse = D1 ('MetaData "DescribeBatchPredictionsResponse" "Amazonka.MachineLearning.DescribeBatchPredictions" "amazonka-ml-2.0-A3JLJ63WvmfHxGBBIqhdRA" 'False) (C1 ('MetaCons "DescribeBatchPredictionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BatchPrediction])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeBatchPredictionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeBatchPredictionsResponse'`
-> DescribeBatchPredictionsResponse

Create a value of DescribeBatchPredictionsResponse 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:

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

$sel:results:DescribeBatchPredictionsResponse', describeBatchPredictionsResponse_results - A list of BatchPrediction objects that meet the search criteria.

$sel:httpStatus:DescribeBatchPredictionsResponse', describeBatchPredictionsResponse_httpStatus - The response's http status code.

Response Lenses

describeBatchPredictionsResponse_nextToken :: Lens' DescribeBatchPredictionsResponse (Maybe Text) Source #

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

describeBatchPredictionsResponse_results :: Lens' DescribeBatchPredictionsResponse (Maybe [BatchPrediction]) Source #

A list of BatchPrediction objects that meet the search criteria.

describeBatchPredictionsResponse_httpStatus :: Lens' DescribeBatchPredictionsResponse Int Source #

The response's http status code.