Class: Aws::Textract::Types::StartDocumentTextDetectionRequest

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

#client_request_token ⇒ String

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

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

Returns:

  • (String) 


2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
 
# File 'lib/aws-sdk-textract/types.rb', line 2858

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

#document_location ⇒ Types::DocumentLocation

The location of the document to be processed.

Returns:



2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
 
# File 'lib/aws-sdk-textract/types.rb', line 2858

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


2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
 
# File 'lib/aws-sdk-textract/types.rb', line 2858

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


2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
 
# File 'lib/aws-sdk-textract/types.rb', line 2858

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



2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
 
# File 'lib/aws-sdk-textract/types.rb', line 2858

class StartDocumentTextDetectionRequest < Struct.new(
  :document_location,
  :client_request_token,
  :job_tag,
  :notification_channel,
  :output_config,
  :kms_key_id)
  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 with the GetDocumentTextDetection operation.

Returns:



2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
 
# File 'lib/aws-sdk-textract/types.rb', line 2858

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