GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::Rekognition::GetFaceSearch(3) User Contributed Perl Documentation Paws::Rekognition::GetFaceSearch(3)

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

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

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

    my $rekognition = Paws->service('Rekognition');
    my $GetFaceSearchResponse = $rekognition->GetFaceSearch(
      JobId      => 'MyJobId',
      MaxResults => 1,                      # OPTIONAL
      NextToken  => 'MyPaginationToken',    # OPTIONAL
      SortBy     => 'INDEX',                # OPTIONAL
    );
    # Results:
    my $JobStatus     = $GetFaceSearchResponse->JobStatus;
    my $NextToken     = $GetFaceSearchResponse->NextToken;
    my $Persons       = $GetFaceSearchResponse->Persons;
    my $StatusMessage = $GetFaceSearchResponse->StatusMessage;
    my $VideoMetadata = $GetFaceSearchResponse->VideoMetadata;
    # Returns a L<Paws::Rekognition::GetFaceSearchResponse> object.

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. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/rekognition/GetFaceSearch>

REQUIRED JobId => Str

The job identifer for the search request. You get the job identifier from an initial call to "StartFaceSearch".

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

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

Sort to use for grouping faces in the response. Use "TIMESTAMP" to group faces by the time that they are recognized. Use "INDEX" to sort by recognized faces.

Valid values are: "INDEX", "TIMESTAMP"

This class forms part of Paws, documenting arguments for method GetFaceSearch in Paws::Rekognition

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>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.