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.Types.S3Object

Description

Synopsis

data S3Object = S3Object' {
- bucket :: Maybe Text
- name :: Maybe Text
- version :: Maybe Text
}
newS3Object :: S3Object
s3Object_bucket :: Lens' S3Object (Maybe Text)
s3Object_name :: Lens' S3Object (Maybe Text)
s3Object_version :: Lens' S3Object (Maybe Text)

Documentation

data S3Object Source #

The S3 bucket name and file name that identifies the document.

The AWS Region for the S3 bucket that contains the document must match the Region that you use for Amazon Textract operations.

For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket and file.

See: newS3Object smart constructor.

Constructors

S3Object'

Fields

bucket :: Maybe Text
The name of the S3 bucket. Note that the # character is not valid in the file name.
name :: Maybe Text
The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.
version :: Maybe Text
If the bucket has versioning enabled, you can specify the object version.

Instances

Instances details

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

newS3Object :: S3Object Source #

Create a value of S3Object 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:bucket:S3Object', s3Object_bucket - The name of the S3 bucket. Note that the # character is not valid in the file name.

$sel:name:S3Object', s3Object_name - The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.

$sel:version:S3Object', s3Object_version - If the bucket has versioning enabled, you can specify the object version.

s3Object_bucket :: Lens' S3Object (Maybe Text) Source #

The name of the S3 bucket. Note that the # character is not valid in the file name.

s3Object_name :: Lens' S3Object (Maybe Text) Source #

The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.

s3Object_version :: Lens' S3Object (Maybe Text) Source #

If the bucket has versioning enabled, you can specify the object version.