Amazonka.Textract.Types.Warning

Documentation

data Warning

A warning about an issue that occurred during asynchronous text analysis (StartDocumentAnalysis) or asynchronous document text detection (StartDocumentTextDetection).

See: newWarning smart constructor.

Constructors

Warning'

Fields

• errorCode :: Maybe Text

  The error code for the warning.

• pages :: Maybe [Natural]

  A list of the pages that the warning applies to.

Instances

FromJSON Warning

Defined in Amazonka.Textract.Types.Warning

Methods

parseJSON :: Value -> Parser Warning

parseJSONList :: Value -> Parser [Warning]

Generic Warning

Defined in Amazonka.Textract.Types.Warning

Associated Types

type Rep Warning :: Type -> Type

Methods

from :: Warning -> Rep Warning x

to :: Rep Warning x -> Warning

Read Warning

Defined in Amazonka.Textract.Types.Warning

Methods

readsPrec :: Int -> ReadS Warning

readList :: ReadS [Warning]

readPrec :: ReadPrec Warning

readListPrec :: ReadPrec [Warning]

Show Warning

Defined in Amazonka.Textract.Types.Warning

Methods

showsPrec :: Int -> Warning -> ShowS

show :: Warning -> String

showList :: [Warning] -> ShowS

NFData Warning

Defined in Amazonka.Textract.Types.Warning

Methods

rnf :: Warning -> ()

Eq Warning

Defined in Amazonka.Textract.Types.Warning

Methods

(==) :: Warning -> Warning -> Bool

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

Hashable Warning

Defined in Amazonka.Textract.Types.Warning

Methods

hashWithSalt :: Int -> Warning -> Int

hash :: Warning -> Int

type Rep Warning

Defined in Amazonka.Textract.Types.Warning

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

newWarning :: Warning

Create a value of Warning 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:errorCode:Warning', warning_errorCode - The error code for the warning.

$sel:pages:Warning', warning_pages - A list of the pages that the warning applies to.

warning_errorCode :: Lens' Warning (Maybe Text)

The error code for the warning.

warning_pages :: Lens' Warning (Maybe [Natural])

A list of the pages that the warning applies to.