Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Textract.Types.DocumentLocation

Description

Synopsis

data DocumentLocation = DocumentLocation' {
- s3Object :: Maybe S3Object
}
newDocumentLocation :: DocumentLocation
documentLocation_s3Object :: Lens' DocumentLocation (Maybe S3Object)

Documentation

data DocumentLocation Source #

The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations such as StartDocumentTextDetection.

The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format.

See: newDocumentLocation smart constructor.

Constructors

DocumentLocation'
Fields s3Object :: Maybe S3Object The Amazon S3 bucket that contains the input document.

Instances

Instances details

Eq DocumentLocation Source #
Instance details Defined in Amazonka.Textract.Types.DocumentLocation Methods (==) :: DocumentLocation -> DocumentLocation -> Bool # (/=) :: DocumentLocation -> DocumentLocation -> Bool #
Read DocumentLocation Source #
Instance details Defined in Amazonka.Textract.Types.DocumentLocation Methods readsPrec :: Int -> ReadS DocumentLocation # readList :: ReadS [DocumentLocation] # readPrec :: ReadPrec DocumentLocation # readListPrec :: ReadPrec [DocumentLocation] #
Show DocumentLocation Source #
Instance details Defined in Amazonka.Textract.Types.DocumentLocation Methods showsPrec :: Int -> DocumentLocation -> ShowS # show :: DocumentLocation -> String # showList :: [DocumentLocation] -> ShowS #
Generic DocumentLocation Source #
Instance details Defined in Amazonka.Textract.Types.DocumentLocation Associated Types type Rep DocumentLocation :: Type -> Type # Methods from :: DocumentLocation -> Rep DocumentLocation x # to :: Rep DocumentLocation x -> DocumentLocation #
NFData DocumentLocation Source #
Instance details Defined in Amazonka.Textract.Types.DocumentLocation Methods rnf :: DocumentLocation -> () #
Hashable DocumentLocation Source #
Instance details Defined in Amazonka.Textract.Types.DocumentLocation Methods hashWithSalt :: Int -> DocumentLocation -> Int # hash :: DocumentLocation -> Int #
ToJSON DocumentLocation Source #
Instance details Defined in Amazonka.Textract.Types.DocumentLocation Methods toJSON :: DocumentLocation -> Value # toEncoding :: DocumentLocation -> Encoding # toJSONList :: [DocumentLocation] -> Value # toEncodingList :: [DocumentLocation] -> Encoding #
type Rep DocumentLocation Source #
Instance details Defined in Amazonka.Textract.Types.DocumentLocation type Rep DocumentLocation = D1 ('MetaData "DocumentLocation" "Amazonka.Textract.Types.DocumentLocation" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "DocumentLocation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "s3Object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Object))))

newDocumentLocation :: DocumentLocation Source #

Create a value of DocumentLocation 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:s3Object:DocumentLocation', documentLocation_s3Object - The Amazon S3 bucket that contains the input document.

documentLocation_s3Object :: Lens' DocumentLocation (Maybe S3Object) Source #

The Amazon S3 bucket that contains the input document.