« blib/lib/Paws/Rekognition/HumanLoopDataAttributes.pm
↑ Summary
blib/lib/Paws/Rekognition/ImageQuality.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Rekognition::Image; | ||
| 3 | use Moose; | ||
| 4 | has Bytes => (is => 'ro', isa => 'Str'); | ||
| 5 | has S3Object => (is => 'ro', isa => 'Paws::Rekognition::S3Object'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Rekognition::Image | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::Rekognition::Image object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Bytes => $value, ..., S3Object => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::Rekognition::Image object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Bytes | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Provides the input image either as bytes or an S3 object. | ||
| 38 | |||
| 39 | You pass image bytes to an Amazon Rekognition API operation by using | ||
| 40 | the C<Bytes> property. For example, you would use the C<Bytes> property | ||
| 41 | to pass an image loaded from a local file system. Image bytes passed by | ||
| 42 | using the C<Bytes> property must be base64-encoded. Your code may not | ||
| 43 | need to encode image bytes if you are using an AWS SDK to call Amazon | ||
| 44 | Rekognition API operations. | ||
| 45 | |||
| 46 | For more information, see Analyzing an Image Loaded from a Local File | ||
| 47 | System in the Amazon Rekognition Developer Guide. | ||
| 48 | |||
| 49 | You pass images stored in an S3 bucket to an Amazon Rekognition API | ||
| 50 | operation by using the C<S3Object> property. Images stored in an S3 | ||
| 51 | bucket do not need to be base64-encoded. | ||
| 52 | |||
| 53 | The region for the S3 bucket containing the S3 object must match the | ||
| 54 | region you use for Amazon Rekognition operations. | ||
| 55 | |||
| 56 | If you use the AWS CLI to call Amazon Rekognition operations, passing | ||
| 57 | image bytes using the Bytes property is not supported. You must first | ||
| 58 | upload the image to an Amazon S3 bucket and then call the operation | ||
| 59 | using the S3Object property. | ||
| 60 | |||
| 61 | For Amazon Rekognition to process an S3 object, the user must have | ||
| 62 | permission to access the S3 object. For more information, see Resource | ||
| 63 | Based Policies in the Amazon Rekognition Developer Guide. | ||
| 64 | |||
| 65 | =head1 ATTRIBUTES | ||
| 66 | |||
| 67 | |||
| 68 | =head2 Bytes => Str | ||
| 69 | |||
| 70 | Blob of image bytes up to 5 MBs. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 S3Object => L<Paws::Rekognition::S3Object> | ||
| 74 | |||
| 75 | Identifies an S3 object as the image source. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head1 SEE ALSO | ||
| 80 | |||
| 81 | This class forms part of L<Paws>, describing an object used in L<Paws::Rekognition> | ||
| 82 | |||
| 83 | =head1 BUGS and CONTRIBUTIONS | ||
| 84 | |||
| 85 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 86 | |||
| 87 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 88 | |||
| 89 | =cut | ||
| 90 |