Amazonka.Textract.Types.DocumentGroup

Documentation

data DocumentGroup

Summary information about documents grouped by the same document type.

See: newDocumentGroup smart constructor.

Constructors

DocumentGroup'

Fields

• detectedSignatures :: Maybe [DetectedSignature]

  A list of the detected signatures found in a document group.

• splitDocuments :: Maybe [SplitDocument]

  An array that contains information about the pages of a document, defined by logical boundary.

• type' :: Maybe Text

  The type of document that Amazon Textract has detected. See LINK for a list of all types returned by Textract.

• undetectedSignatures :: Maybe [UndetectedSignature]

  A list of any expected signatures not found in a document group.

Instances

FromJSON DocumentGroup

Defined in Amazonka.Textract.Types.DocumentGroup

Methods

parseJSON :: Value -> Parser DocumentGroup

parseJSONList :: Value -> Parser [DocumentGroup]

Generic DocumentGroup

Defined in Amazonka.Textract.Types.DocumentGroup

Associated Types

type Rep DocumentGroup :: Type -> Type

Methods

from :: DocumentGroup -> Rep DocumentGroup x

to :: Rep DocumentGroup x -> DocumentGroup

Read DocumentGroup

Defined in Amazonka.Textract.Types.DocumentGroup

Methods

readsPrec :: Int -> ReadS DocumentGroup

readList :: ReadS [DocumentGroup]

readPrec :: ReadPrec DocumentGroup

readListPrec :: ReadPrec [DocumentGroup]

Show DocumentGroup

Defined in Amazonka.Textract.Types.DocumentGroup

Methods

showsPrec :: Int -> DocumentGroup -> ShowS

show :: DocumentGroup -> String

showList :: [DocumentGroup] -> ShowS

NFData DocumentGroup

Defined in Amazonka.Textract.Types.DocumentGroup

Methods

rnf :: DocumentGroup -> ()

Eq DocumentGroup

Defined in Amazonka.Textract.Types.DocumentGroup

Methods

(==) :: DocumentGroup -> DocumentGroup -> Bool

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

Hashable DocumentGroup

Defined in Amazonka.Textract.Types.DocumentGroup

Methods

hashWithSalt :: Int -> DocumentGroup -> Int

hash :: DocumentGroup -> Int

type Rep DocumentGroup

Defined in Amazonka.Textract.Types.DocumentGroup

type Rep DocumentGroup = D1 ('MetaData "DocumentGroup" "Amazonka.Textract.Types.DocumentGroup" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "DocumentGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "detectedSignatures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DetectedSignature])) :*: S1 ('MetaSel ('Just "splitDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SplitDocument]))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "undetectedSignatures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UndetectedSignature])))))

newDocumentGroup :: DocumentGroup

Create a value of DocumentGroup 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:detectedSignatures:DocumentGroup', documentGroup_detectedSignatures - A list of the detected signatures found in a document group.

$sel:splitDocuments:DocumentGroup', documentGroup_splitDocuments - An array that contains information about the pages of a document, defined by logical boundary.

$sel:type':DocumentGroup', documentGroup_type - The type of document that Amazon Textract has detected. See LINK for a list of all types returned by Textract.

$sel:undetectedSignatures:DocumentGroup', documentGroup_undetectedSignatures - A list of any expected signatures not found in a document group.

documentGroup_detectedSignatures :: Lens' DocumentGroup (Maybe [DetectedSignature])

A list of the detected signatures found in a document group.

documentGroup_splitDocuments :: Lens' DocumentGroup (Maybe [SplitDocument])

An array that contains information about the pages of a document, defined by logical boundary.

documentGroup_type :: Lens' DocumentGroup (Maybe Text)

The type of document that Amazon Textract has detected. See LINK for a list of all types returned by Textract.

documentGroup_undetectedSignatures :: Lens' DocumentGroup (Maybe [UndetectedSignature])

A list of any expected signatures not found in a document group.