Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Rekognition.CreateCollection

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a collection in an AWS Region. You can add faces to the collection using the IndexFaces operation.

For example, you might create collections, one for each of your application users. A user can then index faces using the IndexFaces operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container.

When you create a collection, it is associated with the latest version of the face model version.

Collection names are case-sensitive.

This operation requires permissions to perform the rekognition:CreateCollection action. If you want to tag your collection, you also require permission to perform the rekognition:TagResource operation.

Synopsis

Creating a Request

data CreateCollection Source #

See: newCreateCollection smart constructor.

Constructors

CreateCollection'
Fields tags :: Maybe (HashMap Text Text) A set of tags (key-value pairs) that you want to attach to the collection. collectionId :: Text ID for the collection that you are creating.

Instances

Instances details

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

newCreateCollection Source #

Arguments

:: Text	`CreateCollection`
-> CreateCollection

Create a value of CreateCollection 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:tags:CreateCollection', createCollection_tags - A set of tags (key-value pairs) that you want to attach to the collection.

CreateCollection, createCollection_collectionId - ID for the collection that you are creating.

Request Lenses

createCollection_tags :: Lens' CreateCollection (Maybe (HashMap Text Text)) Source #

A set of tags (key-value pairs) that you want to attach to the collection.

createCollection_collectionId :: Lens' CreateCollection Text Source #

ID for the collection that you are creating.

Destructuring the Response

data CreateCollectionResponse Source #

See: newCreateCollectionResponse smart constructor.

Constructors

CreateCollectionResponse'
Fields collectionArn :: Maybe Text Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources. faceModelVersion :: Maybe Text Version number of the face detection model associated with the collection you are creating. statusCode :: Maybe Natural HTTP status code indicating the result of the operation. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateCollectionResponse Source #

Arguments

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

Create a value of CreateCollectionResponse 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:CreateCollectionResponse', createCollectionResponse_collectionArn - Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources.

$sel:faceModelVersion:CreateCollectionResponse', createCollectionResponse_faceModelVersion - Version number of the face detection model associated with the collection you are creating.

$sel:statusCode:CreateCollectionResponse', createCollectionResponse_statusCode - HTTP status code indicating the result of the operation.

$sel:httpStatus:CreateCollectionResponse', createCollectionResponse_httpStatus - The response's http status code.

Response Lenses

createCollectionResponse_collectionArn :: Lens' CreateCollectionResponse (Maybe Text) Source #

Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources.

createCollectionResponse_faceModelVersion :: Lens' CreateCollectionResponse (Maybe Text) Source #

Version number of the face detection model associated with the collection you are creating.

createCollectionResponse_statusCode :: Lens' CreateCollectionResponse (Maybe Natural) Source #

HTTP status code indicating the result of the operation.

createCollectionResponse_httpStatus :: Lens' CreateCollectionResponse Int Source #

The response's http status code.