NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $textract = Paws->service('Textract');
    my $StartDocumentTextDetectionResponse =
      $textract->StartDocumentTextDetection(
      DocumentLocation => {
        S3Object => {
          Bucket  => 'MyS3Bucket',           # min: 3, max: 255; OPTIONAL
          Name    => 'MyS3ObjectName',       # min: 1, max: 1024; OPTIONAL
          Version => 'MyS3ObjectVersion',    # min: 1, max: 1024; OPTIONAL
        },    # OPTIONAL
      },
      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 = $StartDocumentTextDetectionResponse->JobId;
    # Returns a L<Paws::Textract::StartDocumentTextDetectionResponse> 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/StartDocumentTextDetection>

ATTRIBUTES

ClientRequestToken => Str

The idempotent token that's used to identify the start request. If you use the same token with multiple "StartDocumentTextDetection" 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.

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 with the GetDocumentTextDetection operation.

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>