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.Rekognition.DescribeCollection

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the specified collection. You can use DescribeCollection to get information, such as the number of faces indexed into a collection and the version of the model used by the collection for face detection.

For more information, see Describing a Collection in the Amazon Rekognition Developer Guide.

Synopsis

data DescribeCollection = DescribeCollection' {
- collectionId :: Text
}
newDescribeCollection :: Text -> DescribeCollection
describeCollection_collectionId :: Lens' DescribeCollection Text
data DescribeCollectionResponse = DescribeCollectionResponse' {
- faceModelVersion :: Maybe Text
- faceCount :: Maybe Natural
- creationTimestamp :: Maybe POSIX
- collectionARN :: Maybe Text
- httpStatus :: Int
}
newDescribeCollectionResponse :: Int -> DescribeCollectionResponse
describeCollectionResponse_faceModelVersion :: Lens' DescribeCollectionResponse (Maybe Text)
describeCollectionResponse_faceCount :: Lens' DescribeCollectionResponse (Maybe Natural)
describeCollectionResponse_creationTimestamp :: Lens' DescribeCollectionResponse (Maybe UTCTime)
describeCollectionResponse_collectionARN :: Lens' DescribeCollectionResponse (Maybe Text)
describeCollectionResponse_httpStatus :: Lens' DescribeCollectionResponse Int

Creating a Request

data DescribeCollection Source #

See: newDescribeCollection smart constructor.

Constructors

DescribeCollection'
Fields collectionId :: Text The ID of the collection to describe.

Instances

Instances details

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

newDescribeCollection Source #

Arguments

:: Text	`$sel:collectionId:DescribeCollection'`
-> DescribeCollection

Create a value of DescribeCollection 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:collectionId:DescribeCollection', describeCollection_collectionId - The ID of the collection to describe.

Request Lenses

describeCollection_collectionId :: Lens' DescribeCollection Text Source #

The ID of the collection to describe.

Destructuring the Response

data DescribeCollectionResponse Source #

See: newDescribeCollectionResponse smart constructor.

Constructors

DescribeCollectionResponse'

Fields

faceModelVersion :: Maybe Text
The version of the face model that's used by the collection for face detection.
For more information, see Model Versioning in the Amazon Rekognition Developer Guide.
faceCount :: Maybe Natural
The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces.
creationTimestamp :: Maybe POSIX
The number of milliseconds since the Unix epoch time until the creation of the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.
collectionARN :: Maybe Text
The Amazon Resource Name (ARN) of the collection.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeCollectionResponse Source #
Instance details Defined in Amazonka.Rekognition.DescribeCollection Methods (==) :: DescribeCollectionResponse -> DescribeCollectionResponse -> Bool # (/=) :: DescribeCollectionResponse -> DescribeCollectionResponse -> Bool #
Read DescribeCollectionResponse Source #
Instance details Defined in Amazonka.Rekognition.DescribeCollection Methods readsPrec :: Int -> ReadS DescribeCollectionResponse # readList :: ReadS [DescribeCollectionResponse] # readPrec :: ReadPrec DescribeCollectionResponse # readListPrec :: ReadPrec [DescribeCollectionResponse] #
Show DescribeCollectionResponse Source #
Instance details Defined in Amazonka.Rekognition.DescribeCollection Methods showsPrec :: Int -> DescribeCollectionResponse -> ShowS # show :: DescribeCollectionResponse -> String # showList :: [DescribeCollectionResponse] -> ShowS #
Generic DescribeCollectionResponse Source #
Instance details Defined in Amazonka.Rekognition.DescribeCollection Associated Types type Rep DescribeCollectionResponse :: Type -> Type # Methods from :: DescribeCollectionResponse -> Rep DescribeCollectionResponse x # to :: Rep DescribeCollectionResponse x -> DescribeCollectionResponse #
NFData DescribeCollectionResponse Source #
Instance details Defined in Amazonka.Rekognition.DescribeCollection Methods rnf :: DescribeCollectionResponse -> () #
type Rep DescribeCollectionResponse Source #
Instance details Defined in Amazonka.Rekognition.DescribeCollection type Rep DescribeCollectionResponse = D1 ('MetaData "DescribeCollectionResponse" "Amazonka.Rekognition.DescribeCollection" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "DescribeCollectionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "faceModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "faceCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "creationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "collectionARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeCollectionResponse Source #

Arguments

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

Create a value of DescribeCollectionResponse 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:faceModelVersion:DescribeCollectionResponse', describeCollectionResponse_faceModelVersion - The version of the face model that's used by the collection for face detection.

For more information, see Model Versioning in the Amazon Rekognition Developer Guide.

$sel:faceCount:DescribeCollectionResponse', describeCollectionResponse_faceCount - The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces.

$sel:creationTimestamp:DescribeCollectionResponse', describeCollectionResponse_creationTimestamp - The number of milliseconds since the Unix epoch time until the creation of the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.

$sel:collectionARN:DescribeCollectionResponse', describeCollectionResponse_collectionARN - The Amazon Resource Name (ARN) of the collection.

$sel:httpStatus:DescribeCollectionResponse', describeCollectionResponse_httpStatus - The response's http status code.

Response Lenses

describeCollectionResponse_faceModelVersion :: Lens' DescribeCollectionResponse (Maybe Text) Source #

The version of the face model that's used by the collection for face detection.

For more information, see Model Versioning in the Amazon Rekognition Developer Guide.

describeCollectionResponse_faceCount :: Lens' DescribeCollectionResponse (Maybe Natural) Source #

The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces.

describeCollectionResponse_creationTimestamp :: Lens' DescribeCollectionResponse (Maybe UTCTime) Source #

The number of milliseconds since the Unix epoch time until the creation of the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.

describeCollectionResponse_collectionARN :: Lens' DescribeCollectionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the collection.

describeCollectionResponse_httpStatus :: Lens' DescribeCollectionResponse Int Source #

The response's http status code.