Copyright	(c) 2013-2021 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

Amazonka.FraudDetector.GetLabels

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets all labels or a specific label if name is provided. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 10 and 50. To get the next page results, provide the pagination token from the GetGetLabelsResponse as part of your request. A null pagination token fetches the records from the beginning.

Synopsis

data GetLabels = GetLabels' {
- nextToken :: Maybe Text
- name :: Maybe Text
- maxResults :: Maybe Natural
}
newGetLabels :: GetLabels
getLabels_nextToken :: Lens' GetLabels (Maybe Text)
getLabels_name :: Lens' GetLabels (Maybe Text)
getLabels_maxResults :: Lens' GetLabels (Maybe Natural)
data GetLabelsResponse = GetLabelsResponse' {
- nextToken :: Maybe Text
- labels :: Maybe [Label]
- httpStatus :: Int
}
newGetLabelsResponse :: Int -> GetLabelsResponse
getLabelsResponse_nextToken :: Lens' GetLabelsResponse (Maybe Text)
getLabelsResponse_labels :: Lens' GetLabelsResponse (Maybe [Label])
getLabelsResponse_httpStatus :: Lens' GetLabelsResponse Int

Creating a Request

data GetLabels Source #

See: newGetLabels smart constructor.

Constructors

GetLabels'
Fields nextToken :: Maybe Text The next token for the subsequent request. name :: Maybe Text The name of the label or labels to get. maxResults :: Maybe Natural The maximum number of objects to return for the request.

Instances

Instances details

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

newGetLabels :: GetLabels Source #

Create a value of GetLabels 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:nextToken:GetLabels', getLabels_nextToken - The next token for the subsequent request.

$sel:name:GetLabels', getLabels_name - The name of the label or labels to get.

$sel:maxResults:GetLabels', getLabels_maxResults - The maximum number of objects to return for the request.

Request Lenses

getLabels_nextToken :: Lens' GetLabels (Maybe Text) Source #

The next token for the subsequent request.

getLabels_name :: Lens' GetLabels (Maybe Text) Source #

The name of the label or labels to get.

getLabels_maxResults :: Lens' GetLabels (Maybe Natural) Source #

The maximum number of objects to return for the request.

Destructuring the Response

data GetLabelsResponse Source #

See: newGetLabelsResponse smart constructor.

Constructors

GetLabelsResponse'
Fields nextToken :: Maybe Text The next page token. labels :: Maybe [Label] An array of labels. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetLabelsResponse Source #

Arguments

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

Create a value of GetLabelsResponse 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:nextToken:GetLabels', getLabelsResponse_nextToken - The next page token.

$sel:labels:GetLabelsResponse', getLabelsResponse_labels - An array of labels.

$sel:httpStatus:GetLabelsResponse', getLabelsResponse_httpStatus - The response's http status code.

Response Lenses

getLabelsResponse_nextToken :: Lens' GetLabelsResponse (Maybe Text) Source #

The next page token.

getLabelsResponse_labels :: Lens' GetLabelsResponse (Maybe [Label]) Source #

An array of labels.

getLabelsResponse_httpStatus :: Lens' GetLabelsResponse Int Source #

The response's http status code.