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.FraudDetector.GetModels

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets one or more models. Gets all models for the Amazon Web Services account if no model type and no model id provided. Gets all models for the Amazon Web Services account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified.

This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 1 and 10. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.

Synopsis

data GetModels = GetModels' {
- maxResults :: Maybe Natural
- modelId :: Maybe Text
- modelType :: Maybe ModelTypeEnum
- nextToken :: Maybe Text
}
newGetModels :: GetModels
getModels_maxResults :: Lens' GetModels (Maybe Natural)
getModels_modelId :: Lens' GetModels (Maybe Text)
getModels_modelType :: Lens' GetModels (Maybe ModelTypeEnum)
getModels_nextToken :: Lens' GetModels (Maybe Text)
data GetModelsResponse = GetModelsResponse' {
- models :: Maybe [Model]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetModelsResponse :: Int -> GetModelsResponse
getModelsResponse_models :: Lens' GetModelsResponse (Maybe [Model])
getModelsResponse_nextToken :: Lens' GetModelsResponse (Maybe Text)
getModelsResponse_httpStatus :: Lens' GetModelsResponse Int

Creating a Request

data GetModels Source #

See: newGetModels smart constructor.

Constructors

GetModels'
Fields maxResults :: Maybe Natural The maximum number of objects to return for the request. modelId :: Maybe Text The model ID. modelType :: Maybe ModelTypeEnum The model type. nextToken :: Maybe Text The next token for the subsequent request.

Instances

Instances details

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

newGetModels :: GetModels Source #

Create a value of GetModels 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:maxResults:GetModels', getModels_maxResults - The maximum number of objects to return for the request.

GetModels, getModels_modelId - The model ID.

GetModels, getModels_modelType - The model type.

GetModels, getModels_nextToken - The next token for the subsequent request.

Request Lenses

getModels_maxResults :: Lens' GetModels (Maybe Natural) Source #

The maximum number of objects to return for the request.

getModels_modelId :: Lens' GetModels (Maybe Text) Source #

The model ID.

getModels_modelType :: Lens' GetModels (Maybe ModelTypeEnum) Source #

The model type.

getModels_nextToken :: Lens' GetModels (Maybe Text) Source #

The next token for the subsequent request.

Destructuring the Response

data GetModelsResponse Source #

See: newGetModelsResponse smart constructor.

Constructors

GetModelsResponse'
Fields models :: Maybe [Model] The array of models. nextToken :: Maybe Text The next page token to be used in subsequent requests. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetModelsResponse Source #

Arguments

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

Create a value of GetModelsResponse 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:models:GetModelsResponse', getModelsResponse_models - The array of models.

GetModels, getModelsResponse_nextToken - The next page token to be used in subsequent requests.

$sel:httpStatus:GetModelsResponse', getModelsResponse_httpStatus - The response's http status code.

Response Lenses

getModelsResponse_models :: Lens' GetModelsResponse (Maybe [Model]) Source #

The array of models.

getModelsResponse_nextToken :: Lens' GetModelsResponse (Maybe Text) Source #

The next page token to be used in subsequent requests.

getModelsResponse_httpStatus :: Lens' GetModelsResponse Int Source #

The response's http status code.