Class: Aws::Textract::Types::CreateAdapterVersionRequest

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

#adapter_id ⇒ String

A string containing a unique ID for the adapter that will receive a new version.

Returns:

  • (String) 


815
816
817
818
819
820
821
822
823
824
 
# File 'lib/aws-sdk-textract/types.rb', line 815

class CreateAdapterVersionRequest < Struct.new(
  :adapter_id,
  :client_request_token,
  :dataset_config,
  :kms_key_id,
  :output_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_token ⇒ String

Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapterVersion requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


815
816
817
818
819
820
821
822
823
824
 
# File 'lib/aws-sdk-textract/types.rb', line 815

class CreateAdapterVersionRequest < Struct.new(
  :adapter_id,
  :client_request_token,
  :dataset_config,
  :kms_key_id,
  :output_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_config ⇒ Types::AdapterVersionDatasetConfig

Specifies a dataset used to train a new adapter version. Takes a ManifestS3Object as the value.

Returns:



815
816
817
818
819
820
821
822
823
824
 
# File 'lib/aws-sdk-textract/types.rb', line 815

class CreateAdapterVersionRequest < Struct.new(
  :adapter_id,
  :client_request_token,
  :dataset_config,
  :kms_key_id,
  :output_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.

Returns:

  • (String) 


815
816
817
818
819
820
821
822
823
824
 
# File 'lib/aws-sdk-textract/types.rb', line 815

class CreateAdapterVersionRequest < Struct.new(
  :adapter_id,
  :client_request_token,
  :dataset_config,
  :kms_key_id,
  :output_config,
  :tags)
  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:



815
816
817
818
819
820
821
822
823
824
 
# File 'lib/aws-sdk-textract/types.rb', line 815

class CreateAdapterVersionRequest < Struct.new(
  :adapter_id,
  :client_request_token,
  :dataset_config,
  :kms_key_id,
  :output_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A set of tags (key-value pairs) that you want to attach to the adapter version.

Returns:

  • (Hash<String,String>) 


815
816
817
818
819
820
821
822
823
824
 
# File 'lib/aws-sdk-textract/types.rb', line 815

class CreateAdapterVersionRequest < Struct.new(
  :adapter_id,
  :client_request_token,
  :dataset_config,
  :kms_key_id,
  :output_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end