libZSservicesZSamazonka-rekognitionZSamazonka-rekognition
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Rekognition.DescribeCollection

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

Creating a Request

data DescribeCollection Source #

See: newDescribeCollection smart constructor.

Constructors

DescribeCollection' 

Fields

Instances

Instances details
Eq DescribeCollection Source # 
Instance details

Defined in Amazonka.Rekognition.DescribeCollection

Read DescribeCollection Source # 
Instance details

Defined in Amazonka.Rekognition.DescribeCollection

Show DescribeCollection Source # 
Instance details

Defined in Amazonka.Rekognition.DescribeCollection

Generic DescribeCollection Source # 
Instance details

Defined in Amazonka.Rekognition.DescribeCollection

Associated Types

type Rep DescribeCollection :: Type -> Type #

NFData DescribeCollection Source # 
Instance details

Defined in Amazonka.Rekognition.DescribeCollection

Methods

rnf :: DescribeCollection -> () #

Hashable DescribeCollection Source # 
Instance details

Defined in Amazonka.Rekognition.DescribeCollection

ToJSON DescribeCollection Source # 
Instance details

Defined in Amazonka.Rekognition.DescribeCollection

AWSRequest DescribeCollection Source # 
Instance details

Defined in Amazonka.Rekognition.DescribeCollection

Associated Types

type AWSResponse DescribeCollection #

ToHeaders DescribeCollection Source # 
Instance details

Defined in Amazonka.Rekognition.DescribeCollection

ToPath DescribeCollection Source # 
Instance details

Defined in Amazonka.Rekognition.DescribeCollection

ToQuery DescribeCollection Source # 
Instance details

Defined in Amazonka.Rekognition.DescribeCollection

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

newDescribeCollection Source #

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

Read DescribeCollectionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.DescribeCollection

Show DescribeCollectionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.DescribeCollection

Generic DescribeCollectionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.DescribeCollection

Associated Types

type Rep DescribeCollectionResponse :: Type -> Type #

NFData DescribeCollectionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.DescribeCollection

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 #

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.