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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#adapters_config ⇒ Types::AdaptersConfig

Specifies the adapter to be used when analyzing a document.

Returns:



2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
 
# File 'lib/aws-sdk-textract/types.rb', line 2785

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

#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].

[1]: docs.aws.amazon.com/textract/latest/dg/api-async.html

Returns:

  • (String) 


2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
 
# File 'lib/aws-sdk-textract/types.rb', line 2785

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

#document_location ⇒ Types::DocumentLocation

The location of the document to be processed.

Returns:



2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
 
# File 'lib/aws-sdk-textract/types.rb', line 2785

class StartDocumentAnalysisRequest < Struct.new(
  :document_location,
  :feature_types,
  :client_request_token,
  :job_tag,
  :notification_channel,
  :output_config,
  :kms_key_id,
  :queries_config,
  :adapters_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`).

Returns:

  • (Array<String>) 


2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
 
# File 'lib/aws-sdk-textract/types.rb', line 2785

class StartDocumentAnalysisRequest < Struct.new(
  :document_location,
  :feature_types,
  :client_request_token,
  :job_tag,
  :notification_channel,
  :output_config,
  :kms_key_id,
  :queries_config,
  :adapters_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).

Returns:

  • (String) 


2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
 
# File 'lib/aws-sdk-textract/types.rb', line 2785

class StartDocumentAnalysisRequest < Struct.new(
  :document_location,
  :feature_types,
  :client_request_token,
  :job_tag,
  :notification_channel,
  :output_config,
  :kms_key_id,
  :queries_config,
  :adapters_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.

Returns:

  • (String) 


2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
 
# File 'lib/aws-sdk-textract/types.rb', line 2785

class StartDocumentAnalysisRequest < Struct.new(
  :document_location,
  :feature_types,
  :client_request_token,
  :job_tag,
  :notification_channel,
  :output_config,
  :kms_key_id,
  :queries_config,
  :adapters_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.

Returns:



2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
 
# File 'lib/aws-sdk-textract/types.rb', line 2785

class StartDocumentAnalysisRequest < Struct.new(
  :document_location,
  :feature_types,
  :client_request_token,
  :job_tag,
  :notification_channel,
  :output_config,
  :kms_key_id,
  :queries_config,
  :adapters_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.

Returns:



2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
 
# File 'lib/aws-sdk-textract/types.rb', line 2785

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

#queries_config ⇒ Types::QueriesConfig

Returns:



2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
 
# File 'lib/aws-sdk-textract/types.rb', line 2785

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