NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $textract = Paws->service('Textract');
my $StartDocumentAnalysisResponse = $textract->StartDocumentAnalysis(
  DocumentLocation => {
    S3Object => {
      Bucket  => 'MyS3Bucket',           # min: 3, max: 255; OPTIONAL
      Name    => 'MyS3ObjectName',       # min: 1, max: 1024; OPTIONAL
      Version => 'MyS3ObjectVersion',    # min: 1, max: 1024; OPTIONAL
    },    # OPTIONAL
  },
  FeatureTypes => [
    'TABLES', ...    # values: TABLES, FORMS
  ],
  ClientRequestToken  => 'MyClientRequestToken',    # OPTIONAL
  JobTag              => 'MyJobTag',                # OPTIONAL
  KMSKeyId            => 'MyKMSKeyId',              # OPTIONAL
  NotificationChannel => {
    RoleArn     => 'MyRoleArn',                     # min: 20, max: 2048
    SNSTopicArn => 'MySNSTopicArn',                 # min: 20, max: 1024

  },    # OPTIONAL
  OutputConfig => {
    S3Bucket => 'MyS3Bucket',        # min: 3, max: 255; OPTIONAL
    S3Prefix => 'MyS3ObjectName',    # min: 1, max: 1024; OPTIONAL
  },    # OPTIONAL
);

# Results:
my $JobId = $StartDocumentAnalysisResponse->JobId;

# Returns a L<Paws::Textract::StartDocumentAnalysisResponse> 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/StartDocumentAnalysis

ATTRIBUTES

ClientRequestToken => Str

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations (https://docs.aws.amazon.com/textract/latest/dg/api-async.html).

REQUIRED DocumentLocation => Paws::Textract::DocumentLocation

The location of the document to be processed.

REQUIRED FeatureTypes => ArrayRef[Str|Undef]

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

JobTag => Str

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

KMSKeyId => Str

The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

NotificationChannel => Paws::Textract::NotificationChannel

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

OutputConfig => Paws::Textract::OutputConfig

Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.

SEE ALSO

This class forms part of Paws, documenting arguments for method StartDocumentAnalysis 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