Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.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

describeBatchPredictions :: DescribeBatchPredictions
data DescribeBatchPredictions
dbpEQ :: Lens' DescribeBatchPredictions (Maybe Text)
dbpGE :: Lens' DescribeBatchPredictions (Maybe Text)
dbpPrefix :: Lens' DescribeBatchPredictions (Maybe Text)
dbpGT :: Lens' DescribeBatchPredictions (Maybe Text)
dbpNE :: Lens' DescribeBatchPredictions (Maybe Text)
dbpNextToken :: Lens' DescribeBatchPredictions (Maybe Text)
dbpSortOrder :: Lens' DescribeBatchPredictions (Maybe SortOrder)
dbpLimit :: Lens' DescribeBatchPredictions (Maybe Natural)
dbpLT :: Lens' DescribeBatchPredictions (Maybe Text)
dbpFilterVariable :: Lens' DescribeBatchPredictions (Maybe BatchPredictionFilterVariable)
dbpLE :: Lens' DescribeBatchPredictions (Maybe Text)
describeBatchPredictionsResponse :: Int -> DescribeBatchPredictionsResponse
data DescribeBatchPredictionsResponse
dbpsrsResults :: Lens' DescribeBatchPredictionsResponse [BatchPrediction]
dbpsrsNextToken :: Lens' DescribeBatchPredictionsResponse (Maybe Text)
dbpsrsResponseStatus :: Lens' DescribeBatchPredictionsResponse Int

Creating a Request

describeBatchPredictions :: DescribeBatchPredictions #

Creates a value of DescribeBatchPredictions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dbpEQ - The equal to operator. The BatchPrediction results will have FilterVariable values that exactly match the value specified with EQ .
dbpGE - 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 .
dbpPrefix - 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
dbpGT - The greater than operator. The BatchPrediction results will have FilterVariable values that are greater than the value specified with GT .
dbpNE - The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE .
dbpNextToken - An ID of the page in the paginated results.
dbpSortOrder - 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 .
dbpLimit - 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 .
dbpLT - The less than operator. The BatchPrediction results will have FilterVariable values that are less than the value specified with LT .
dbpFilterVariable - 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.
dbpLE - 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 .

data DescribeBatchPredictions #

See: describeBatchPredictions smart constructor.

Instances

Eq DescribeBatchPredictions #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Methods (==) :: DescribeBatchPredictions -> DescribeBatchPredictions -> Bool # (/=) :: DescribeBatchPredictions -> DescribeBatchPredictions -> Bool #
Data DescribeBatchPredictions #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeBatchPredictions -> c DescribeBatchPredictions # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeBatchPredictions # toConstr :: DescribeBatchPredictions -> Constr # dataTypeOf :: DescribeBatchPredictions -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeBatchPredictions) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeBatchPredictions) # gmapT :: (forall b. Data b => b -> b) -> DescribeBatchPredictions -> DescribeBatchPredictions # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeBatchPredictions -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeBatchPredictions -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeBatchPredictions -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeBatchPredictions -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeBatchPredictions -> m DescribeBatchPredictions # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeBatchPredictions -> m DescribeBatchPredictions # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeBatchPredictions -> m DescribeBatchPredictions #
Read DescribeBatchPredictions #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Methods readsPrec :: Int -> ReadS DescribeBatchPredictions # readList :: ReadS [DescribeBatchPredictions] # readPrec :: ReadPrec DescribeBatchPredictions # readListPrec :: ReadPrec [DescribeBatchPredictions] #
Show DescribeBatchPredictions #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Methods showsPrec :: Int -> DescribeBatchPredictions -> ShowS # show :: DescribeBatchPredictions -> String # showList :: [DescribeBatchPredictions] -> ShowS #
Generic DescribeBatchPredictions #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Associated Types type Rep DescribeBatchPredictions :: * -> * # Methods from :: DescribeBatchPredictions -> Rep DescribeBatchPredictions x # to :: Rep DescribeBatchPredictions x -> DescribeBatchPredictions #
Hashable DescribeBatchPredictions #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Methods hashWithSalt :: Int -> DescribeBatchPredictions -> Int # hash :: DescribeBatchPredictions -> Int #
ToJSON DescribeBatchPredictions #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Methods toJSON :: DescribeBatchPredictions -> Value # toEncoding :: DescribeBatchPredictions -> Encoding # toJSONList :: [DescribeBatchPredictions] -> Value # toEncodingList :: [DescribeBatchPredictions] -> Encoding #
AWSPager DescribeBatchPredictions #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Methods page :: DescribeBatchPredictions -> Rs DescribeBatchPredictions -> Maybe DescribeBatchPredictions #
AWSRequest DescribeBatchPredictions #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Associated Types type Rs DescribeBatchPredictions :: * # Methods request :: DescribeBatchPredictions -> Request DescribeBatchPredictions # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeBatchPredictions -> ClientResponse -> m (Response DescribeBatchPredictions) #
ToHeaders DescribeBatchPredictions #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Methods toHeaders :: DescribeBatchPredictions -> [Header] #
ToPath DescribeBatchPredictions #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Methods toPath :: DescribeBatchPredictions -> ByteString #
ToQuery DescribeBatchPredictions #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Methods toQuery :: DescribeBatchPredictions -> QueryString #
NFData DescribeBatchPredictions #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Methods rnf :: DescribeBatchPredictions -> () #
type Rep DescribeBatchPredictions #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions type Rep DescribeBatchPredictions = D1 (MetaData "DescribeBatchPredictions" "Network.AWS.MachineLearning.DescribeBatchPredictions" "amazonka-ml-1.6.0-1P3zVrakzeC6pQua2SKozx" False) (C1 (MetaCons "DescribeBatchPredictions'" PrefixI True) (((S1 (MetaSel (Just "_dbpEQ") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_dbpGE") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_dbpPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_dbpGT") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_dbpNE") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 (MetaSel (Just "_dbpNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_dbpSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SortOrder)) :: S1 (MetaSel (Just "_dbpLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))) :: (S1 (MetaSel (Just "_dbpLT") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_dbpFilterVariable") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe BatchPredictionFilterVariable)) :: S1 (MetaSel (Just "_dbpLE") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Rs DescribeBatchPredictions #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions type Rs DescribeBatchPredictions = DescribeBatchPredictionsResponse

