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.Textract.Types.IdentityDocument

Description

Documentation

data IdentityDocument Source #

The structure that lists each document processed in an AnalyzeID operation.

See: newIdentityDocument smart constructor.

Constructors

IdentityDocument'

Fields

blocks :: Maybe [Block]
Individual word recognition, as returned by document detection.
documentIndex :: Maybe Natural
Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.
identityDocumentFields :: Maybe [IdentityDocumentField]
The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

Instances

Instances details

FromJSON IdentityDocument Source #
Instance details Defined in Amazonka.Textract.Types.IdentityDocument Methods parseJSON :: Value -> Parser IdentityDocument # parseJSONList :: Value -> Parser [IdentityDocument] #
Generic IdentityDocument Source #
Instance details Defined in Amazonka.Textract.Types.IdentityDocument Associated Types type Rep IdentityDocument :: Type -> Type # Methods from :: IdentityDocument -> Rep IdentityDocument x # to :: Rep IdentityDocument x -> IdentityDocument #
Read IdentityDocument Source #
Instance details Defined in Amazonka.Textract.Types.IdentityDocument Methods readsPrec :: Int -> ReadS IdentityDocument # readList :: ReadS [IdentityDocument] # readPrec :: ReadPrec IdentityDocument # readListPrec :: ReadPrec [IdentityDocument] #
Show IdentityDocument Source #
Instance details Defined in Amazonka.Textract.Types.IdentityDocument Methods showsPrec :: Int -> IdentityDocument -> ShowS # show :: IdentityDocument -> String # showList :: [IdentityDocument] -> ShowS #
NFData IdentityDocument Source #
Instance details Defined in Amazonka.Textract.Types.IdentityDocument Methods rnf :: IdentityDocument -> () #
Eq IdentityDocument Source #
Instance details Defined in Amazonka.Textract.Types.IdentityDocument Methods (==) :: IdentityDocument -> IdentityDocument -> Bool # (/=) :: IdentityDocument -> IdentityDocument -> Bool #
Hashable IdentityDocument Source #
Instance details Defined in Amazonka.Textract.Types.IdentityDocument Methods hashWithSalt :: Int -> IdentityDocument -> Int # hash :: IdentityDocument -> Int #
type Rep IdentityDocument Source #
Instance details Defined in Amazonka.Textract.Types.IdentityDocument type Rep IdentityDocument = D1 ('MetaData "IdentityDocument" "Amazonka.Textract.Types.IdentityDocument" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "IdentityDocument'" 'PrefixI 'True) (S1 ('MetaSel ('Just "blocks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Block])) :: (S1 ('MetaSel ('Just "documentIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "identityDocumentFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IdentityDocumentField])))))

newIdentityDocument :: IdentityDocument Source #

Create a value of IdentityDocument 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:blocks:IdentityDocument', identityDocument_blocks - Individual word recognition, as returned by document detection.

$sel:documentIndex:IdentityDocument', identityDocument_documentIndex - Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.

$sel:identityDocumentFields:IdentityDocument', identityDocument_identityDocumentFields - The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

identityDocument_blocks :: Lens' IdentityDocument (Maybe [Block]) Source #

Individual word recognition, as returned by document detection.

identityDocument_documentIndex :: Lens' IdentityDocument (Maybe Natural) Source #

Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.

identityDocument_identityDocumentFields :: Lens' IdentityDocument (Maybe [IdentityDocumentField]) Source #

The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.