Class: Aws::Textract::Types::StartDocumentAnalysisRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Textract::Types::StartDocumentAnalysisRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-textract/types.rb
Overview
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, QUERIES
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",
queries_config: {
queries: [ # required
{
text: "QueryInput", # required
alias: "QueryInput",
pages: ["QueryPage"],
},
],
},
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_request_token ⇒ String
The idempotent token that you use to identify the start request.
-
#document_location ⇒ Types::DocumentLocation
The location of the document to be processed.
-
#feature_types ⇒ Array<String>
A list of the types of analysis to perform.
-
#job_tag ⇒ String
An identifier that you specify that’s included in the completion notification published to the Amazon SNS topic.
-
#kms_key_id ⇒ String
The KMS key used to encrypt the inference results.
-
#notification_channel ⇒ Types::NotificationChannel
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
-
#output_config ⇒ Types::OutputConfig
Sets if the output will go to a customer defined bucket.
- #queries_config ⇒ Types::QueriesConfig
Instance Attribute Details
#client_request_token ⇒ String
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].
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 |
# File 'lib/aws-sdk-textract/types.rb', line 1697 class StartDocumentAnalysisRequest < Struct.new( :document_location, :feature_types, :client_request_token, :job_tag, :notification_channel, :output_config, :kms_key_id, :queries_config) SENSITIVE = [] include Aws::Structure end |
#document_location ⇒ Types::DocumentLocation
The location of the document to be processed.
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 |
# File 'lib/aws-sdk-textract/types.rb', line 1697 class StartDocumentAnalysisRequest < Struct.new( :document_location, :feature_types, :client_request_token, :job_tag, :notification_channel, :output_config, :kms_key_id, :queries_config) SENSITIVE = [] include Aws::Structure end |
#feature_types ⇒ Array<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`).
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 |
# File 'lib/aws-sdk-textract/types.rb', line 1697 class StartDocumentAnalysisRequest < Struct.new( :document_location, :feature_types, :client_request_token, :job_tag, :notification_channel, :output_config, :kms_key_id, :queries_config) SENSITIVE = [] include Aws::Structure end |
#job_tag ⇒ String
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).
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 |
# File 'lib/aws-sdk-textract/types.rb', line 1697 class StartDocumentAnalysisRequest < Struct.new( :document_location, :feature_types, :client_request_token, :job_tag, :notification_channel, :output_config, :kms_key_id, :queries_config) SENSITIVE = [] include Aws::Structure end |
#kms_key_id ⇒ String
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.
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 |
# File 'lib/aws-sdk-textract/types.rb', line 1697 class StartDocumentAnalysisRequest < Struct.new( :document_location, :feature_types, :client_request_token, :job_tag, :notification_channel, :output_config, :kms_key_id, :queries_config) SENSITIVE = [] include Aws::Structure end |
#notification_channel ⇒ Types::NotificationChannel
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 |
# File 'lib/aws-sdk-textract/types.rb', line 1697 class StartDocumentAnalysisRequest < Struct.new( :document_location, :feature_types, :client_request_token, :job_tag, :notification_channel, :output_config, :kms_key_id, :queries_config) SENSITIVE = [] include Aws::Structure end |
#output_config ⇒ Types::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.
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 |
# File 'lib/aws-sdk-textract/types.rb', line 1697 class StartDocumentAnalysisRequest < Struct.new( :document_location, :feature_types, :client_request_token, :job_tag, :notification_channel, :output_config, :kms_key_id, :queries_config) SENSITIVE = [] include Aws::Structure end |
#queries_config ⇒ Types::QueriesConfig
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 |
# File 'lib/aws-sdk-textract/types.rb', line 1697 class StartDocumentAnalysisRequest < Struct.new( :document_location, :feature_types, :client_request_token, :job_tag, :notification_channel, :output_config, :kms_key_id, :queries_config) SENSITIVE = [] include Aws::Structure end |