Network.AWS.Rekognition.DetectLabels

Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature. For an example, see 'images-s3' .

You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the Amazon CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response will include all three labels, one for each object.

{Name: lighthouse, Confidence: 98.4629}

{Name: rock,Confidence: 79.2097}

{Name: sea,Confidence: 75.061}

In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.

{Name: flower,Confidence: 99.0562}

{Name: plant,Confidence: 99.0562}

{Name: tulip,Confidence: 99.0562}

In this example, the detection algorithm more precisely identifies the flower as a tulip.

In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 50%. You can also add the MaxLabels parameter to limit the number of labels returned.

This is a stateless API operation. That is, the operation does not persist any data.

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

Creating a Request

detectLabels

Arguments

:: Image

dlImage

-> DetectLabels

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

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

• dlMinConfidence - Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value. If MinConfidence is not specified, the operation returns labels with a confidence values greater than or equal to 50 percent.
• dlMaxLabels - Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.
• dlImage - The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

data DetectLabels

See: detectLabels smart constructor.

Instances

Eq DetectLabels

Defined in Network.AWS.Rekognition.DetectLabels

Methods

(==) :: DetectLabels -> DetectLabels -> Bool

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

Data DetectLabels

Defined in Network.AWS.Rekognition.DetectLabels

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DetectLabels -> c DetectLabels

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DetectLabels

toConstr :: DetectLabels -> Constr

dataTypeOf :: DetectLabels -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DetectLabels)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DetectLabels)

gmapT :: (forall b. Data b => b -> b) -> DetectLabels -> DetectLabels

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DetectLabels -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DetectLabels -> r

gmapQ :: (forall d. Data d => d -> u) -> DetectLabels -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DetectLabels -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DetectLabels -> m DetectLabels

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DetectLabels -> m DetectLabels

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DetectLabels -> m DetectLabels

Read DetectLabels

Defined in Network.AWS.Rekognition.DetectLabels

Methods

readsPrec :: Int -> ReadS DetectLabels

readList :: ReadS [DetectLabels]

readPrec :: ReadPrec DetectLabels

readListPrec :: ReadPrec [DetectLabels]

Show DetectLabels

Defined in Network.AWS.Rekognition.DetectLabels

Methods

showsPrec :: Int -> DetectLabels -> ShowS

show :: DetectLabels -> String

showList :: [DetectLabels] -> ShowS

Generic DetectLabels

Defined in Network.AWS.Rekognition.DetectLabels

Associated Types

type Rep DetectLabels :: Type -> Type

Methods

from :: DetectLabels -> Rep DetectLabels x

to :: Rep DetectLabels x -> DetectLabels

Hashable DetectLabels

Defined in Network.AWS.Rekognition.DetectLabels

Methods

hashWithSalt :: Int -> DetectLabels -> Int

hash :: DetectLabels -> Int

ToJSON DetectLabels

Defined in Network.AWS.Rekognition.DetectLabels

Methods

toJSON :: DetectLabels -> Value

toEncoding :: DetectLabels -> Encoding

toJSONList :: [DetectLabels] -> Value

toEncodingList :: [DetectLabels] -> Encoding

AWSRequest DetectLabels

Defined in Network.AWS.Rekognition.DetectLabels

Associated Types

type Rs DetectLabels :: Type

Methods

request :: DetectLabels -> Request DetectLabels

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DetectLabels -> ClientResponse -> m (Response DetectLabels)

ToHeaders DetectLabels

Defined in Network.AWS.Rekognition.DetectLabels

Methods

toHeaders :: DetectLabels -> [Header]

ToPath DetectLabels

Defined in Network.AWS.Rekognition.DetectLabels

Methods

toPath :: DetectLabels -> ByteString

ToQuery DetectLabels

Defined in Network.AWS.Rekognition.DetectLabels

Methods

toQuery :: DetectLabels -> QueryString

NFData DetectLabels

Defined in Network.AWS.Rekognition.DetectLabels

Methods

rnf :: DetectLabels -> ()

type Rep DetectLabels

Defined in Network.AWS.Rekognition.DetectLabels

type Rep DetectLabels = D1 (MetaData "DetectLabels" "Network.AWS.Rekognition.DetectLabels" "amazonka-rekognition-1.6.1-ELwOF0LSGWFp8S3Ef6QMe" False) (C1 (MetaCons "DetectLabels'" PrefixI True) (S1 (MetaSel (Just "_dlMinConfidence") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 (MetaSel (Just "_dlMaxLabels") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_dlImage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Image))))

