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.LookoutEquipment.ListModels

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Generates a list of all models in the account, including model name and ARN, dataset, and status.

Synopsis

data ListModels = ListModels' {
- datasetNameBeginsWith :: Maybe Text
- maxResults :: Maybe Natural
- modelNameBeginsWith :: Maybe Text
- nextToken :: Maybe Text
- status :: Maybe ModelStatus
}
newListModels :: ListModels
listModels_datasetNameBeginsWith :: Lens' ListModels (Maybe Text)
listModels_maxResults :: Lens' ListModels (Maybe Natural)
listModels_modelNameBeginsWith :: Lens' ListModels (Maybe Text)
listModels_nextToken :: Lens' ListModels (Maybe Text)
listModels_status :: Lens' ListModels (Maybe ModelStatus)
data ListModelsResponse = ListModelsResponse' {
- modelSummaries :: Maybe [ModelSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListModelsResponse :: Int -> ListModelsResponse
listModelsResponse_modelSummaries :: Lens' ListModelsResponse (Maybe [ModelSummary])
listModelsResponse_nextToken :: Lens' ListModelsResponse (Maybe Text)
listModelsResponse_httpStatus :: Lens' ListModelsResponse Int

Creating a Request

data ListModels Source #

See: newListModels smart constructor.

Constructors

ListModels'

Fields

datasetNameBeginsWith :: Maybe Text
The beginning of the name of the dataset of the ML models to be listed.
maxResults :: Maybe Natural
Specifies the maximum number of ML models to list.
modelNameBeginsWith :: Maybe Text
The beginning of the name of the ML models being listed.
nextToken :: Maybe Text
An opaque pagination token indicating where to continue the listing of ML models.
status :: Maybe ModelStatus
The status of the ML model.

Instances

Instances details

ToJSON ListModels Source #
Instance details Defined in Amazonka.LookoutEquipment.ListModels Methods toJSON :: ListModels -> Value # toEncoding :: ListModels -> Encoding # toJSONList :: [ListModels] -> Value # toEncodingList :: [ListModels] -> Encoding #
ToHeaders ListModels Source #
Instance details Defined in Amazonka.LookoutEquipment.ListModels Methods toHeaders :: ListModels -> [Header] #
ToPath ListModels Source #
Instance details Defined in Amazonka.LookoutEquipment.ListModels Methods toPath :: ListModels -> ByteString #
ToQuery ListModels Source #
Instance details Defined in Amazonka.LookoutEquipment.ListModels Methods toQuery :: ListModels -> QueryString #
AWSRequest ListModels Source #
Instance details Defined in Amazonka.LookoutEquipment.ListModels Associated Types type AWSResponse ListModels # Methods request :: (Service -> Service) -> ListModels -> Request ListModels # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListModels -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListModels))) #
Generic ListModels Source #
Instance details Defined in Amazonka.LookoutEquipment.ListModels Associated Types type Rep ListModels :: Type -> Type # Methods from :: ListModels -> Rep ListModels x # to :: Rep ListModels x -> ListModels #
Read ListModels Source #
Instance details Defined in Amazonka.LookoutEquipment.ListModels Methods readsPrec :: Int -> ReadS ListModels # readList :: ReadS [ListModels] # readPrec :: ReadPrec ListModels # readListPrec :: ReadPrec [ListModels] #
Show ListModels Source #
Instance details Defined in Amazonka.LookoutEquipment.ListModels Methods showsPrec :: Int -> ListModels -> ShowS # show :: ListModels -> String # showList :: [ListModels] -> ShowS #
NFData ListModels Source #
Instance details Defined in Amazonka.LookoutEquipment.ListModels Methods rnf :: ListModels -> () #
Eq ListModels Source #
Instance details Defined in Amazonka.LookoutEquipment.ListModels Methods (==) :: ListModels -> ListModels -> Bool # (/=) :: ListModels -> ListModels -> Bool #
Hashable ListModels Source #
Instance details Defined in Amazonka.LookoutEquipment.ListModels Methods hashWithSalt :: Int -> ListModels -> Int # hash :: ListModels -> Int #
type AWSResponse ListModels Source #
Instance details Defined in Amazonka.LookoutEquipment.ListModels type AWSResponse ListModels = ListModelsResponse
type Rep ListModels Source #
Instance details Defined in Amazonka.LookoutEquipment.ListModels type Rep ListModels = D1 ('MetaData "ListModels" "Amazonka.LookoutEquipment.ListModels" "amazonka-lookoutequipment-2.0-FBtgEViQ46F6elHeNaa8oC" 'False) (C1 ('MetaCons "ListModels'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "datasetNameBeginsWith") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "modelNameBeginsWith") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelStatus))))))

newListModels :: ListModels Source #

Create a value of ListModels 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:datasetNameBeginsWith:ListModels', listModels_datasetNameBeginsWith - The beginning of the name of the dataset of the ML models to be listed.

$sel:maxResults:ListModels', listModels_maxResults - Specifies the maximum number of ML models to list.

$sel:modelNameBeginsWith:ListModels', listModels_modelNameBeginsWith - The beginning of the name of the ML models being listed.

ListModels, listModels_nextToken - An opaque pagination token indicating where to continue the listing of ML models.

ListModels, listModels_status - The status of the ML model.

Request Lenses

listModels_datasetNameBeginsWith :: Lens' ListModels (Maybe Text) Source #

The beginning of the name of the dataset of the ML models to be listed.

listModels_maxResults :: Lens' ListModels (Maybe Natural) Source #

Specifies the maximum number of ML models to list.

listModels_modelNameBeginsWith :: Lens' ListModels (Maybe Text) Source #

The beginning of the name of the ML models being listed.

listModels_nextToken :: Lens' ListModels (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of ML models.

listModels_status :: Lens' ListModels (Maybe ModelStatus) Source #

The status of the ML model.

Destructuring the Response

data ListModelsResponse Source #

See: newListModelsResponse smart constructor.

Constructors

ListModelsResponse'
Fields modelSummaries :: Maybe [ModelSummary] Provides information on the specified model, including created time, model and dataset ARNs, and status. nextToken :: Maybe Text An opaque pagination token indicating where to continue the listing of ML models. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListModelsResponse Source #

Arguments

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

Create a value of ListModelsResponse 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:modelSummaries:ListModelsResponse', listModelsResponse_modelSummaries - Provides information on the specified model, including created time, model and dataset ARNs, and status.

ListModels, listModelsResponse_nextToken - An opaque pagination token indicating where to continue the listing of ML models.

$sel:httpStatus:ListModelsResponse', listModelsResponse_httpStatus - The response's http status code.

Response Lenses

listModelsResponse_modelSummaries :: Lens' ListModelsResponse (Maybe [ModelSummary]) Source #

Provides information on the specified model, including created time, model and dataset ARNs, and status.

listModelsResponse_nextToken :: Lens' ListModelsResponse (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of ML models.

listModelsResponse_httpStatus :: Lens' ListModelsResponse Int Source #

The response's http status code.