« blib/lib/Paws/Textract/Geometry.pm
↑ Summary
blib/lib/Paws/Textract/GetDocumentAnalysisResponse.pm »
| 1 | |||
| 2 | package Paws::Textract::GetDocumentAnalysis; | ||
| 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 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetDocumentAnalysis'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Textract::GetDocumentAnalysisResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Textract::GetDocumentAnalysis - Arguments for method GetDocumentAnalysis on L<Paws::Textract> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method GetDocumentAnalysis on the | ||
| 24 | L<Amazon Textract|Paws::Textract> service. Use the attributes of this class | ||
| 25 | as arguments to method GetDocumentAnalysis. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetDocumentAnalysis. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $textract = Paws->service('Textract'); | ||
| 32 | my $GetDocumentAnalysisResponse = $textract->GetDocumentAnalysis( | ||
| 33 | JobId => 'MyJobId', | ||
| 34 | MaxResults => 1, # OPTIONAL | ||
| 35 | NextToken => 'MyPaginationToken', # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $AnalyzeDocumentModelVersion = | ||
| 40 | $GetDocumentAnalysisResponse->AnalyzeDocumentModelVersion; | ||
| 41 | my $Blocks = $GetDocumentAnalysisResponse->Blocks; | ||
| 42 | my $DocumentMetadata = $GetDocumentAnalysisResponse->DocumentMetadata; | ||
| 43 | my $JobStatus = $GetDocumentAnalysisResponse->JobStatus; | ||
| 44 | my $NextToken = $GetDocumentAnalysisResponse->NextToken; | ||
| 45 | my $StatusMessage = $GetDocumentAnalysisResponse->StatusMessage; | ||
| 46 | my $Warnings = $GetDocumentAnalysisResponse->Warnings; | ||
| 47 | |||
| 48 | # Returns a L<Paws::Textract::GetDocumentAnalysisResponse> 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/textract/GetDocumentAnalysis> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> JobId => Str | ||
| 57 | |||
| 58 | A unique identifier for the text-detection job. The C<JobId> is | ||
| 59 | returned from C<StartDocumentAnalysis>. A C<JobId> value is only valid | ||
| 60 | for 7 days. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 MaxResults => Int | ||
| 65 | |||
| 66 | The maximum number of results to return per paginated call. The largest | ||
| 67 | value that you can specify is 1,000. If you specify a value greater | ||
| 68 | than 1,000, a maximum of 1,000 results is returned. The default value | ||
| 69 | is 1,000. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 NextToken => Str | ||
| 74 | |||
| 75 | If the previous response was incomplete (because there are more blocks | ||
| 76 | to retrieve), Amazon Textract returns a pagination token in the | ||
| 77 | response. You can use this pagination token to retrieve the next set of | ||
| 78 | blocks. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head1 SEE ALSO | ||
| 84 | |||
| 85 | This class forms part of L<Paws>, documenting arguments for method GetDocumentAnalysis in L<Paws::Textract> | ||
| 86 | |||
| 87 | =head1 BUGS and CONTRIBUTIONS | ||
| 88 | |||
| 89 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 90 | |||
| 91 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 92 | |||
| 93 | =cut | ||
| 94 |