/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Textract::GetDocumentAnalysis

NAME

Paws::Textract::GetDocumentAnalysis - Arguments for method GetDocumentAnalysis on Paws::Textract

DESCRIPTION

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

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

SYNOPSIS

my $textract = Paws->service('Textract');
my $GetDocumentAnalysisResponse = $textract->GetDocumentAnalysis(
  JobId      => 'MyJobId',
  MaxResults => 1,                      # OPTIONAL
  NextToken  => 'MyPaginationToken',    # OPTIONAL
);

# Results:
my $AnalyzeDocumentModelVersion =
  $GetDocumentAnalysisResponse->AnalyzeDocumentModelVersion;
my $Blocks           = $GetDocumentAnalysisResponse->Blocks;
my $DocumentMetadata = $GetDocumentAnalysisResponse->DocumentMetadata;
my $JobStatus        = $GetDocumentAnalysisResponse->JobStatus;
my $NextToken        = $GetDocumentAnalysisResponse->NextToken;
my $StatusMessage    = $GetDocumentAnalysisResponse->StatusMessage;
my $Warnings         = $GetDocumentAnalysisResponse->Warnings;

# Returns a L<Paws::Textract::GetDocumentAnalysisResponse> 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/textract/GetDocumentAnalysis

ATTRIBUTES

REQUIRED JobId => Str

A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

MaxResults => Int

The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

NextToken => Str

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetDocumentAnalysis in Paws::Textract

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