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.AnalyzeID

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Analyzes identity documents for relevant information. This information is extracted and returned as IdentityDocumentFields, which records both the normalized field and value of the extracted text.Unlike other Amazon Textract operations, AnalyzeID doesn't return any Geometry data.

Creating a Request

data AnalyzeID Source #

See: newAnalyzeID smart constructor.

Constructors

AnalyzeID'
Fields documentPages :: NonEmpty Document The document being passed to AnalyzeID.

Instances

Instances details

ToJSON AnalyzeID Source #
Instance details Defined in Amazonka.Textract.AnalyzeID Methods toJSON :: AnalyzeID -> Value # toEncoding :: AnalyzeID -> Encoding # toJSONList :: [AnalyzeID] -> Value # toEncodingList :: [AnalyzeID] -> Encoding #
ToHeaders AnalyzeID Source #
Instance details Defined in Amazonka.Textract.AnalyzeID Methods toHeaders :: AnalyzeID -> [Header] #
ToPath AnalyzeID Source #
Instance details Defined in Amazonka.Textract.AnalyzeID Methods toPath :: AnalyzeID -> ByteString #
ToQuery AnalyzeID Source #
Instance details Defined in Amazonka.Textract.AnalyzeID Methods toQuery :: AnalyzeID -> QueryString #
AWSRequest AnalyzeID Source #
Instance details Defined in Amazonka.Textract.AnalyzeID Associated Types type AWSResponse AnalyzeID # Methods request :: (Service -> Service) -> AnalyzeID -> Request AnalyzeID # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AnalyzeID -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AnalyzeID))) #
Generic AnalyzeID Source #
Instance details Defined in Amazonka.Textract.AnalyzeID Associated Types type Rep AnalyzeID :: Type -> Type # Methods from :: AnalyzeID -> Rep AnalyzeID x # to :: Rep AnalyzeID x -> AnalyzeID #
Read AnalyzeID Source #
Instance details Defined in Amazonka.Textract.AnalyzeID Methods readsPrec :: Int -> ReadS AnalyzeID # readList :: ReadS [AnalyzeID] # readPrec :: ReadPrec AnalyzeID # readListPrec :: ReadPrec [AnalyzeID] #
Show AnalyzeID Source #
Instance details Defined in Amazonka.Textract.AnalyzeID Methods showsPrec :: Int -> AnalyzeID -> ShowS # show :: AnalyzeID -> String # showList :: [AnalyzeID] -> ShowS #
NFData AnalyzeID Source #
Instance details Defined in Amazonka.Textract.AnalyzeID Methods rnf :: AnalyzeID -> () #
Eq AnalyzeID Source #
Instance details Defined in Amazonka.Textract.AnalyzeID Methods (==) :: AnalyzeID -> AnalyzeID -> Bool # (/=) :: AnalyzeID -> AnalyzeID -> Bool #
Hashable AnalyzeID Source #
Instance details Defined in Amazonka.Textract.AnalyzeID Methods hashWithSalt :: Int -> AnalyzeID -> Int # hash :: AnalyzeID -> Int #
type AWSResponse AnalyzeID Source #
Instance details Defined in Amazonka.Textract.AnalyzeID type AWSResponse AnalyzeID = AnalyzeIDResponse
type Rep AnalyzeID Source #
Instance details Defined in Amazonka.Textract.AnalyzeID type Rep AnalyzeID = D1 ('MetaData "AnalyzeID" "Amazonka.Textract.AnalyzeID" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "AnalyzeID'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentPages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Document))))

newAnalyzeID Source #

Arguments

:: NonEmpty Document	`$sel:documentPages:AnalyzeID'`
-> AnalyzeID

Create a value of AnalyzeID 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:documentPages:AnalyzeID', analyzeID_documentPages - The document being passed to AnalyzeID.

Request Lenses

analyzeID_documentPages :: Lens' AnalyzeID (NonEmpty Document) Source #

