{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Rekognition.Types.Image
-- Copyright   : (c) 2013-2021 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)
module Amazonka.Rekognition.Types.Image where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import Amazonka.Rekognition.Types.S3Object

-- | Provides the input image either as bytes or an S3 object.
--
-- You pass image bytes to an Amazon Rekognition API operation by using the
-- @Bytes@ property. For example, you would use the @Bytes@ property to
-- pass an image loaded from a local file system. Image bytes passed by
-- using the @Bytes@ property must be base64-encoded. Your code may not
-- need to encode image bytes if you are using an AWS SDK to call Amazon
-- Rekognition API operations.
--
-- For more information, see Analyzing an Image Loaded from a Local File
-- System in the Amazon Rekognition Developer Guide.
--
-- You pass images stored in an S3 bucket to an Amazon Rekognition API
-- operation by using the @S3Object@ property. Images stored in an S3
-- bucket do not need to be base64-encoded.
--
-- The region for the S3 bucket containing the S3 object must match the
-- region you use for Amazon Rekognition operations.
--
-- If you use the AWS CLI to call Amazon Rekognition operations, passing
-- image bytes using the Bytes property is not supported. You must first
-- upload the image to an Amazon S3 bucket and then call the operation
-- using the S3Object property.
--
-- For Amazon Rekognition to process an S3 object, the user must have
-- permission to access the S3 object. For more information, see Resource
-- Based Policies in the Amazon Rekognition Developer Guide.
--
-- /See:/ 'newImage' smart constructor.
data Image = Image'
  { -- | Identifies an S3 object as the image source.
    Image -> Maybe S3Object
s3Object :: Prelude.Maybe S3Object,
    -- | Blob of image bytes up to 5 MBs.
    Image -> Maybe Base64
bytes :: Prelude.Maybe Core.Base64
  }
  deriving (Image -> Image -> Bool
(Image -> Image -> Bool) -> (Image -> Image -> Bool) -> Eq Image
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Image -> Image -> Bool
$c/= :: Image -> Image -> Bool
== :: Image -> Image -> Bool
$c== :: Image -> Image -> Bool
Prelude.Eq, ReadPrec [Image]
ReadPrec Image
Int -> ReadS Image
ReadS [Image]
(Int -> ReadS Image)
-> ReadS [Image]
-> ReadPrec Image
-> ReadPrec [Image]
-> Read Image
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Image]
$creadListPrec :: ReadPrec [Image]
readPrec :: ReadPrec Image
$creadPrec :: ReadPrec Image
readList :: ReadS [Image]
$creadList :: ReadS [Image]
readsPrec :: Int -> ReadS Image
$creadsPrec :: Int -> ReadS Image
Prelude.Read, Int -> Image -> ShowS
[Image] -> ShowS
Image -> String
(Int -> Image -> ShowS)
-> (Image -> String) -> ([Image] -> ShowS) -> Show Image
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Image] -> ShowS
$cshowList :: [Image] -> ShowS
show :: Image -> String
$cshow :: Image -> String
showsPrec :: Int -> Image -> ShowS
$cshowsPrec :: Int -> Image -> ShowS
Prelude.Show, (forall x. Image -> Rep Image x)
-> (forall x. Rep Image x -> Image) -> Generic Image
forall x. Rep Image x -> Image
forall x. Image -> Rep Image x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Image x -> Image
$cfrom :: forall x. Image -> Rep Image x
Prelude.Generic)

-- |
-- Create a value of 'Image' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 's3Object', 'image_s3Object' - Identifies an S3 object as the image source.
--
-- 'bytes', 'image_bytes' - Blob of image bytes up to 5 MBs.--
-- -- /Note:/ This 'Lens' automatically encodes and decodes Base64 data.
-- -- The underlying isomorphism will encode to Base64 representation during
-- -- serialisation, and decode from Base64 representation during deserialisation.
-- -- This 'Lens' accepts and returns only raw unencoded data.
newImage ::
  Image
newImage :: Image
newImage =
  Image' :: Maybe S3Object -> Maybe Base64 -> Image
Image'
    { $sel:s3Object:Image' :: Maybe S3Object
s3Object = Maybe S3Object
forall a. Maybe a
Prelude.Nothing,
      $sel:bytes:Image' :: Maybe Base64
bytes = Maybe Base64
forall a. Maybe a
Prelude.Nothing
    }

-- | Identifies an S3 object as the image source.
image_s3Object :: Lens.Lens' Image (Prelude.Maybe S3Object)
image_s3Object :: (Maybe S3Object -> f (Maybe S3Object)) -> Image -> f Image
image_s3Object = (Image -> Maybe S3Object)
-> (Image -> Maybe S3Object -> Image)
-> Lens Image Image (Maybe S3Object) (Maybe S3Object)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Image' {Maybe S3Object
s3Object :: Maybe S3Object
$sel:s3Object:Image' :: Image -> Maybe S3Object
s3Object} -> Maybe S3Object
s3Object) (\s :: Image
s@Image' {} Maybe S3Object
a -> Image
s {$sel:s3Object:Image' :: Maybe S3Object
s3Object = Maybe S3Object
a} :: Image)

-- | Blob of image bytes up to 5 MBs.--
-- -- /Note:/ This 'Lens' automatically encodes and decodes Base64 data.
-- -- The underlying isomorphism will encode to Base64 representation during
-- -- serialisation, and decode from Base64 representation during deserialisation.
-- -- This 'Lens' accepts and returns only raw unencoded data.
image_bytes :: Lens.Lens' Image (Prelude.Maybe Prelude.ByteString)
image_bytes :: (Maybe ByteString -> f (Maybe ByteString)) -> Image -> f Image
image_bytes = (Image -> Maybe Base64)
-> (Image -> Maybe Base64 -> Image)
-> Lens Image Image (Maybe Base64) (Maybe Base64)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Image' {Maybe Base64
bytes :: Maybe Base64
$sel:bytes:Image' :: Image -> Maybe Base64
bytes} -> Maybe Base64
bytes) (\s :: Image
s@Image' {} Maybe Base64
a -> Image
s {$sel:bytes:Image' :: Maybe Base64
bytes = Maybe Base64
a} :: Image) ((Maybe Base64 -> f (Maybe Base64)) -> Image -> f Image)
-> ((Maybe ByteString -> f (Maybe ByteString))
    -> Maybe Base64 -> f (Maybe Base64))
-> (Maybe ByteString -> f (Maybe ByteString))
-> Image
-> f Image
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso Base64 Base64 ByteString ByteString
-> Iso
     (Maybe Base64) (Maybe Base64) (Maybe ByteString) (Maybe ByteString)
forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping AnIso Base64 Base64 ByteString ByteString
Iso' Base64 ByteString
Core._Base64

instance Prelude.Hashable Image

instance Prelude.NFData Image

instance Core.ToJSON Image where
  toJSON :: Image -> Value
toJSON Image' {Maybe Base64
Maybe S3Object
bytes :: Maybe Base64
s3Object :: Maybe S3Object
$sel:bytes:Image' :: Image -> Maybe Base64
$sel:s3Object:Image' :: Image -> Maybe S3Object
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"S3Object" Text -> S3Object -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (S3Object -> Pair) -> Maybe S3Object -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe S3Object
s3Object,
            (Text
"Bytes" Text -> Base64 -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Base64 -> Pair) -> Maybe Base64 -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Base64
bytes
          ]
      )