Request Lenses

dbpEQ :: Lens' DescribeBatchPredictions (Maybe Text) #

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

dbpGE :: Lens' DescribeBatchPredictions (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 .

dbpPrefix :: Lens' DescribeBatchPredictions (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

dbpGT :: Lens' DescribeBatchPredictions (Maybe Text) #

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

dbpNE :: Lens' DescribeBatchPredictions (Maybe Text) #

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

dbpNextToken :: Lens' DescribeBatchPredictions (Maybe Text) #

An ID of the page in the paginated results.

dbpSortOrder :: Lens' DescribeBatchPredictions (Maybe 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 .

dbpLimit :: Lens' DescribeBatchPredictions (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 .

dbpLT :: Lens' DescribeBatchPredictions (Maybe Text) #

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

dbpFilterVariable :: Lens' DescribeBatchPredictions (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.

dbpLE :: Lens' DescribeBatchPredictions (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 .

Destructuring the Response

describeBatchPredictionsResponse #

Arguments

:: Int	`dbpsrsResponseStatus`
-> DescribeBatchPredictionsResponse

Creates a value of DescribeBatchPredictionsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dbpsrsResults - A list of BatchPrediction objects that meet the search criteria.
dbpsrsNextToken - The ID of the next page in the paginated results that indicates at least one more page follows.
dbpsrsResponseStatus - -- | The response status code.

data DescribeBatchPredictionsResponse #

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

See: describeBatchPredictionsResponse smart constructor.

Instances

Eq DescribeBatchPredictionsResponse #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Methods (==) :: DescribeBatchPredictionsResponse -> DescribeBatchPredictionsResponse -> Bool # (/=) :: DescribeBatchPredictionsResponse -> DescribeBatchPredictionsResponse -> Bool #
Data DescribeBatchPredictionsResponse #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeBatchPredictionsResponse -> c DescribeBatchPredictionsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeBatchPredictionsResponse # toConstr :: DescribeBatchPredictionsResponse -> Constr # dataTypeOf :: DescribeBatchPredictionsResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeBatchPredictionsResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeBatchPredictionsResponse) # gmapT :: (forall b. Data b => b -> b) -> DescribeBatchPredictionsResponse -> DescribeBatchPredictionsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeBatchPredictionsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeBatchPredictionsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeBatchPredictionsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeBatchPredictionsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeBatchPredictionsResponse -> m DescribeBatchPredictionsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeBatchPredictionsResponse -> m DescribeBatchPredictionsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeBatchPredictionsResponse -> m DescribeBatchPredictionsResponse #
Read DescribeBatchPredictionsResponse #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Methods readsPrec :: Int -> ReadS DescribeBatchPredictionsResponse # readList :: ReadS [DescribeBatchPredictionsResponse] # readPrec :: ReadPrec DescribeBatchPredictionsResponse # readListPrec :: ReadPrec [DescribeBatchPredictionsResponse] #
Show DescribeBatchPredictionsResponse #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Methods showsPrec :: Int -> DescribeBatchPredictionsResponse -> ShowS # show :: DescribeBatchPredictionsResponse -> String # showList :: [DescribeBatchPredictionsResponse] -> ShowS #
Generic DescribeBatchPredictionsResponse #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Associated Types type Rep DescribeBatchPredictionsResponse :: * -> * # Methods from :: DescribeBatchPredictionsResponse -> Rep DescribeBatchPredictionsResponse x # to :: Rep DescribeBatchPredictionsResponse x -> DescribeBatchPredictionsResponse #
NFData DescribeBatchPredictionsResponse #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions Methods rnf :: DescribeBatchPredictionsResponse -> () #
type Rep DescribeBatchPredictionsResponse #
Instance details Defined in Network.AWS.MachineLearning.DescribeBatchPredictions type Rep DescribeBatchPredictionsResponse = D1 (MetaData "DescribeBatchPredictionsResponse" "Network.AWS.MachineLearning.DescribeBatchPredictions" "amazonka-ml-1.6.0-1P3zVrakzeC6pQua2SKozx" False) (C1 (MetaCons "DescribeBatchPredictionsResponse'" PrefixI True) (S1 (MetaSel (Just "_dbpsrsResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [BatchPrediction])) :: (S1 (MetaSel (Just "_dbpsrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_dbpsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

dbpsrsResults :: Lens' DescribeBatchPredictionsResponse [BatchPrediction] #

A list of BatchPrediction objects that meet the search criteria.

dbpsrsNextToken :: Lens' DescribeBatchPredictionsResponse (Maybe Text) #

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

dbpsrsResponseStatus :: Lens' DescribeBatchPredictionsResponse Int #

- | The response status code.