Amazonka.FraudDetector.GetLabels

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.

Creating a Request

data GetLabels

See: newGetLabels smart constructor.

Constructors

GetLabels'

Fields

• maxResults :: Maybe Natural

  The maximum number of objects to return for the request.

• name :: Maybe Text

  The name of the label or labels to get.

• nextToken :: Maybe Text

  The next token for the subsequent request.

Instances

ToJSON GetLabels

Defined in Amazonka.FraudDetector.GetLabels

Methods

toJSON :: GetLabels -> Value

toEncoding :: GetLabels -> Encoding

toJSONList :: [GetLabels] -> Value

toEncodingList :: [GetLabels] -> Encoding

ToHeaders GetLabels

Defined in Amazonka.FraudDetector.GetLabels

Methods

toHeaders :: GetLabels -> [Header]

ToPath GetLabels

Defined in Amazonka.FraudDetector.GetLabels

Methods

toPath :: GetLabels -> ByteString

ToQuery GetLabels

Defined in Amazonka.FraudDetector.GetLabels

Methods

toQuery :: GetLabels -> QueryString

AWSRequest GetLabels

Defined in Amazonka.FraudDetector.GetLabels

Associated Types

type AWSResponse GetLabels

Methods

request :: (Service -> Service) -> GetLabels -> Request GetLabels

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetLabels -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetLabels)))

Generic GetLabels

Defined in Amazonka.FraudDetector.GetLabels

Associated Types

type Rep GetLabels :: Type -> Type

Methods

from :: GetLabels -> Rep GetLabels x

to :: Rep GetLabels x -> GetLabels

Read GetLabels

Defined in Amazonka.FraudDetector.GetLabels

Methods

readsPrec :: Int -> ReadS GetLabels

readList :: ReadS [GetLabels]

readPrec :: ReadPrec GetLabels

readListPrec :: ReadPrec [GetLabels]

Show GetLabels

Defined in Amazonka.FraudDetector.GetLabels

Methods

showsPrec :: Int -> GetLabels -> ShowS

show :: GetLabels -> String

showList :: [GetLabels] -> ShowS

NFData GetLabels

Defined in Amazonka.FraudDetector.GetLabels

Methods

rnf :: GetLabels -> ()

Eq GetLabels

Defined in Amazonka.FraudDetector.GetLabels

Methods

(==) :: GetLabels -> GetLabels -> Bool

(/=) :: GetLabels -> GetLabels -> Bool

Hashable GetLabels

Defined in Amazonka.FraudDetector.GetLabels

Methods

hashWithSalt :: Int -> GetLabels -> Int

hash :: GetLabels -> Int

type AWSResponse GetLabels

Defined in Amazonka.FraudDetector.GetLabels

type AWSResponse GetLabels = GetLabelsResponse

type Rep GetLabels

Defined in Amazonka.FraudDetector.GetLabels

type Rep GetLabels = D1 ('MetaData "GetLabels" "Amazonka.FraudDetector.GetLabels" "amazonka-frauddetector-2.0-CdXFXtLV8DgKo4Kta7Jw61" 'False) (C1 ('MetaCons "GetLabels'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newGetLabels :: GetLabels

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:maxResults:GetLabels', getLabels_maxResults - The maximum number of objects to return for the request.

GetLabels, getLabels_name - The name of the label or labels to get.

GetLabels, getLabels_nextToken - The next token for the subsequent request.

Request Lenses

getLabels_maxResults :: Lens' GetLabels (Maybe Natural)

The maximum number of objects to return for the request.

getLabels_name :: Lens' GetLabels (Maybe Text)

The name of the label or labels to get.

getLabels_nextToken :: Lens' GetLabels (Maybe Text)

The next token for the subsequent request.

Destructuring the Response

data GetLabelsResponse

See: newGetLabelsResponse smart constructor.

Constructors

GetLabelsResponse'

Fields

• labels :: Maybe [Label]

  An array of labels.

• nextToken :: Maybe Text

  The next page token.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetLabelsResponse

Defined in Amazonka.FraudDetector.GetLabels

Associated Types

type Rep GetLabelsResponse :: Type -> Type

Methods

from :: GetLabelsResponse -> Rep GetLabelsResponse x

to :: Rep GetLabelsResponse x -> GetLabelsResponse

Read GetLabelsResponse

Defined in Amazonka.FraudDetector.GetLabels

Methods

readsPrec :: Int -> ReadS GetLabelsResponse

readList :: ReadS [GetLabelsResponse]

readPrec :: ReadPrec GetLabelsResponse

readListPrec :: ReadPrec [GetLabelsResponse]

Show GetLabelsResponse

Defined in Amazonka.FraudDetector.GetLabels

Methods

showsPrec :: Int -> GetLabelsResponse -> ShowS

show :: GetLabelsResponse -> String

showList :: [GetLabelsResponse] -> ShowS

NFData GetLabelsResponse

Defined in Amazonka.FraudDetector.GetLabels

Methods

rnf :: GetLabelsResponse -> ()

Eq GetLabelsResponse

Defined in Amazonka.FraudDetector.GetLabels

Methods

(==) :: GetLabelsResponse -> GetLabelsResponse -> Bool

(/=) :: GetLabelsResponse -> GetLabelsResponse -> Bool

type Rep GetLabelsResponse

Defined in Amazonka.FraudDetector.GetLabels

type Rep GetLabelsResponse = D1 ('MetaData "GetLabelsResponse" "Amazonka.FraudDetector.GetLabels" "amazonka-frauddetector-2.0-CdXFXtLV8DgKo4Kta7Jw61" 'False) (C1 ('MetaCons "GetLabelsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "labels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Label])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetLabelsResponse

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:

GetLabelsResponse, getLabelsResponse_labels - An array of labels.

GetLabels, getLabelsResponse_nextToken - The next page token.

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

Response Lenses

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

An array of labels.

getLabelsResponse_nextToken :: Lens' GetLabelsResponse (Maybe Text)

The next page token.

getLabelsResponse_httpStatus :: Lens' GetLabelsResponse Int

The response's http status code.