Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.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 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.

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

Creating a Request

createCollection #

Arguments

:: Text	`ccCollectionId`
-> CreateCollection

Creates a value of CreateCollection with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ccCollectionId - ID for the collection that you are creating.

data CreateCollection #

See: createCollection smart constructor.

Instances

Eq CreateCollection #
Instance details Defined in Network.AWS.Rekognition.CreateCollection Methods (==) :: CreateCollection -> CreateCollection -> Bool # (/=) :: CreateCollection -> CreateCollection -> Bool #
Data CreateCollection #
Instance details Defined in Network.AWS.Rekognition.CreateCollection Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateCollection -> c CreateCollection # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateCollection # toConstr :: CreateCollection -> Constr # dataTypeOf :: CreateCollection -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateCollection) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateCollection) # gmapT :: (forall b. Data b => b -> b) -> CreateCollection -> CreateCollection # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateCollection -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateCollection -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateCollection -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateCollection -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateCollection -> m CreateCollection # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateCollection -> m CreateCollection # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateCollection -> m CreateCollection #
Read CreateCollection #
Instance details Defined in Network.AWS.Rekognition.CreateCollection Methods readsPrec :: Int -> ReadS CreateCollection # readList :: ReadS [CreateCollection] # readPrec :: ReadPrec CreateCollection # readListPrec :: ReadPrec [CreateCollection] #
Show CreateCollection #
Instance details Defined in Network.AWS.Rekognition.CreateCollection Methods showsPrec :: Int -> CreateCollection -> ShowS # show :: CreateCollection -> String # showList :: [CreateCollection] -> ShowS #
Generic CreateCollection #
Instance details Defined in Network.AWS.Rekognition.CreateCollection Associated Types type Rep CreateCollection :: * -> * # Methods from :: CreateCollection -> Rep CreateCollection x # to :: Rep CreateCollection x -> CreateCollection #
Hashable CreateCollection #
Instance details Defined in Network.AWS.Rekognition.CreateCollection Methods hashWithSalt :: Int -> CreateCollection -> Int # hash :: CreateCollection -> Int #
ToJSON CreateCollection #
Instance details Defined in Network.AWS.Rekognition.CreateCollection Methods toJSON :: CreateCollection -> Value # toEncoding :: CreateCollection -> Encoding # toJSONList :: [CreateCollection] -> Value # toEncodingList :: [CreateCollection] -> Encoding #
AWSRequest CreateCollection #
Instance details Defined in Network.AWS.Rekognition.CreateCollection Associated Types type Rs CreateCollection :: * # Methods request :: CreateCollection -> Request CreateCollection # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CreateCollection -> ClientResponse -> m (Response CreateCollection) #
ToHeaders CreateCollection #
Instance details Defined in Network.AWS.Rekognition.CreateCollection Methods toHeaders :: CreateCollection -> [Header] #
ToPath CreateCollection #
Instance details Defined in Network.AWS.Rekognition.CreateCollection Methods toPath :: CreateCollection -> ByteString #
ToQuery CreateCollection #
Instance details Defined in Network.AWS.Rekognition.CreateCollection Methods toQuery :: CreateCollection -> QueryString #
NFData CreateCollection #
Instance details Defined in Network.AWS.Rekognition.CreateCollection Methods rnf :: CreateCollection -> () #
type Rep CreateCollection #
Instance details Defined in Network.AWS.Rekognition.CreateCollection type Rep CreateCollection = D1 (MetaData "CreateCollection" "Network.AWS.Rekognition.CreateCollection" "amazonka-rekognition-1.6.0-1OMR5H5ExV9ym4zNmFCPP" True) (C1 (MetaCons "CreateCollection'" PrefixI True) (S1 (MetaSel (Just "_ccCollectionId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs CreateCollection #
Instance details Defined in Network.AWS.Rekognition.CreateCollection type Rs CreateCollection = CreateCollectionResponse

Request Lenses

ccCollectionId :: Lens' CreateCollection Text #

ID for the collection that you are creating.

Destructuring the Response

createCollectionResponse #

Arguments

:: Int	`ccrsResponseStatus`
-> CreateCollectionResponse

Creates a value of CreateCollectionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ccrsFaceModelVersion - Version number of the face detection model associated with the collection you are creating.
ccrsCollectionARN - Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources.
ccrsStatusCode - HTTP status code indicating the result of the operation.
ccrsResponseStatus - -- | The response status code.

data CreateCollectionResponse #

See: createCollectionResponse smart constructor.

Instances

Eq CreateCollectionResponse #
Instance details Defined in Network.AWS.Rekognition.CreateCollection Methods (==) :: CreateCollectionResponse -> CreateCollectionResponse -> Bool # (/=) :: CreateCollectionResponse -> CreateCollectionResponse -> Bool #
Data CreateCollectionResponse #
Instance details Defined in Network.AWS.Rekognition.CreateCollection Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateCollectionResponse -> c CreateCollectionResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateCollectionResponse # toConstr :: CreateCollectionResponse -> Constr # dataTypeOf :: CreateCollectionResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateCollectionResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateCollectionResponse) # gmapT :: (forall b. Data b => b -> b) -> CreateCollectionResponse -> CreateCollectionResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateCollectionResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateCollectionResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateCollectionResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateCollectionResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateCollectionResponse -> m CreateCollectionResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateCollectionResponse -> m CreateCollectionResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateCollectionResponse -> m CreateCollectionResponse #
Read CreateCollectionResponse #
Instance details Defined in Network.AWS.Rekognition.CreateCollection Methods readsPrec :: Int -> ReadS CreateCollectionResponse # readList :: ReadS [CreateCollectionResponse] # readPrec :: ReadPrec CreateCollectionResponse # readListPrec :: ReadPrec [CreateCollectionResponse] #
Show CreateCollectionResponse #
Instance details Defined in Network.AWS.Rekognition.CreateCollection Methods showsPrec :: Int -> CreateCollectionResponse -> ShowS # show :: CreateCollectionResponse -> String # showList :: [CreateCollectionResponse] -> ShowS #
Generic CreateCollectionResponse #
Instance details Defined in Network.AWS.Rekognition.CreateCollection Associated Types type Rep CreateCollectionResponse :: * -> * # Methods from :: CreateCollectionResponse -> Rep CreateCollectionResponse x # to :: Rep CreateCollectionResponse x -> CreateCollectionResponse #
NFData CreateCollectionResponse #
Instance details Defined in Network.AWS.Rekognition.CreateCollection Methods rnf :: CreateCollectionResponse -> () #
type Rep CreateCollectionResponse #
Instance details Defined in Network.AWS.Rekognition.CreateCollection type Rep CreateCollectionResponse = D1 (MetaData "CreateCollectionResponse" "Network.AWS.Rekognition.CreateCollection" "amazonka-rekognition-1.6.0-1OMR5H5ExV9ym4zNmFCPP" False) (C1 (MetaCons "CreateCollectionResponse'" PrefixI True) ((S1 (MetaSel (Just "_ccrsFaceModelVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ccrsCollectionARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_ccrsStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_ccrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

ccrsFaceModelVersion :: Lens' CreateCollectionResponse (Maybe Text) #

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

ccrsCollectionARN :: Lens' CreateCollectionResponse (Maybe Text) #

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

ccrsStatusCode :: Lens' CreateCollectionResponse (Maybe Natural) #

HTTP status code indicating the result of the operation.

ccrsResponseStatus :: Lens' CreateCollectionResponse Int #

- | The response status code.