Class: Aws::Textract::Types::StartExpenseAnalysisRequest

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 StartExpenseAnalysisRequest data as a hash:

{
  document_location: { # required
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
  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'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

Returns:

  • (String)


1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1774

class StartExpenseAnalysisRequest < Struct.new(
  :document_location,
  :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.



1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1774

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

#job_tagString

An identifier 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)


1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1774

class StartExpenseAnalysisRequest < Struct.new(
  :document_location,
  :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)


1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1774

class StartExpenseAnalysisRequest < Struct.new(
  :document_location,
  :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.



1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1774

class StartExpenseAnalysisRequest < Struct.new(
  :document_location,
  :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 GetExpenseAnalysis operation.

Returns:



1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1774

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