NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $rekognition = Paws->service('Rekognition');
    my $GetCelebrityRecognitionResponse = $rekognition->GetCelebrityRecognition(
      JobId      => 'MyJobId',
      MaxResults => 1,                      # OPTIONAL
      NextToken  => 'MyPaginationToken',    # OPTIONAL
      SortBy     => 'ID',                   # OPTIONAL
    );

    # Results:
    my $Celebrities   = $GetCelebrityRecognitionResponse->Celebrities;
    my $JobStatus     = $GetCelebrityRecognitionResponse->JobStatus;
    my $NextToken     = $GetCelebrityRecognitionResponse->NextToken;
    my $StatusMessage = $GetCelebrityRecognitionResponse->StatusMessage;
    my $VideoMetadata = $GetCelebrityRecognitionResponse->VideoMetadata;

    # Returns a L<Paws::Rekognition::GetCelebrityRecognitionResponse> 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/GetCelebrityRecognition

ATTRIBUTES

REQUIRED JobId => Str

Job identifier for the required celebrity recognition analysis. You can get the job identifer from a call to StartCelebrityRecognition.

MaxResults => Int

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.

NextToken => Str

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

SortBy => Str

Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity was recognized.

Valid values are: "ID", "TIMESTAMP"

SEE ALSO

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

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