« blib/lib/Paws/Rekognition/Smile.pm
↑ Summary
blib/lib/Paws/Rekognition/StartCelebrityRecognitionResponse.pm »
| 1 | |||
| 2 | package Paws::Rekognition::StartCelebrityRecognition; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has JobTag => (is => 'ro', isa => 'Str'); | ||
| 6 | has NotificationChannel => (is => 'ro', isa => 'Paws::Rekognition::NotificationChannel'); | ||
| 7 | has Video => (is => 'ro', isa => 'Paws::Rekognition::Video', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartCelebrityRecognition'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Rekognition::StartCelebrityRecognitionResponse'); | ||
| 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::StartCelebrityRecognition - Arguments for method StartCelebrityRecognition on L<Paws::Rekognition> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method StartCelebrityRecognition on the | ||
| 25 | L<Amazon Rekognition|Paws::Rekognition> service. Use the attributes of this class | ||
| 26 | as arguments to method StartCelebrityRecognition. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartCelebrityRecognition. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $rekognition = Paws->service('Rekognition'); | ||
| 33 | my $StartCelebrityRecognitionResponse = | ||
| 34 | $rekognition->StartCelebrityRecognition( | ||
| 35 | Video => { | ||
| 36 | S3Object => { | ||
| 37 | Bucket => 'MyS3Bucket', # min: 3, max: 255; OPTIONAL | ||
| 38 | Name => 'MyS3ObjectName', # min: 1, max: 1024; OPTIONAL | ||
| 39 | Version => 'MyS3ObjectVersion', # min: 1, max: 1024; OPTIONAL | ||
| 40 | }, # OPTIONAL | ||
| 41 | }, | ||
| 42 | ClientRequestToken => 'MyClientRequestToken', # OPTIONAL | ||
| 43 | JobTag => 'MyJobTag', # OPTIONAL | ||
| 44 | NotificationChannel => { | ||
| 45 | RoleArn => 'MyRoleArn', | ||
| 46 | SNSTopicArn => 'MySNSTopicArn', | ||
| 47 | |||
| 48 | }, # OPTIONAL | ||
| 49 | ); | ||
| 50 | |||
| 51 | # Results: | ||
| 52 | my $JobId = $StartCelebrityRecognitionResponse->JobId; | ||
| 53 | |||
| 54 | # Returns a L<Paws::Rekognition::StartCelebrityRecognitionResponse> object. | ||
| 55 | |||
| 56 | 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. | ||
| 57 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rekognition/StartCelebrityRecognition> | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 ClientRequestToken => Str | ||
| 63 | |||
| 64 | Idempotent token used to identify the start request. If you use the | ||
| 65 | same token with multiple C<StartCelebrityRecognition> requests, the | ||
| 66 | same C<JobId> is returned. Use C<ClientRequestToken> to prevent the | ||
| 67 | same job from being accidently started more than once. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 JobTag => Str | ||
| 72 | |||
| 73 | An identifier you specify that's returned in the completion | ||
| 74 | notification that's published to your Amazon Simple Notification | ||
| 75 | Service topic. For example, you can use C<JobTag> to group related jobs | ||
| 76 | and identify them in the completion notification. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 NotificationChannel => L<Paws::Rekognition::NotificationChannel> | ||
| 81 | |||
| 82 | The Amazon SNS topic ARN that you want Amazon Rekognition Video to | ||
| 83 | publish the completion status of the celebrity recognition analysis to. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> Video => L<Paws::Rekognition::Video> | ||
| 88 | |||
| 89 | The video in which you want to recognize celebrities. The video must be | ||
| 90 | stored in an Amazon S3 bucket. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head1 SEE ALSO | ||
| 96 | |||
| 97 | This class forms part of L<Paws>, documenting arguments for method StartCelebrityRecognition in L<Paws::Rekognition> | ||
| 98 | |||
| 99 | =head1 BUGS and CONTRIBUTIONS | ||
| 100 | |||
| 101 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 102 | |||
| 103 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 104 | |||
| 105 | =cut | ||
| 106 |