File Coverage

blib/lib/Paws/Rekognition/ListFaces.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

package Paws::Rekognition::ListFaces;
  use Moose;
  has CollectionId => (is => 'ro', isa => 'Str', required => 1);
  has MaxResults => (is => 'ro', isa => 'Int');
  has NextToken => (is => 'ro', isa => 'Str');

  use MooseX::ClassAttribute;

  class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListFaces');
  class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Rekognition::ListFacesResponse');
  class_has _result_key => (isa => 'Str', is => 'ro');
1;

### main pod documentation begin ###

=head1 NAME

Paws::Rekognition::ListFaces - Arguments for method ListFaces on Paws::Rekognition

=head1 DESCRIPTION

This class represents the parameters used for calling the method ListFaces on the
Amazon Rekognition service. Use the attributes of this class
as arguments to method ListFaces.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListFaces.

As an example:

  $service_obj->ListFaces(Att1 => $value1, Att2 => $value2, ...);

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.

=head1 ATTRIBUTES


=head2 B<REQUIRED> CollectionId => Str

ID of the collection from which to list the faces.



=head2 MaxResults => Int

Maximum number of faces to return.



=head2 NextToken => Str

If the previous response was incomplete (because there is more data to
retrieve), Amazon Rekognition returns a pagination token in the
response. You can use this pagination token to retrieve the next set of
faces.




=head1 SEE ALSO

This class forms part of L<Paws>, documenting arguments for method ListFaces in L<Paws::Rekognition>

=head1 BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

=cut