« blib/lib/Paws/Rekognition/StartTechnicalCueDetectionFilter.pm
↑ Summary
blib/lib/Paws/Rekognition/StartTextDetectionFilters.pm »
| 1 | |||
| 2 | package Paws::Rekognition::StartTextDetection; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has Filters => (is => 'ro', isa => 'Paws::Rekognition::StartTextDetectionFilters'); | ||
| 6 | has JobTag => (is => 'ro', isa => 'Str'); | ||
| 7 | has NotificationChannel => (is => 'ro', isa => 'Paws::Rekognition::NotificationChannel'); | ||
| 8 | has Video => (is => 'ro', isa => 'Paws::Rekognition::Video', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartTextDetection'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Rekognition::StartTextDetectionResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Rekognition::StartTextDetection - Arguments for method StartTextDetection on L<Paws::Rekognition> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method StartTextDetection on the | ||
| 26 | L<Amazon Rekognition|Paws::Rekognition> service. Use the attributes of this class | ||
| 27 | as arguments to method StartTextDetection. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartTextDetection. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $rekognition = Paws->service('Rekognition'); | ||
| 34 | my $StartTextDetectionResponse = $rekognition->StartTextDetection( | ||
| 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 | Filters => { | ||
| 44 | RegionsOfInterest => [ | ||
| 45 | { | ||
| 46 | BoundingBox => { | ||
| 47 | Height => 1.0, # OPTIONAL | ||
| 48 | Left => 1.0, # OPTIONAL | ||
| 49 | Top => 1.0, # OPTIONAL | ||
| 50 | Width => 1.0, # OPTIONAL | ||
| 51 | }, # OPTIONAL | ||
| 52 | }, | ||
| 53 | ... | ||
| 54 | ], # max: 10; OPTIONAL | ||
| 55 | WordFilter => { | ||
| 56 | MinBoundingBoxHeight => 1.0, # max: 1; OPTIONAL | ||
| 57 | MinBoundingBoxWidth => 1.0, # max: 1; OPTIONAL | ||
| 58 | MinConfidence => 1.0, # max: 100; OPTIONAL | ||
| 59 | }, # OPTIONAL | ||
| 60 | }, # OPTIONAL | ||
| 61 | JobTag => 'MyJobTag', # OPTIONAL | ||
| 62 | NotificationChannel => { | ||
| 63 | RoleArn => 'MyRoleArn', | ||
| 64 | SNSTopicArn => 'MySNSTopicArn', | ||
| 65 | |||
| 66 | }, # OPTIONAL | ||
| 67 | ); | ||
| 68 | |||
| 69 | # Results: | ||
| 70 | my $JobId = $StartTextDetectionResponse->JobId; | ||
| 71 | |||
| 72 | # Returns a L<Paws::Rekognition::StartTextDetectionResponse> object. | ||
| 73 | |||
| 74 | 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. | ||
| 75 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rekognition/StartTextDetection> | ||
| 76 | |||
| 77 | =head1 ATTRIBUTES | ||
| 78 | |||
| 79 | |||
| 80 | =head2 ClientRequestToken => Str | ||
| 81 | |||
| 82 | Idempotent token used to identify the start request. If you use the | ||
| 83 | same token with multiple C<StartTextDetection> requests, the same | ||
| 84 | C<JobId> is returned. Use C<ClientRequestToken> to prevent the same job | ||
| 85 | from being accidentaly started more than once. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 Filters => L<Paws::Rekognition::StartTextDetectionFilters> | ||
| 90 | |||
| 91 | Optional parameters that let you set criteria the text must meet to be | ||
| 92 | included in your response. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 JobTag => Str | ||
| 97 | |||
| 98 | An identifier returned in the completion status published by your | ||
| 99 | Amazon Simple Notification Service topic. For example, you can use | ||
| 100 | C<JobTag> to group related jobs and identify them in the completion | ||
| 101 | notification. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 NotificationChannel => L<Paws::Rekognition::NotificationChannel> | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 B<REQUIRED> Video => L<Paws::Rekognition::Video> | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, documenting arguments for method StartTextDetection in L<Paws::Rekognition> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |