Class: Aws::Textract::Types::StartLendingAnalysisRequest

Inherits:

Struct

• Object
• Struct
• Aws::Textract::Types::StartLendingAnalysisRequest

Includes:

Structure

Defined in:

lib/aws-sdk-textract/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  The idempotent token that you use to identify the start request.

• #document_location ⇒ Types::DocumentLocation

  The Amazon S3 bucket that contains the document to be processed.

• #job_tag ⇒ String

  An identifier that you specify to be 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 Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation.

• #output_config ⇒ Types::OutputConfig

  Sets whether or not your output will go to a user created bucket.

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 ‘StartLendingAnalysis` 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-sync.html

Returns:

• (String)

# File 'lib/aws-sdk-textract/types.rb', line 3029

class StartLendingAnalysisRequest < 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 Amazon S3 bucket that contains the document to be processed. It’s used by asynchronous operations.

The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format.

Returns:

• (Types::DocumentLocation)

# File 'lib/aws-sdk-textract/types.rb', line 3029

class StartLendingAnalysisRequest < 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 to be 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)

# File 'lib/aws-sdk-textract/types.rb', line 3029

class StartLendingAnalysisRequest < 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)

# File 'lib/aws-sdk-textract/types.rb', line 3029

class StartLendingAnalysisRequest < 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 Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation.

Returns:

• (Types::NotificationChannel)

# File 'lib/aws-sdk-textract/types.rb', line 3029

class StartLendingAnalysisRequest < 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 whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.

‘OutputConfig` is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With `OutputConfig` enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the `KMSKeyID` parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.

Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see [ Managing AI services opt-out policy. ][1]

For more information on data privacy, see the [Data Privacy FAQ].

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html [2]: aws.amazon.com/compliance/data-privacy-faq/

Returns:

• (Types::OutputConfig)

# File 'lib/aws-sdk-textract/types.rb', line 3029

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