type Rs DetectLabels

Defined in Network.AWS.Rekognition.DetectLabels

type Rs DetectLabels = DetectLabelsResponse

Request Lenses

dlMinConfidence :: Lens' DetectLabels (Maybe Double)

Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value. If MinConfidence is not specified, the operation returns labels with a confidence values greater than or equal to 50 percent.

dlMaxLabels :: Lens' DetectLabels (Maybe Natural)

Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.

dlImage :: Lens' DetectLabels Image

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

Destructuring the Response

detectLabelsResponse

Arguments

:: Int

dlrsResponseStatus

-> DetectLabelsResponse

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

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

• dlrsLabels - An array of labels for the real-world objects detected.
• dlrsOrientationCorrection - The orientation of the input image (counter-clockwise direction). If your application displays the image, you can use this value to correct the orientation. If Amazon Rekognition detects that the input image was rotated (for example, by 90 degrees), it first corrects the orientation before detecting the labels.
• dlrsResponseStatus - -- | The response status code.

data DetectLabelsResponse

See: detectLabelsResponse smart constructor.

Instances

Eq DetectLabelsResponse

Defined in Network.AWS.Rekognition.DetectLabels

Methods

(==) :: DetectLabelsResponse -> DetectLabelsResponse -> Bool

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

Data DetectLabelsResponse

Defined in Network.AWS.Rekognition.DetectLabels

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DetectLabelsResponse -> c DetectLabelsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DetectLabelsResponse

toConstr :: DetectLabelsResponse -> Constr

dataTypeOf :: DetectLabelsResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DetectLabelsResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DetectLabelsResponse)

gmapT :: (forall b. Data b => b -> b) -> DetectLabelsResponse -> DetectLabelsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DetectLabelsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DetectLabelsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DetectLabelsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DetectLabelsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DetectLabelsResponse -> m DetectLabelsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DetectLabelsResponse -> m DetectLabelsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DetectLabelsResponse -> m DetectLabelsResponse

Read DetectLabelsResponse

Defined in Network.AWS.Rekognition.DetectLabels

Methods

readsPrec :: Int -> ReadS DetectLabelsResponse

readList :: ReadS [DetectLabelsResponse]

readPrec :: ReadPrec DetectLabelsResponse

readListPrec :: ReadPrec [DetectLabelsResponse]

Show DetectLabelsResponse

Defined in Network.AWS.Rekognition.DetectLabels

Methods

showsPrec :: Int -> DetectLabelsResponse -> ShowS

show :: DetectLabelsResponse -> String

showList :: [DetectLabelsResponse] -> ShowS

Generic DetectLabelsResponse

Defined in Network.AWS.Rekognition.DetectLabels

Associated Types

type Rep DetectLabelsResponse :: Type -> Type

Methods

from :: DetectLabelsResponse -> Rep DetectLabelsResponse x

to :: Rep DetectLabelsResponse x -> DetectLabelsResponse

NFData DetectLabelsResponse

Defined in Network.AWS.Rekognition.DetectLabels

Methods

rnf :: DetectLabelsResponse -> ()

type Rep DetectLabelsResponse

Defined in Network.AWS.Rekognition.DetectLabels

type Rep DetectLabelsResponse = D1 (MetaData "DetectLabelsResponse" "Network.AWS.Rekognition.DetectLabels" "amazonka-rekognition-1.6.1-ELwOF0LSGWFp8S3Ef6QMe" False) (C1 (MetaCons "DetectLabelsResponse'" PrefixI True) (S1 (MetaSel (Just "_dlrsLabels") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Label])) :*: (S1 (MetaSel (Just "_dlrsOrientationCorrection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe OrientationCorrection)) :*: S1 (MetaSel (Just "_dlrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

dlrsLabels :: Lens' DetectLabelsResponse [Label]

An array of labels for the real-world objects detected.

dlrsOrientationCorrection :: Lens' DetectLabelsResponse (Maybe OrientationCorrection)

The orientation of the input image (counter-clockwise direction). If your application displays the image, you can use this value to correct the orientation. If Amazon Rekognition detects that the input image was rotated (for example, by 90 degrees), it first corrects the orientation before detecting the labels.

dlrsResponseStatus :: Lens' DetectLabelsResponse Int

• - | The response status code.