« blib/lib/Paws/Textract/S3Object.pm
↑ Summary
blib/lib/Paws/Textract/StartDocumentAnalysisResponse.pm »
| 1 | |||
| 2 | package Paws::Textract::StartDocumentAnalysis; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has DocumentLocation => (is => 'ro', isa => 'Paws::Textract::DocumentLocation', required => 1); | ||
| 6 | has FeatureTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 7 | has JobTag => (is => 'ro', isa => 'Str'); | ||
| 8 | has KMSKeyId => (is => 'ro', isa => 'Str'); | ||
| 9 | has NotificationChannel => (is => 'ro', isa => 'Paws::Textract::NotificationChannel'); | ||
| 10 | has OutputConfig => (is => 'ro', isa => 'Paws::Textract::OutputConfig'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartDocumentAnalysis'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Textract::StartDocumentAnalysisResponse'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Textract::StartDocumentAnalysis - Arguments for method StartDocumentAnalysis on L<Paws::Textract> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method StartDocumentAnalysis on the | ||
| 28 | L<Amazon Textract|Paws::Textract> service. Use the attributes of this class | ||
| 29 | as arguments to method StartDocumentAnalysis. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartDocumentAnalysis. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $textract = Paws->service('Textract'); | ||
| 36 | my $StartDocumentAnalysisResponse = $textract->StartDocumentAnalysis( | ||
| 37 | DocumentLocation => { | ||
| 38 | S3Object => { | ||
| 39 | Bucket => 'MyS3Bucket', # min: 3, max: 255; OPTIONAL | ||
| 40 | Name => 'MyS3ObjectName', # min: 1, max: 1024; OPTIONAL | ||
| 41 | Version => 'MyS3ObjectVersion', # min: 1, max: 1024; OPTIONAL | ||
| 42 | }, # OPTIONAL | ||
| 43 | }, | ||
| 44 | FeatureTypes => [ | ||
| 45 | 'TABLES', ... # values: TABLES, FORMS | ||
| 46 | ], | ||
| 47 | ClientRequestToken => 'MyClientRequestToken', # OPTIONAL | ||
| 48 | JobTag => 'MyJobTag', # OPTIONAL | ||
| 49 | KMSKeyId => 'MyKMSKeyId', # OPTIONAL | ||
| 50 | NotificationChannel => { | ||
| 51 | RoleArn => 'MyRoleArn', # min: 20, max: 2048 | ||
| 52 | SNSTopicArn => 'MySNSTopicArn', # min: 20, max: 1024 | ||
| 53 | |||
| 54 | }, # OPTIONAL | ||
| 55 | OutputConfig => { | ||
| 56 | S3Bucket => 'MyS3Bucket', # min: 3, max: 255; OPTIONAL | ||
| 57 | S3Prefix => 'MyS3ObjectName', # min: 1, max: 1024; OPTIONAL | ||
| 58 | }, # OPTIONAL | ||
| 59 | ); | ||
| 60 | |||
| 61 | # Results: | ||
| 62 | my $JobId = $StartDocumentAnalysisResponse->JobId; | ||
| 63 | |||
| 64 | # Returns a L<Paws::Textract::StartDocumentAnalysisResponse> object. | ||
| 65 | |||
| 66 | 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. | ||
| 67 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/textract/StartDocumentAnalysis> | ||
| 68 | |||
| 69 | =head1 ATTRIBUTES | ||
| 70 | |||
| 71 | |||
| 72 | =head2 ClientRequestToken => Str | ||
| 73 | |||
| 74 | The idempotent token that you use to identify the start request. If you | ||
| 75 | use the same token with multiple C<StartDocumentAnalysis> requests, the | ||
| 76 | same C<JobId> is returned. Use C<ClientRequestToken> to prevent the | ||
| 77 | same job from being accidentally started more than once. For more | ||
| 78 | information, see Calling Amazon Textract Asynchronous Operations | ||
| 79 | (https://docs.aws.amazon.com/textract/latest/dg/api-async.html). | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 B<REQUIRED> DocumentLocation => L<Paws::Textract::DocumentLocation> | ||
| 84 | |||
| 85 | The location of the document to be processed. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 B<REQUIRED> FeatureTypes => ArrayRef[Str|Undef] | ||
| 90 | |||
| 91 | A list of the types of analysis to perform. Add TABLES to the list to | ||
| 92 | return information about the tables that are detected in the input | ||
| 93 | document. Add FORMS to return detected form data. To perform both types | ||
| 94 | of analysis, add TABLES and FORMS to C<FeatureTypes>. All lines and | ||
| 95 | words detected in the document are included in the response (including | ||
| 96 | text that isn't related to the value of C<FeatureTypes>). | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 JobTag => Str | ||
| 101 | |||
| 102 | An identifier that you specify that's included in the completion | ||
| 103 | notification published to the Amazon SNS topic. For example, you can | ||
| 104 | use C<JobTag> to identify the type of document that the completion | ||
| 105 | notification corresponds to (such as a tax form or a receipt). | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 KMSKeyId => Str | ||
| 110 | |||
| 111 | The KMS key used to encrypt the inference results. This can be in | ||
| 112 | either Key ID or Key Alias format. When a KMS key is provided, the KMS | ||
| 113 | key will be used for server-side encryption of the objects in the | ||
| 114 | customer bucket. When this parameter is not enabled, the result will be | ||
| 115 | encrypted server side,using SSE-S3. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 NotificationChannel => L<Paws::Textract::NotificationChannel> | ||
| 120 | |||
| 121 | The Amazon SNS topic ARN that you want Amazon Textract to publish the | ||
| 122 | completion status of the operation to. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 OutputConfig => L<Paws::Textract::OutputConfig> | ||
| 127 | |||
| 128 | Sets if the output will go to a customer defined bucket. By default, | ||
| 129 | Amazon Textract will save the results internally to be accessed by the | ||
| 130 | GetDocumentAnalysis operation. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head1 SEE ALSO | ||
| 136 | |||
| 137 | This class forms part of L<Paws>, documenting arguments for method StartDocumentAnalysis in L<Paws::Textract> | ||
| 138 | |||
| 139 | =head1 BUGS and CONTRIBUTIONS | ||
| 140 | |||
| 141 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 142 | |||
| 143 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 144 | |||
| 145 | =cut | ||
| 146 |