« blib/lib/Paws/Textract/Relationship.pm
↑ Summary
blib/lib/Paws/Textract/StartDocumentAnalysis.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Textract::S3Object; | ||
| 3 | use Moose; | ||
| 4 | has Bucket => (is => 'ro', isa => 'Str'); | ||
| 5 | has Name => (is => 'ro', isa => 'Str'); | ||
| 6 | has Version => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::Textract::S3Object | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::Textract::S3Object object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Bucket => $value, ..., Version => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::Textract::S3Object object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Bucket | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | The S3 bucket name and file name that identifies the document. | ||
| 39 | |||
| 40 | The AWS Region for the S3 bucket that contains the document must match | ||
| 41 | the Region that you use for Amazon Textract operations. | ||
| 42 | |||
| 43 | For Amazon Textract to process a file in an S3 bucket, the user must | ||
| 44 | have permission to access the S3 bucket and file. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Bucket => Str | ||
| 50 | |||
| 51 | The name of the S3 bucket. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Name => Str | ||
| 55 | |||
| 56 | The file name of the input document. Synchronous operations can use | ||
| 57 | image files that are in JPEG or PNG format. Asynchronous operations | ||
| 58 | also support PDF format files. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 Version => Str | ||
| 62 | |||
| 63 | If the bucket has versioning enabled, you can specify the object | ||
| 64 | version. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head1 SEE ALSO | ||
| 69 | |||
| 70 | This class forms part of L<Paws>, describing an object used in L<Paws::Textract> | ||
| 71 | |||
| 72 | =head1 BUGS and CONTRIBUTIONS | ||
| 73 | |||
| 74 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 75 | |||
| 76 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 77 | |||
| 78 | =cut | ||
| 79 |