The document being passed to AnalyzeID.

Destructuring the Response

data AnalyzeIDResponse Source #

See: newAnalyzeIDResponse smart constructor.

Constructors

AnalyzeIDResponse'
Fields analyzeIDModelVersion :: Maybe Text The version of the AnalyzeIdentity API being used to process documents. documentMetadata :: Maybe DocumentMetadata identityDocuments :: Maybe [IdentityDocument] The list of documents processed by AnalyzeID. Includes a number denoting their place in the list and the response structure for the document. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic AnalyzeIDResponse Source #
Instance details Defined in Amazonka.Textract.AnalyzeID Associated Types type Rep AnalyzeIDResponse :: Type -> Type # Methods from :: AnalyzeIDResponse -> Rep AnalyzeIDResponse x # to :: Rep AnalyzeIDResponse x -> AnalyzeIDResponse #
Read AnalyzeIDResponse Source #
Instance details Defined in Amazonka.Textract.AnalyzeID Methods readsPrec :: Int -> ReadS AnalyzeIDResponse # readList :: ReadS [AnalyzeIDResponse] # readPrec :: ReadPrec AnalyzeIDResponse # readListPrec :: ReadPrec [AnalyzeIDResponse] #
Show AnalyzeIDResponse Source #
Instance details Defined in Amazonka.Textract.AnalyzeID Methods showsPrec :: Int -> AnalyzeIDResponse -> ShowS # show :: AnalyzeIDResponse -> String # showList :: [AnalyzeIDResponse] -> ShowS #
NFData AnalyzeIDResponse Source #
Instance details Defined in Amazonka.Textract.AnalyzeID Methods rnf :: AnalyzeIDResponse -> () #
Eq AnalyzeIDResponse Source #
Instance details Defined in Amazonka.Textract.AnalyzeID Methods (==) :: AnalyzeIDResponse -> AnalyzeIDResponse -> Bool # (/=) :: AnalyzeIDResponse -> AnalyzeIDResponse -> Bool #
type Rep AnalyzeIDResponse Source #
Instance details Defined in Amazonka.Textract.AnalyzeID type Rep AnalyzeIDResponse = D1 ('MetaData "AnalyzeIDResponse" "Amazonka.Textract.AnalyzeID" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "AnalyzeIDResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "analyzeIDModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "documentMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentMetadata))) :: (S1 ('MetaSel ('Just "identityDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IdentityDocument])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newAnalyzeIDResponse Source #

Arguments

:: Int	`$sel:httpStatus:AnalyzeIDResponse'`
-> AnalyzeIDResponse

Create a value of AnalyzeIDResponse 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:analyzeIDModelVersion:AnalyzeIDResponse', analyzeIDResponse_analyzeIDModelVersion - The version of the AnalyzeIdentity API being used to process documents.

$sel:documentMetadata:AnalyzeIDResponse', analyzeIDResponse_documentMetadata - Undocumented member.

$sel:identityDocuments:AnalyzeIDResponse', analyzeIDResponse_identityDocuments - The list of documents processed by AnalyzeID. Includes a number denoting their place in the list and the response structure for the document.

$sel:httpStatus:AnalyzeIDResponse', analyzeIDResponse_httpStatus - The response's http status code.

Response Lenses

analyzeIDResponse_analyzeIDModelVersion :: Lens' AnalyzeIDResponse (Maybe Text) Source #

The version of the AnalyzeIdentity API being used to process documents.

analyzeIDResponse_documentMetadata :: Lens' AnalyzeIDResponse (Maybe DocumentMetadata) Source #

Undocumented member.

analyzeIDResponse_identityDocuments :: Lens' AnalyzeIDResponse (Maybe [IdentityDocument]) Source #

The list of documents processed by AnalyzeID. Includes a number denoting their place in the list and the response structure for the document.

analyzeIDResponse_httpStatus :: Lens' AnalyzeIDResponse Int Source #

The response's http status code.