amazonka-rekognition-2.0: Amazon Rekognition SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Rekognition.ListCollections

Description

Returns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.

For an example, see Listing collections in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:ListCollections action.

This operation returns paginated results.

Synopsis

Creating a Request

data ListCollections Source #

See: newListCollections smart constructor.

Constructors

ListCollections' 

Fields

Instances

Instances details
ToJSON ListCollections Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

Methods

toJSON :: ListCollections -> Value #

toEncoding :: ListCollections -> Encoding #

toJSONList :: [ListCollections] -> Value #

toEncodingList :: [ListCollections] -> Encoding #

ToHeaders ListCollections Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

Methods

toHeaders :: ListCollections -> [Header] #

ToPath ListCollections Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

Methods

toPath :: ListCollections -> ByteString #

ToQuery ListCollections Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

Methods

toQuery :: ListCollections -> QueryString #

AWSPager ListCollections Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

Methods

page :: ListCollections -> AWSResponse ListCollections -> Maybe ListCollections #

AWSRequest ListCollections Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

Associated Types

type AWSResponse ListCollections #

Methods

request :: (Service -> Service) -> ListCollections -> Request ListCollections #

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

Generic ListCollections Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

Associated Types

type Rep ListCollections :: Type -> Type #

Methods

from :: ListCollections -> Rep ListCollections x #

to :: Rep ListCollections x -> ListCollections #

Read ListCollections Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

Methods

readsPrec :: Int -> ReadS ListCollections #

readList :: ReadS [ListCollections] #

readPrec :: ReadPrec ListCollections #

readListPrec :: ReadPrec [ListCollections] #

Show ListCollections Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

Methods

showsPrec :: Int -> ListCollections -> ShowS #

show :: ListCollections -> String #

showList :: [ListCollections] -> ShowS #

NFData ListCollections Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

Methods

rnf :: ListCollections -> () #

Eq ListCollections Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

Methods

(==) :: ListCollections -> ListCollections -> Bool #

(/=) :: ListCollections -> ListCollections -> Bool #

Hashable ListCollections Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

Methods

hashWithSalt :: Int -> ListCollections -> Int #

hash :: ListCollections -> Int #

type AWSResponse ListCollections Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

type AWSResponse ListCollections = ListCollectionsResponse
type Rep ListCollections Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

type Rep ListCollections = D1 ('MetaData "ListCollections" "Amazonka.Rekognition.ListCollections" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "ListCollections'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListCollections :: ListCollections Source #

Create a value of ListCollections 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:ListCollections', listCollections_maxResults - Maximum number of collection IDs to return.

ListCollections, listCollections_nextToken - Pagination token from the previous response.

Request Lenses

listCollections_maxResults :: Lens' ListCollections (Maybe Natural) Source #

Maximum number of collection IDs to return.

listCollections_nextToken :: Lens' ListCollections (Maybe Text) Source #

Pagination token from the previous response.

Destructuring the Response

data ListCollectionsResponse Source #

See: newListCollectionsResponse smart constructor.

Constructors

ListCollectionsResponse' 

Fields

  • collectionIds :: Maybe [Text]

    An array of collection IDs.

  • faceModelVersions :: Maybe [Text]

    Version numbers of the face detection models associated with the collections in the array CollectionIds. For example, the value of FaceModelVersions[2] is the version number for the face detection model used by the collection in CollectionId[2].

  • nextToken :: Maybe Text

    If the result is truncated, the response provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListCollectionsResponse Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

Associated Types

type Rep ListCollectionsResponse :: Type -> Type #

Methods

from :: ListCollectionsResponse -> Rep ListCollectionsResponse x #

to :: Rep ListCollectionsResponse x -> ListCollectionsResponse #

Read ListCollectionsResponse Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

Methods

readsPrec :: Int -> ReadS ListCollectionsResponse #

readList :: ReadS [ListCollectionsResponse] #

readPrec :: ReadPrec ListCollectionsResponse #

readListPrec :: ReadPrec [ListCollectionsResponse] #

Show ListCollectionsResponse Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

Methods

showsPrec :: Int -> ListCollectionsResponse -> ShowS #

show :: ListCollectionsResponse -> String #

showList :: [ListCollectionsResponse] -> ShowS #

NFData ListCollectionsResponse Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

Methods

rnf :: ListCollectionsResponse -> () #

Eq ListCollectionsResponse Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

Methods

(==) :: ListCollectionsResponse -> ListCollectionsResponse -> Bool #

(/=) :: ListCollectionsResponse -> ListCollectionsResponse -> Bool #

type Rep ListCollectionsResponse Source # 
Instance details

Defined in Amazonka.Rekognition.ListCollections

type Rep ListCollectionsResponse = D1 ('MetaData "ListCollectionsResponse" "Amazonka.Rekognition.ListCollections" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "ListCollectionsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "collectionIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "faceModelVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListCollectionsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListCollectionsResponse'

-> ListCollectionsResponse 

Create a value of ListCollectionsResponse 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:collectionIds:ListCollectionsResponse', listCollectionsResponse_collectionIds - An array of collection IDs.

$sel:faceModelVersions:ListCollectionsResponse', listCollectionsResponse_faceModelVersions - Version numbers of the face detection models associated with the collections in the array CollectionIds. For example, the value of FaceModelVersions[2] is the version number for the face detection model used by the collection in CollectionId[2].

ListCollections, listCollectionsResponse_nextToken - If the result is truncated, the response provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.

$sel:httpStatus:ListCollectionsResponse', listCollectionsResponse_httpStatus - The response's http status code.

Response Lenses

listCollectionsResponse_collectionIds :: Lens' ListCollectionsResponse (Maybe [Text]) Source #

An array of collection IDs.

listCollectionsResponse_faceModelVersions :: Lens' ListCollectionsResponse (Maybe [Text]) Source #

Version numbers of the face detection models associated with the collections in the array CollectionIds. For example, the value of FaceModelVersions[2] is the version number for the face detection model used by the collection in CollectionId[2].

listCollectionsResponse_nextToken :: Lens' ListCollectionsResponse (Maybe Text) Source #

If the result is truncated, the response provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.

listCollectionsResponse_httpStatus :: Lens' ListCollectionsResponse Int Source #

The response's http status code.