AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::Textract::Types::StartDocumentAnalysisRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb

Overview

Note:

When making an API call, you may pass StartDocumentAnalysisRequest data as a hash:

{
  document_location: { # required
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
  feature_types: ["TABLES"], # required, accepts TABLES, FORMS
  client_request_token: "ClientRequestToken",
  job_tag: "JobTag",
  notification_channel: {
    sns_topic_arn: "SNSTopicArn", # required
    role_arn: "RoleArn", # required
  },
  output_config: {
    s3_bucket: "S3Bucket", # required
    s3_prefix: "S3ObjectName",
  },
  kms_key_id: "KMSKeyId",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

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.

Returns:

  • (String)


1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1584

class StartDocumentAnalysisRequest < Struct.new(
  :document_location,
  :feature_types,
  :client_request_token,
  :job_tag,
  :notification_channel,
  :output_config,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#document_locationTypes::DocumentLocation

The location of the document to be processed.



1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1584

class StartDocumentAnalysisRequest < Struct.new(
  :document_location,
  :feature_types,
  :client_request_token,
  :job_tag,
  :notification_channel,
  :output_config,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#feature_typesArray<String>

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).

Returns:

  • (Array<String>)


1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1584

class StartDocumentAnalysisRequest < Struct.new(
  :document_location,
  :feature_types,
  :client_request_token,
  :job_tag,
  :notification_channel,
  :output_config,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#job_tagString

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).

Returns:

  • (String)


1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1584

class StartDocumentAnalysisRequest < Struct.new(
  :document_location,
  :feature_types,
  :client_request_token,
  :job_tag,
  :notification_channel,
  :output_config,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

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.

Returns:

  • (String)


1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1584

class StartDocumentAnalysisRequest < Struct.new(
  :document_location,
  :feature_types,
  :client_request_token,
  :job_tag,
  :notification_channel,
  :output_config,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#notification_channelTypes::NotificationChannel

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



1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1584

class StartDocumentAnalysisRequest < Struct.new(
  :document_location,
  :feature_types,
  :client_request_token,
  :job_tag,
  :notification_channel,
  :output_config,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#output_configTypes::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.

Returns:



1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1584

class StartDocumentAnalysisRequest < Struct.new(
  :document_location,
  :feature_types,
  :client_request_token,
  :job_tag,
  :notification_channel,
  :output_config,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end