Amazonka.Textract.Types.SplitDocument

Documentation

data SplitDocument

Contains information about the pages of a document, defined by logical boundary.

See: newSplitDocument smart constructor.

Constructors

SplitDocument'

Fields

• index :: Maybe Natural

  The index for a given document in a DocumentGroup of a specific Type.

• pages :: Maybe [Natural]

  An array of page numbers for a for a given document, ordered by logical boundary.

Instances

FromJSON SplitDocument

Defined in Amazonka.Textract.Types.SplitDocument

Methods

parseJSON :: Value -> Parser SplitDocument

parseJSONList :: Value -> Parser [SplitDocument]

Generic SplitDocument

Defined in Amazonka.Textract.Types.SplitDocument

Associated Types

type Rep SplitDocument :: Type -> Type

Methods

from :: SplitDocument -> Rep SplitDocument x

to :: Rep SplitDocument x -> SplitDocument

Read SplitDocument

Defined in Amazonka.Textract.Types.SplitDocument

Methods

readsPrec :: Int -> ReadS SplitDocument

readList :: ReadS [SplitDocument]

readPrec :: ReadPrec SplitDocument

readListPrec :: ReadPrec [SplitDocument]

Show SplitDocument

Defined in Amazonka.Textract.Types.SplitDocument

Methods

showsPrec :: Int -> SplitDocument -> ShowS

show :: SplitDocument -> String

showList :: [SplitDocument] -> ShowS

NFData SplitDocument

Defined in Amazonka.Textract.Types.SplitDocument

Methods

rnf :: SplitDocument -> ()

Eq SplitDocument

Defined in Amazonka.Textract.Types.SplitDocument

Methods

(==) :: SplitDocument -> SplitDocument -> Bool

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

Hashable SplitDocument

Defined in Amazonka.Textract.Types.SplitDocument

Methods

hashWithSalt :: Int -> SplitDocument -> Int

hash :: SplitDocument -> Int

type Rep SplitDocument

Defined in Amazonka.Textract.Types.SplitDocument

type Rep SplitDocument = D1 ('MetaData "SplitDocument" "Amazonka.Textract.Types.SplitDocument" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "SplitDocument'" 'PrefixI 'True) (S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "pages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Natural]))))

newSplitDocument :: SplitDocument

Create a value of SplitDocument 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:index:SplitDocument', splitDocument_index - The index for a given document in a DocumentGroup of a specific Type.

$sel:pages:SplitDocument', splitDocument_pages - An array of page numbers for a for a given document, ordered by logical boundary.

splitDocument_index :: Lens' SplitDocument (Maybe Natural)

The index for a given document in a DocumentGroup of a specific Type.

splitDocument_pages :: Lens' SplitDocument (Maybe [Natural])

An array of page numbers for a for a given document, ordered by logical boundary.