{-# 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.Textract.Types.Document
-- 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.Textract.Types.Document where

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

-- | The input document, either as bytes or as an S3 object.
--
-- You pass image bytes to an Amazon Textract API operation by using the
-- @Bytes@ property. For example, you would use the @Bytes@ property to
-- pass a document loaded from a local file system. Image bytes passed by
-- using the @Bytes@ property must be base64 encoded. Your code might not
-- need to encode document file bytes if you\'re using an AWS SDK to call
-- Amazon Textract API operations.
--
-- You pass images stored in an S3 bucket to an Amazon Textract API
-- operation by using the @S3Object@ property. Documents stored in an S3
-- bucket don\'t need to be base64 encoded.
--
-- The AWS Region for the S3 bucket that contains the S3 object must match
-- the AWS Region that you use for Amazon Textract operations.
--
-- If you use the AWS CLI to call Amazon Textract operations, passing image
-- bytes using the Bytes property isn\'t supported. You must first upload
-- the document to an Amazon S3 bucket, and then call the operation using
-- the S3Object property.
--
-- For Amazon Textract to process an S3 object, the user must have
-- permission to access the S3 object.
--
-- /See:/ 'newDocument' smart constructor.
data Document = Document'
  { -- | Identifies an S3 object as the document source. The maximum size of a
    -- document that\'s stored in an S3 bucket is 5 MB.
    Document -> Maybe S3Object
s3Object :: Prelude.Maybe S3Object,
    -- | A blob of base64-encoded document bytes. The maximum size of a document
    -- that\'s provided in a blob of bytes is 5 MB. The document bytes must be
    -- in PNG or JPEG format.
    --
    -- If you\'re using an AWS SDK to call Amazon Textract, you might not need
    -- to base64-encode image bytes passed using the @Bytes@ field.
    Document -> Maybe Base64
bytes :: Prelude.Maybe Core.Base64
  }
  deriving (Document -> Document -> Bool
(Document -> Document -> Bool)
-> (Document -> Document -> Bool) -> Eq Document
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Document -> Document -> Bool
$c/= :: Document -> Document -> Bool
== :: Document -> Document -> Bool
$c== :: Document -> Document -> Bool
Prelude.Eq, ReadPrec [Document]
ReadPrec Document
Int -> ReadS Document
ReadS [Document]
(Int -> ReadS Document)
-> ReadS [Document]
-> ReadPrec Document
-> ReadPrec [Document]
-> Read Document
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Document]
$creadListPrec :: ReadPrec [Document]
readPrec :: ReadPrec Document
$creadPrec :: ReadPrec Document
readList :: ReadS [Document]
$creadList :: ReadS [Document]
readsPrec :: Int -> ReadS Document
$creadsPrec :: Int -> ReadS Document
Prelude.Read, Int -> Document -> ShowS
[Document] -> ShowS
Document -> String
(Int -> Document -> ShowS)
-> (Document -> String) -> ([Document] -> ShowS) -> Show Document
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Document] -> ShowS
$cshowList :: [Document] -> ShowS
show :: Document -> String
$cshow :: Document -> String
showsPrec :: Int -> Document -> ShowS
$cshowsPrec :: Int -> Document -> ShowS
Prelude.Show, (forall x. Document -> Rep Document x)
-> (forall x. Rep Document x -> Document) -> Generic Document
forall x. Rep Document x -> Document
forall x. Document -> Rep Document x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Document x -> Document
$cfrom :: forall x. Document -> Rep Document x
Prelude.Generic)

-- |
-- Create a value of 'Document' 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', 'document_s3Object' - Identifies an S3 object as the document source. The maximum size of a
-- document that\'s stored in an S3 bucket is 5 MB.
--
-- 'bytes', 'document_bytes' - A blob of base64-encoded document bytes. The maximum size of a document
-- that\'s provided in a blob of bytes is 5 MB. The document bytes must be
-- in PNG or JPEG format.
--
-- If you\'re using an AWS SDK to call Amazon Textract, you might not need
-- to base64-encode image bytes passed using the @Bytes@ field.--
-- -- /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.
newDocument ::
  Document
newDocument :: Document
newDocument =
  Document' :: Maybe S3Object -> Maybe Base64 -> Document
Document'
    { $sel:s3Object:Document' :: Maybe S3Object
s3Object = Maybe S3Object
forall a. Maybe a
Prelude.Nothing,
      $sel:bytes:Document' :: Maybe Base64
bytes = Maybe Base64
forall a. Maybe a
Prelude.Nothing
    }

-- | Identifies an S3 object as the document source. The maximum size of a
-- document that\'s stored in an S3 bucket is 5 MB.
document_s3Object :: Lens.Lens' Document (Prelude.Maybe S3Object)
document_s3Object :: (Maybe S3Object -> f (Maybe S3Object)) -> Document -> f Document
document_s3Object = (Document -> Maybe S3Object)
-> (Document -> Maybe S3Object -> Document)
-> Lens Document Document (Maybe S3Object) (Maybe S3Object)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Document' {Maybe S3Object
s3Object :: Maybe S3Object
$sel:s3Object:Document' :: Document -> Maybe S3Object
s3Object} -> Maybe S3Object
s3Object) (\s :: Document
s@Document' {} Maybe S3Object
a -> Document
s {$sel:s3Object:Document' :: Maybe S3Object
s3Object = Maybe S3Object
a} :: Document)

-- | A blob of base64-encoded document bytes. The maximum size of a document
-- that\'s provided in a blob of bytes is 5 MB. The document bytes must be
-- in PNG or JPEG format.
--
-- If you\'re using an AWS SDK to call Amazon Textract, you might not need
-- to base64-encode image bytes passed using the @Bytes@ field.--
-- -- /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.
document_bytes :: Lens.Lens' Document (Prelude.Maybe Prelude.ByteString)
document_bytes :: (Maybe ByteString -> f (Maybe ByteString))
-> Document -> f Document
document_bytes = (Document -> Maybe Base64)
-> (Document -> Maybe Base64 -> Document)
-> Lens Document Document (Maybe Base64) (Maybe Base64)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Document' {Maybe Base64
bytes :: Maybe Base64
$sel:bytes:Document' :: Document -> Maybe Base64
bytes} -> Maybe Base64
bytes) (\s :: Document
s@Document' {} Maybe Base64
a -> Document
s {$sel:bytes:Document' :: Maybe Base64
bytes = Maybe Base64
a} :: Document) ((Maybe Base64 -> f (Maybe Base64)) -> Document -> f Document)
-> ((Maybe ByteString -> f (Maybe ByteString))
    -> Maybe Base64 -> f (Maybe Base64))
-> (Maybe ByteString -> f (Maybe ByteString))
-> Document
-> f Document
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 Document

instance Prelude.NFData Document

instance Core.ToJSON Document where
  toJSON :: Document -> Value
toJSON Document' {Maybe Base64
Maybe S3Object
bytes :: Maybe Base64
s3Object :: Maybe S3Object
$sel:bytes:Document' :: Document -> Maybe Base64
$sel:s3Object:Document' :: Document -> 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
          ]
      )