NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $rekognition = Paws->service('Rekognition');
    my $GetLabelDetectionResponse = $rekognition->GetLabelDetection(
      JobId      => 'MyJobId',
      MaxResults => 1,                      # OPTIONAL
      NextToken  => 'MyPaginationToken',    # OPTIONAL
      SortBy     => 'NAME',                 # OPTIONAL
    );

    # Results:
    my $JobStatus         = $GetLabelDetectionResponse->JobStatus;
    my $LabelModelVersion = $GetLabelDetectionResponse->LabelModelVersion;
    my $Labels            = $GetLabelDetectionResponse->Labels;
    my $NextToken         = $GetLabelDetectionResponse->NextToken;
    my $StatusMessage     = $GetLabelDetectionResponse->StatusMessage;
    my $VideoMetadata     = $GetLabelDetectionResponse->VideoMetadata;

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

ATTRIBUTES

REQUIRED JobId => Str

Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.

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 are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of labels.

SortBy => Str

Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.

Valid values are: "NAME", "TIMESTAMP"

SEE ALSO

This class forms part of Paws, documenting arguments for method GetLabelDetection 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