Amazonka.Rekognition.DescribeCollection

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.

Creating a Request

data DescribeCollection

See: newDescribeCollection smart constructor.

Constructors

DescribeCollection'

Fields

• collectionId :: Text

  The ID of the collection to describe.

Instances

ToJSON DescribeCollection

Defined in Amazonka.Rekognition.DescribeCollection

Methods

toJSON :: DescribeCollection -> Value

toEncoding :: DescribeCollection -> Encoding

toJSONList :: [DescribeCollection] -> Value

toEncodingList :: [DescribeCollection] -> Encoding

ToHeaders DescribeCollection

Defined in Amazonka.Rekognition.DescribeCollection

Methods

toHeaders :: DescribeCollection -> [Header]

ToPath DescribeCollection

Defined in Amazonka.Rekognition.DescribeCollection

Methods

toPath :: DescribeCollection -> ByteString

ToQuery DescribeCollection

Defined in Amazonka.Rekognition.DescribeCollection

Methods

toQuery :: DescribeCollection -> QueryString

AWSRequest DescribeCollection

Defined in Amazonka.Rekognition.DescribeCollection

Associated Types

type AWSResponse DescribeCollection

Methods

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

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

Generic DescribeCollection

Defined in Amazonka.Rekognition.DescribeCollection

Associated Types

type Rep DescribeCollection :: Type -> Type

Methods

from :: DescribeCollection -> Rep DescribeCollection x

to :: Rep DescribeCollection x -> DescribeCollection

Read DescribeCollection

Defined in Amazonka.Rekognition.DescribeCollection

Methods

readsPrec :: Int -> ReadS DescribeCollection

readList :: ReadS [DescribeCollection]

readPrec :: ReadPrec DescribeCollection

readListPrec :: ReadPrec [DescribeCollection]

Show DescribeCollection

Defined in Amazonka.Rekognition.DescribeCollection

Methods

showsPrec :: Int -> DescribeCollection -> ShowS

show :: DescribeCollection -> String

showList :: [DescribeCollection] -> ShowS

NFData DescribeCollection

Defined in Amazonka.Rekognition.DescribeCollection

Methods

rnf :: DescribeCollection -> ()

Eq DescribeCollection

Defined in Amazonka.Rekognition.DescribeCollection

Methods

(==) :: DescribeCollection -> DescribeCollection -> Bool

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

Hashable DescribeCollection

Defined in Amazonka.Rekognition.DescribeCollection

Methods

hashWithSalt :: Int -> DescribeCollection -> Int

hash :: DescribeCollection -> Int

type AWSResponse DescribeCollection

Defined in Amazonka.Rekognition.DescribeCollection

type AWSResponse DescribeCollection = DescribeCollectionResponse

type Rep DescribeCollection

Defined in Amazonka.Rekognition.DescribeCollection

type Rep DescribeCollection = D1 ('MetaData "DescribeCollection" "Amazonka.Rekognition.DescribeCollection" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "DescribeCollection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "collectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeCollection

Arguments

:: Text

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:

DescribeCollection, describeCollection_collectionId - The ID of the collection to describe.

Request Lenses

describeCollection_collectionId :: Lens' DescribeCollection Text

The ID of the collection to describe.

Destructuring the Response

data DescribeCollectionResponse

See: newDescribeCollectionResponse smart constructor.

Constructors

DescribeCollectionResponse'

Fields

• collectionARN :: Maybe Text

  The Amazon Resource Name (ARN) of the collection.

• 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.

• faceCount :: Maybe Natural

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

• 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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeCollectionResponse

Defined in Amazonka.Rekognition.DescribeCollection

Associated Types

type Rep DescribeCollectionResponse :: Type -> Type

Methods

from :: DescribeCollectionResponse -> Rep DescribeCollectionResponse x

to :: Rep DescribeCollectionResponse x -> DescribeCollectionResponse

Read DescribeCollectionResponse

Defined in Amazonka.Rekognition.DescribeCollection

Methods

readsPrec :: Int -> ReadS DescribeCollectionResponse

readList :: ReadS [DescribeCollectionResponse]

readPrec :: ReadPrec DescribeCollectionResponse

readListPrec :: ReadPrec [DescribeCollectionResponse]

Show DescribeCollectionResponse

Defined in Amazonka.Rekognition.DescribeCollection

Methods

showsPrec :: Int -> DescribeCollectionResponse -> ShowS

show :: DescribeCollectionResponse -> String

showList :: [DescribeCollectionResponse] -> ShowS

NFData DescribeCollectionResponse

Defined in Amazonka.Rekognition.DescribeCollection

Methods

rnf :: DescribeCollectionResponse -> ()

Eq DescribeCollectionResponse

Defined in Amazonka.Rekognition.DescribeCollection

Methods

(==) :: DescribeCollectionResponse -> DescribeCollectionResponse -> Bool

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

type Rep DescribeCollectionResponse

Defined in Amazonka.Rekognition.DescribeCollection

type Rep DescribeCollectionResponse = D1 ('MetaData "DescribeCollectionResponse" "Amazonka.Rekognition.DescribeCollection" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "DescribeCollectionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "collectionARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "faceCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "faceModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeCollectionResponse

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:collectionARN:DescribeCollectionResponse', describeCollectionResponse_collectionARN - The Amazon Resource Name (ARN) of the collection.

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:faceCount:DescribeCollectionResponse', describeCollectionResponse_faceCount - The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces.

$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:httpStatus:DescribeCollectionResponse', describeCollectionResponse_httpStatus - The response's http status code.

Response Lenses

describeCollectionResponse_collectionARN :: Lens' DescribeCollectionResponse (Maybe Text)

The Amazon Resource Name (ARN) of the collection.

describeCollectionResponse_creationTimestamp :: Lens' DescribeCollectionResponse (Maybe UTCTime)

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_faceCount :: Lens' DescribeCollectionResponse (Maybe Natural)

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

describeCollectionResponse_faceModelVersion :: Lens' DescribeCollectionResponse (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.

describeCollectionResponse_httpStatus :: Lens' DescribeCollectionResponse Int

The response's http status code.