« blib/lib/Paws/Rekognition/GetFaceSearchResponse.pm
↑ Summary
blib/lib/Paws/Rekognition/GetLabelDetectionResponse.pm »
| 1 | |||
| 2 | package Paws::Rekognition::GetLabelDetection; | ||
| 3 | use Moose; | ||
| 4 | has JobId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has SortBy => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetLabelDetection'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Rekognition::GetLabelDetectionResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Rekognition::GetLabelDetection - Arguments for method GetLabelDetection on L<Paws::Rekognition> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method GetLabelDetection on the | ||
| 25 | L<Amazon Rekognition|Paws::Rekognition> service. Use the attributes of this class | ||
| 26 | as arguments to method GetLabelDetection. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetLabelDetection. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $rekognition = Paws->service('Rekognition'); | ||
| 33 | my $GetLabelDetectionResponse = $rekognition->GetLabelDetection( | ||
| 34 | JobId => 'MyJobId', | ||
| 35 | MaxResults => 1, # OPTIONAL | ||
| 36 | NextToken => 'MyPaginationToken', # OPTIONAL | ||
| 37 | SortBy => 'NAME', # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $JobStatus = $GetLabelDetectionResponse->JobStatus; | ||
| 42 | my $LabelModelVersion = $GetLabelDetectionResponse->LabelModelVersion; | ||
| 43 | my $Labels = $GetLabelDetectionResponse->Labels; | ||
| 44 | my $NextToken = $GetLabelDetectionResponse->NextToken; | ||
| 45 | my $StatusMessage = $GetLabelDetectionResponse->StatusMessage; | ||
| 46 | my $VideoMetadata = $GetLabelDetectionResponse->VideoMetadata; | ||
| 47 | |||
| 48 | # Returns a L<Paws::Rekognition::GetLabelDetectionResponse> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rekognition/GetLabelDetection> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> JobId => Str | ||
| 57 | |||
| 58 | Job identifier for the label detection operation for which you want | ||
| 59 | results returned. You get the job identifer from an initial call to | ||
| 60 | C<StartlabelDetection>. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 MaxResults => Int | ||
| 65 | |||
| 66 | Maximum number of results to return per paginated call. The largest | ||
| 67 | value you can specify is 1000. If you specify a value greater than | ||
| 68 | 1000, a maximum of 1000 results is returned. The default value is 1000. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 NextToken => Str | ||
| 73 | |||
| 74 | If the previous response was incomplete (because there are more labels | ||
| 75 | to retrieve), Amazon Rekognition Video returns a pagination token in | ||
| 76 | the response. You can use this pagination token to retrieve the next | ||
| 77 | set of labels. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 SortBy => Str | ||
| 82 | |||
| 83 | Sort to use for elements in the C<Labels> array. Use C<TIMESTAMP> to | ||
| 84 | sort array elements by the time labels are detected. Use C<NAME> to | ||
| 85 | alphabetically group elements for a label together. Within each label | ||
| 86 | group, the array element are sorted by detection confidence. The | ||
| 87 | default sort is by C<TIMESTAMP>. | ||
| 88 | |||
| 89 | Valid values are: C<"NAME">, C<"TIMESTAMP"> | ||
| 90 | |||
| 91 | |||
| 92 | =head1 SEE ALSO | ||
| 93 | |||
| 94 | This class forms part of L<Paws>, documenting arguments for method GetLabelDetection in L<Paws::Rekognition> | ||
| 95 | |||
| 96 | =head1 BUGS and CONTRIBUTIONS | ||
| 97 | |||
| 98 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 99 | |||
| 100 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 101 | |||
| 102 | =cut | ||
| 103 |