File Coverage

blib/lib/Paws/Rekognition/Image.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


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